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

List parametric list values

Request

Get a list of all parametric list values for a specific parametric attribute

Path
parametricIdinteger(int32)required
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/parametric/{parametricId}/list' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of parametric list values, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the parametric list item. Client-specific.

Example: 20
ParametricIdinteger(int32)

The identifier of the parametric this list item belongs to.

Example: 8
Valuestring or null[ 0 .. 255 ] characters

The display value for the parametric list item in a specific language.

Example: "Anthracite grey/Green"
DefaultValuestring or null[ 0 .. 255 ] characters

The display value for the parametric list item in the default language.

Example: "Anthracite grey/Green"
IsValueInheritedboolean

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

Descriptionstring or null

A longer description for the parametric list item in a specific language. No size limit.

DefaultDescriptionstring or null

A longer description for the parametric list item in the default language. No size limit.

IsDescriptionInheritedboolean

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

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the parametric list item.

Example: "antracitgra-green"
ImageKeystring or null(guid)

Unique blob identifier for an associated image.

ImageUrlstring or null[ 0 .. 255 ] characters

Deprecated, URL path to an associated image for the parametric list item.

IsActiveboolean

False if the parametric list item is soft deleted, removes it from selection lists but easily reactivatable.

Example: true
Changedstring or null

The date and time when the parametric list item was last changed.

Example: "03/05/2024 13:01"
ChangedBystring or null

The name of the user who last changed the parametric list item, null if never changed.

CulturesArray of objects(ParametricListCultureModel)

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

Example: [{"CultureCode":"en-GB","Value":"Anthracite grey/Green","IsValueInherited":false,"Description":"","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"sv-SE","Value":"Antracitgrå/Grön","IsValueInherited":false,"Description":null,"IsDescriptionInherited":true,"IsTranslated":true}]
]
Response
application/json
[ { "Id": 20, "ParametricId": 8, "Value": "Anthracite grey/Green", "DefaultValue": "Anthracite grey/Green", "IsValueInherited": false, "Description": "", "DefaultDescription": "", "IsDescriptionInherited": false, "Code": "antracitgra-green", "ImageKey": null, "ImageUrl": "", "IsActive": true, "Changed": "03/05/2024 13:01", "ChangedBy": null, "Cultures": [] } ]

Add or Update parametric list values

Request

Update the complete list of parametric list values for a specific parametric attribute

Path
parametricIdinteger(int32)required

Parametric attribute id

Query
useSortOrderboolean or null

Optional flag to indicate if the sort order from the provided list should be used

Default false
Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

A complete list of parametric list values to set, existing values will be replaced. New values are allowed.

Array [
Idinteger(int32)

Internal identifier for the parametric list item. Client-specific.

Example: 20
ParametricIdinteger(int32)

The identifier of the parametric this list item belongs to.

Example: 8
Valuestring or null[ 0 .. 255 ] characters

The display value for the parametric list item in a specific language.

Example: "Anthracite grey/Green"
DefaultValuestring or null[ 0 .. 255 ] characters

The display value for the parametric list item in the default language.

Example: "Anthracite grey/Green"
IsValueInheritedboolean

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

Descriptionstring or null

A longer description for the parametric list item in a specific language. No size limit.

DefaultDescriptionstring or null

A longer description for the parametric list item in the default language. No size limit.

IsDescriptionInheritedboolean

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

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the parametric list item.

Example: "antracitgra-green"
ImageKeystring or null(guid)

Unique blob identifier for an associated image.

ImageUrlstring or null[ 0 .. 255 ] characters

Deprecated, URL path to an associated image for the parametric list item.

IsActiveboolean

False if the parametric list item is soft deleted, removes it from selection lists but easily reactivatable.

Example: true
Changedstring or null

The date and time when the parametric list item was last changed.

Example: "03/05/2024 13:01"
ChangedBystring or null

The name of the user who last changed the parametric list item, null if never changed.

CulturesArray of objects(ParametricListCultureModel)

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

Example: [{"CultureCode":"en-GB","Value":"Anthracite grey/Green","IsValueInherited":false,"Description":"","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"sv-SE","Value":"Antracitgrå/Grön","IsValueInherited":false,"Description":null,"IsDescriptionInherited":true,"IsTranslated":true}]
]
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/parametric/{parametricId}/list' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '[
    {
      "Id": 20,
      "ParametricId": 8,
      "Value": "Anthracite grey/Green",
      "DefaultValue": "Anthracite grey/Green",
      "IsValueInherited": false,
      "Description": "",
      "DefaultDescription": "",
      "IsDescriptionInherited": false,
      "Code": "antracitgra-green",
      "ImageKey": null,
      "ImageUrl": "",
      "IsActive": true,
      "Changed": "03/05/2024 13:01",
      "ChangedBy": null,
      "Cultures": [
        {
          "CultureCode": "en-GB",
          "Value": "Anthracite grey/Green",
          "IsValueInherited": false,
          "Description": "",
          "IsDescriptionInherited": false,
          "IsTranslated": true
        },
        {
          "CultureCode": "sv-SE",
          "Value": "Antracitgrå/Grön",
          "IsValueInherited": false,
          "Description": null,
          "IsDescriptionInherited": true,
          "IsTranslated": true
        }
      ]
    }
  ]'

Responses

If the parametric list values were successfully updated

Response
No content

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