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

Product Flag

Operations

Get a product flag

Request

Get a specific product flag by its internal id

Path
idinteger(int32)required

Product flag 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/flag/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the ProductFlag

Bodyapplication/json
Idinteger(int32)

Internal identifier for the product flag. Client-specific.

TypeIdinteger(int32)required

The type identifier for the product flag. Allowed values are: 1= Product flag, 2 = Variant flag

GroupIdinteger(int32)required

The identifier of the group this product flag belongs to.

GroupNamestring or null

The name of the group this product flag belongs to.

Codestring[ 0 .. 50 ] charactersrequired

External reference code for the product flag, used for integration purposes.

Namestring or null[ 0 .. 50 ] characters

The product flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The product flag 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 product flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The product flag description in the default language.

IsDescriptionInheritedboolean

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

IsManuallyEditableboolean

Indicates whether this flag can be manually edited by users in the admin interface.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

IsActiveboolean

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

Changedstring or null(date-time)

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

ChangedBystring or null

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

CulturesArray of objects(ProductFlagCultureModel)

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

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

Update a product flag

Request

Update an existing product flag

Path
idinteger(int32)required

Product flag id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Flag to update

Idinteger(int32)

Internal identifier for the product flag. Client-specific.

TypeIdinteger(int32)required

The type identifier for the product flag. Allowed values are: 1= Product flag, 2 = Variant flag

GroupIdinteger(int32)required

The identifier of the group this product flag belongs to.

GroupNamestring or null

The name of the group this product flag belongs to.

Codestring[ 0 .. 50 ] charactersrequired

External reference code for the product flag, used for integration purposes.

Namestring or null[ 0 .. 50 ] characters

The product flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The product flag 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 product flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The product flag description in the default language.

IsDescriptionInheritedboolean

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

IsManuallyEditableboolean

Indicates whether this flag can be manually edited by users in the admin interface.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

IsActiveboolean

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

Changedstring or null(date-time)

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

ChangedBystring or null

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

CulturesArray of objects(ProductFlagCultureModel)

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

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/flag/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "TypeId": 0,
    "GroupId": 0,
    "GroupName": "string",
    "Code": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "IsManuallyEditable": true,
    "SortOrder": 0,
    "IsActive": 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 was successfully updated

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

List product flags

Request

Get a list of all product flags 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/flag \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of product flags, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the product flag. Client-specific.

TypeIdinteger(int32)required

The type identifier for the product flag. Allowed values are: 1= Product flag, 2 = Variant flag

GroupIdinteger(int32)required

The identifier of the group this product flag belongs to.

GroupNamestring or null

The name of the group this product flag belongs to.

Codestring[ 0 .. 50 ] charactersrequired

External reference code for the product flag, used for integration purposes.

Namestring or null[ 0 .. 50 ] characters

The product flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The product flag 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 product flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The product flag description in the default language.

IsDescriptionInheritedboolean

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

IsManuallyEditableboolean

Indicates whether this flag can be manually edited by users in the admin interface.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

IsActiveboolean

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

Changedstring or null(date-time)

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

ChangedBystring or null

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

CulturesArray of objects(ProductFlagCultureModel)

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

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

Add a product flag

Request

Add a new product flag to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Flag to add

Idinteger(int32)

Internal identifier for the product flag. Client-specific.

TypeIdinteger(int32)required

The type identifier for the product flag. Allowed values are: 1= Product flag, 2 = Variant flag

GroupIdinteger(int32)required

The identifier of the group this product flag belongs to.

GroupNamestring or null

The name of the group this product flag belongs to.

Codestring[ 0 .. 50 ] charactersrequired

External reference code for the product flag, used for integration purposes.

Namestring or null[ 0 .. 50 ] characters

The product flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The product flag 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 product flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The product flag description in the default language.

IsDescriptionInheritedboolean

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

IsManuallyEditableboolean

Indicates whether this flag can be manually edited by users in the admin interface.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

IsActiveboolean

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

Changedstring or null(date-time)

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

ChangedBystring or null

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

CulturesArray of objects(ProductFlagCultureModel)

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

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/flag \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "TypeId": 0,
    "GroupId": 0,
    "GroupName": "string",
    "Code": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "IsManuallyEditable": true,
    "SortOrder": 0,
    "IsActive": 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 was successfully added

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

List deleted product flags

Request

Get a list of all deleted product flags on the client, update a deleted product flag 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/flag/deleted \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of deleted product flags, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the product flag. Client-specific.

TypeIdinteger(int32)required

The type identifier for the product flag. Allowed values are: 1= Product flag, 2 = Variant flag

GroupIdinteger(int32)required

The identifier of the group this product flag belongs to.

GroupNamestring or null

The name of the group this product flag belongs to.

Codestring[ 0 .. 50 ] charactersrequired

External reference code for the product flag, used for integration purposes.

Namestring or null[ 0 .. 50 ] characters

The product flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The product flag 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 product flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The product flag description in the default language.

IsDescriptionInheritedboolean

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

IsManuallyEditableboolean

Indicates whether this flag can be manually edited by users in the admin interface.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

IsActiveboolean

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

Changedstring or null(date-time)

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

ChangedBystring or null

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

CulturesArray of objects(ProductFlagCultureModel)

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

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

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