Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

Download OpenAPI description
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Operations

CategoryParametric

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Get product flag group

Request

Get a specific product flag group by its internal id

Path
idinteger(int32)required

Product flag group id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/flaggroup/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the product flag group if found

Bodyapplication/json
Idinteger(int32)

Internal identifier for the flag group. Client-specific.

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the flag group.

Namestring or null[ 0 .. 50 ] characters

The flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The flag group name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the flag group explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The flag group description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

IsMultipleChoiceboolean

Indicates whether multiple flags can be selected from this group at the same time. If false, selecting a new flag will unset other flags from the group.

IsActiveboolean

False if the flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

IsFavoriteboolean

Indicates whether this flag group is marked as a favorite and displayed prominently on the product page in the admin interface. Used purely for UI purposes.

Changedstring or null(date-time)

The date and time when the flag group entity was last changed.

ChangedBystring or null

The name of the user who last changed the flag group entity, null if never changed.

CulturesArray of objects(FlagGroupCultureModel)

List of all culture-specific text fields for the flag group.

Response
application/json
{ "Id": 0, "Code": "string", "Name": "string", "DefaultName": "string", "IsNameInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "IsMultipleChoice": true, "IsActive": true, "IsFavorite": true, "Changed": "2019-08-24T14:15:22Z", "ChangedBy": "string", "Cultures": [ {} ] }

Update a product flag group

Request

Update a specific product flag group by its internal id

Path
idinteger(int32)required

Product flag group id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Product flag group model

Idinteger(int32)

Internal identifier for the flag group. Client-specific.

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the flag group.

Namestring or null[ 0 .. 50 ] characters

The flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The flag group name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the flag group explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The flag group description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

IsMultipleChoiceboolean

Indicates whether multiple flags can be selected from this group at the same time. If false, selecting a new flag will unset other flags from the group.

IsActiveboolean

False if the flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

IsFavoriteboolean

Indicates whether this flag group is marked as a favorite and displayed prominently on the product page in the admin interface. Used purely for UI purposes.

Changedstring or null(date-time)

The date and time when the flag group entity was last changed.

ChangedBystring or null

The name of the user who last changed the flag group entity, null if never changed.

CulturesArray of objects(FlagGroupCultureModel)

List of all culture-specific text fields for the flag group.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/flaggroup/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Code": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "IsMultipleChoice": true,
    "IsActive": true,
    "IsFavorite": true,
    "Changed": "2019-08-24T14:15:22Z",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the product flag group was successfully updated

Bodyapplication/json
integer(int32)
Response
application/json
0

List product flag groups

Request

Get a list of all product flag groups on the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/flaggroup \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of product flag groups, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the flag group. Client-specific.

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the flag group.

Namestring or null[ 0 .. 50 ] characters

The flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The flag group name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the flag group explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The flag group description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

IsMultipleChoiceboolean

Indicates whether multiple flags can be selected from this group at the same time. If false, selecting a new flag will unset other flags from the group.

IsActiveboolean

False if the flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

IsFavoriteboolean

Indicates whether this flag group is marked as a favorite and displayed prominently on the product page in the admin interface. Used purely for UI purposes.

Changedstring or null(date-time)

The date and time when the flag group entity was last changed.

ChangedBystring or null

The name of the user who last changed the flag group entity, null if never changed.

CulturesArray of objects(FlagGroupCultureModel)

List of all culture-specific text fields for the flag group.

]
Response
application/json
[ { "Id": 0, "Code": "string", "Name": "string", "DefaultName": "string", "IsNameInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "IsMultipleChoice": true, "IsActive": true, "IsFavorite": true, "Changed": "2019-08-24T14:15:22Z", "ChangedBy": "string", "Cultures": [] } ]

Add a product flag group

Request

Add a new product flag group

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Product flag group model

Idinteger(int32)

Internal identifier for the flag group. Client-specific.

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the flag group.

Namestring or null[ 0 .. 50 ] characters

The flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The flag group name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the flag group explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The flag group description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

IsMultipleChoiceboolean

Indicates whether multiple flags can be selected from this group at the same time. If false, selecting a new flag will unset other flags from the group.

IsActiveboolean

False if the flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

IsFavoriteboolean

Indicates whether this flag group is marked as a favorite and displayed prominently on the product page in the admin interface. Used purely for UI purposes.

Changedstring or null(date-time)

The date and time when the flag group entity was last changed.

ChangedBystring or null

The name of the user who last changed the flag group entity, null if never changed.

CulturesArray of objects(FlagGroupCultureModel)

List of all culture-specific text fields for the flag group.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/flaggroup \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Code": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "IsMultipleChoice": true,
    "IsActive": true,
    "IsFavorite": true,
    "Changed": "2019-08-24T14:15:22Z",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the product flag group was successfully added

Bodyapplication/json
integer(int32)
Response
application/json
0

List deleted product flag groups

Request

Get a list of all deleted product flag groups on the client, update a deleted parametric with IsActive = true to activate it again

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/flaggroup/deleted \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of deleted product flag groups, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the flag group. Client-specific.

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the flag group.

Namestring or null[ 0 .. 50 ] characters

The flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The flag group name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the flag group explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The flag group description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

IsMultipleChoiceboolean

Indicates whether multiple flags can be selected from this group at the same time. If false, selecting a new flag will unset other flags from the group.

IsActiveboolean

False if the flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

IsFavoriteboolean

Indicates whether this flag group is marked as a favorite and displayed prominently on the product page in the admin interface. Used purely for UI purposes.

Changedstring or null(date-time)

The date and time when the flag group entity was last changed.

ChangedBystring or null

The name of the user who last changed the flag group entity, null if never changed.

CulturesArray of objects(FlagGroupCultureModel)

List of all culture-specific text fields for the flag group.

]
Response
application/json
[ { "Id": 0, "Code": "string", "Name": "string", "DefaultName": "string", "IsNameInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "IsMultipleChoice": true, "IsActive": true, "IsFavorite": true, "Changed": "2019-08-24T14:15:22Z", "ChangedBy": "string", "Cultures": [] } ]

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Product WarehouseLocation

Operations

Product Warehouse

Operations