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

Get a parametric group

Request

Get a specific parametric group by its internal Id

Path
idinteger(int32)required

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

Responses

Returns the Parametric Group

Bodyapplication/json
Idinteger(int32)

Internal identifier for the parametric group. Client-specific.

Example: 5
Namestring or null[ 0 .. 50 ] characters

The parametric group name in a specific language.

Example: "Characteristics"
DefaultNamestring or null[ 0 .. 50 ] characters

The parametric group name for the default language.

Example: "Characteristics"
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 parametric group explaining it in more detail.

Example: "Common characteristics"
DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric group description in the default language.

Example: "Common characteristics"
IsDescriptionInheritedboolean

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

IsActiveboolean

False if the parametric group is soft deleted, making it hidden and non-functional but easily reactivatable.

Example: true
Codestring or null[ 0 .. 50 ] characters

Parametric group code with string length of 50. Important to set and should be unique across all parametric groups.

Example: "pg_characteristics"
Changedstring or null

The date and time when the ParametricGroup entity was last changed.

Example: "06/08/2024 14:40"
ChangedBystring or null

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

Example: "Admin user"
CulturesArray of objects(ParametricGroupCultureModel)

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

Example: [{"CultureCode":"en-GB","Name":"Characteristics","IsNameInherited":false,"Description":"Common characteristics","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"nb-NO","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false},{"CultureCode":"sv-SE","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false}]
Response
application/json
{ "Id": 5, "Name": "Characteristics", "DefaultName": "Characteristics", "IsNameInherited": false, "Description": "Common characteristics", "DefaultDescription": "Common characteristics", "IsDescriptionInherited": false, "IsActive": true, "Code": "pg_characteristics", "Changed": "06/08/2024 14:40", "ChangedBy": "Admin user", "Cultures": [ {}, {}, {} ] }

Update a parametric group

Request

Update an existing parametric group

Path
idinteger(int32)required

Parametric group id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Parametric group to update

Idinteger(int32)

Internal identifier for the parametric group. Client-specific.

Example: 5
Namestring or null[ 0 .. 50 ] characters

The parametric group name in a specific language.

Example: "Characteristics"
DefaultNamestring or null[ 0 .. 50 ] characters

The parametric group name for the default language.

Example: "Characteristics"
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 parametric group explaining it in more detail.

Example: "Common characteristics"
DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric group description in the default language.

Example: "Common characteristics"
IsDescriptionInheritedboolean

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

IsActiveboolean

False if the parametric group is soft deleted, making it hidden and non-functional but easily reactivatable.

Example: true
Codestring or null[ 0 .. 50 ] characters

Parametric group code with string length of 50. Important to set and should be unique across all parametric groups.

Example: "pg_characteristics"
Changedstring or null

The date and time when the ParametricGroup entity was last changed.

Example: "06/08/2024 14:40"
ChangedBystring or null

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

Example: "Admin user"
CulturesArray of objects(ParametricGroupCultureModel)

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

Example: [{"CultureCode":"en-GB","Name":"Characteristics","IsNameInherited":false,"Description":"Common characteristics","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"nb-NO","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false},{"CultureCode":"sv-SE","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false}]
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/parametricgroup/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 5,
    "Name": "Characteristics",
    "DefaultName": "Characteristics",
    "IsNameInherited": false,
    "Description": "Common characteristics",
    "DefaultDescription": "Common characteristics",
    "IsDescriptionInherited": false,
    "IsActive": true,
    "Code": "pg_characteristics",
    "Changed": "06/08/2024 14:40",
    "ChangedBy": "Admin user",
    "Cultures": [
      {
        "CultureCode": "en-GB",
        "Name": "Characteristics",
        "IsNameInherited": false,
        "Description": "Common characteristics",
        "IsDescriptionInherited": false,
        "IsTranslated": true
      },
      {
        "CultureCode": "nb-NO",
        "Name": null,
        "IsNameInherited": true,
        "Description": null,
        "IsDescriptionInherited": true,
        "IsTranslated": false
      },
      {
        "CultureCode": "sv-SE",
        "Name": null,
        "IsNameInherited": true,
        "Description": null,
        "IsDescriptionInherited": true,
        "IsTranslated": false
      }
    ]
  }'

Responses

If the parametric group was successfully updated

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

List active parametric groups

Request

Get a list of all active parametric 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/parametricgroup \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of parametric groups, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the parametric group. Client-specific.

Example: 5
Namestring or null[ 0 .. 50 ] characters

The parametric group name in a specific language.

Example: "Characteristics"
DefaultNamestring or null[ 0 .. 50 ] characters

The parametric group name for the default language.

Example: "Characteristics"
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 parametric group explaining it in more detail.

Example: "Common characteristics"
DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric group description in the default language.

Example: "Common characteristics"
IsDescriptionInheritedboolean

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

IsActiveboolean

False if the parametric group is soft deleted, making it hidden and non-functional but easily reactivatable.

Example: true
Codestring or null[ 0 .. 50 ] characters

Parametric group code with string length of 50. Important to set and should be unique across all parametric groups.

Example: "pg_characteristics"
Changedstring or null

The date and time when the ParametricGroup entity was last changed.

Example: "06/08/2024 14:40"
ChangedBystring or null

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

Example: "Admin user"
CulturesArray of objects(ParametricGroupCultureModel)

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

Example: [{"CultureCode":"en-GB","Name":"Characteristics","IsNameInherited":false,"Description":"Common characteristics","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"nb-NO","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false},{"CultureCode":"sv-SE","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false}]
]
Response
application/json
[ { "Id": 5, "Name": "Characteristics", "DefaultName": "Characteristics", "IsNameInherited": false, "Description": "Common characteristics", "DefaultDescription": "Common characteristics", "IsDescriptionInherited": false, "IsActive": true, "Code": "pg_characteristics", "Changed": "06/08/2024 14:40", "ChangedBy": "Admin user", "Cultures": [] } ]

Add a parametric group

Request

Add a new parametric group to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Parametric group to add

Idinteger(int32)

Internal identifier for the parametric group. Client-specific.

Example: 5
Namestring or null[ 0 .. 50 ] characters

The parametric group name in a specific language.

Example: "Characteristics"
DefaultNamestring or null[ 0 .. 50 ] characters

The parametric group name for the default language.

Example: "Characteristics"
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 parametric group explaining it in more detail.

Example: "Common characteristics"
DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric group description in the default language.

Example: "Common characteristics"
IsDescriptionInheritedboolean

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

IsActiveboolean

False if the parametric group is soft deleted, making it hidden and non-functional but easily reactivatable.

Example: true
Codestring or null[ 0 .. 50 ] characters

Parametric group code with string length of 50. Important to set and should be unique across all parametric groups.

Example: "pg_characteristics"
Changedstring or null

The date and time when the ParametricGroup entity was last changed.

Example: "06/08/2024 14:40"
ChangedBystring or null

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

Example: "Admin user"
CulturesArray of objects(ParametricGroupCultureModel)

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

Example: [{"CultureCode":"en-GB","Name":"Characteristics","IsNameInherited":false,"Description":"Common characteristics","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"nb-NO","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false},{"CultureCode":"sv-SE","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false}]
curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/parametricgroup \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 5,
    "Name": "Characteristics",
    "DefaultName": "Characteristics",
    "IsNameInherited": false,
    "Description": "Common characteristics",
    "DefaultDescription": "Common characteristics",
    "IsDescriptionInherited": false,
    "IsActive": true,
    "Code": "pg_characteristics",
    "Changed": "06/08/2024 14:40",
    "ChangedBy": "Admin user",
    "Cultures": [
      {
        "CultureCode": "en-GB",
        "Name": "Characteristics",
        "IsNameInherited": false,
        "Description": "Common characteristics",
        "IsDescriptionInherited": false,
        "IsTranslated": true
      },
      {
        "CultureCode": "nb-NO",
        "Name": null,
        "IsNameInherited": true,
        "Description": null,
        "IsDescriptionInherited": true,
        "IsTranslated": false
      },
      {
        "CultureCode": "sv-SE",
        "Name": null,
        "IsNameInherited": true,
        "Description": null,
        "IsDescriptionInherited": true,
        "IsTranslated": false
      }
    ]
  }'

Responses

If the parametric group was successfully added

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

List deleted parametric groups

Request

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

Responses

Returns the list of deleted parametric groups, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the parametric group. Client-specific.

Example: 5
Namestring or null[ 0 .. 50 ] characters

The parametric group name in a specific language.

Example: "Characteristics"
DefaultNamestring or null[ 0 .. 50 ] characters

The parametric group name for the default language.

Example: "Characteristics"
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 parametric group explaining it in more detail.

Example: "Common characteristics"
DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric group description in the default language.

Example: "Common characteristics"
IsDescriptionInheritedboolean

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

IsActiveboolean

False if the parametric group is soft deleted, making it hidden and non-functional but easily reactivatable.

Example: true
Codestring or null[ 0 .. 50 ] characters

Parametric group code with string length of 50. Important to set and should be unique across all parametric groups.

Example: "pg_characteristics"
Changedstring or null

The date and time when the ParametricGroup entity was last changed.

Example: "06/08/2024 14:40"
ChangedBystring or null

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

Example: "Admin user"
CulturesArray of objects(ParametricGroupCultureModel)

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

Example: [{"CultureCode":"en-GB","Name":"Characteristics","IsNameInherited":false,"Description":"Common characteristics","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"nb-NO","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false},{"CultureCode":"sv-SE","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false}]
]
Response
application/json
[ { "Id": 5, "Name": "Characteristics", "DefaultName": "Characteristics", "IsNameInherited": false, "Description": "Common characteristics", "DefaultDescription": "Common characteristics", "IsDescriptionInherited": false, "IsActive": true, "Code": "pg_characteristics", "Changed": "06/08/2024 14:40", "ChangedBy": "Admin user", "Cultures": [] } ]

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

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