MANAGEMENT API
/
Settings ClientAssortment

Management API (v1)

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

Download OpenAPI description
openapi.json
openapi.yaml
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

Get assortment

Request

Get a specific client assortment by its unique internal Norce Id

Path
idinteger(int32)required

Assortment 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/client/assortment/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Bodyapplication/json
Idinteger(int32)

The assortment identifier

Namestring or null

The name of the client assortment in the current culture

DefaultNamestring or null

The default name of the client assortment

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null

The description of the client assortment in the current culture

DefaultDescriptionstring or null

The default description of the client assortment

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

Codestring or null

The unique code for the client assortment

Changedstring or null

The date and time when the client assortment was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the client assortment

CulturesArray of objects(ClientAssortmentCultureModel)

The culture-specific information for the client assortment

GetCulturePropertiesArray of strings

Gets the list of properties that have culture-specific values

Response
application/json
{
  "Id": 0,
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "Code": "string",
  "Changed": "string",
  "ChangedBy": "string",
  "Cultures": [
    { … }
  ],
  "GetCultureProperties": [
    "string"
  ]
}

Update assortment

Request

Update an existing client assortment

Path
idinteger(int32)required

Assortment id to update

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Updated assortment data

Idinteger(int32)

The assortment identifier

Namestring or null

The name of the client assortment in the current culture

DefaultNamestring or null

The default name of the client assortment

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null

The description of the client assortment in the current culture

DefaultDescriptionstring or null

The default description of the client assortment

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

Codestring or null

The unique code for the client assortment

Changedstring or null

The date and time when the client assortment was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the client assortment

CulturesArray of objects(ClientAssortmentCultureModel)

The culture-specific information for the client assortment

GetCulturePropertiesArray of strings

Gets the list of properties that have culture-specific values

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/client/assortment/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Code": "string",
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "IsTranslated": true,
        "EntityCultureIdName": "string"
      }
    ],
    "GetCultureProperties": [
      "string"
    ]
  }'

Responses

If the assortment was successfully updated

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

Remove client assortment

Request

Remove a client assortment from the client

Path
idinteger(int32)required

Assortment id to delete

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

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

Responses

If the assortment was successfully removed

Response
No content

List active assortments

Request

Get a list of all active client assortments for 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/client/assortment \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of client assortments, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The assortment identifier

Namestring or null

The name of the client assortment in the current culture

DefaultNamestring or null

The default name of the client assortment

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null

The description of the client assortment in the current culture

DefaultDescriptionstring or null

The default description of the client assortment

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

Codestring or null

The unique code for the client assortment

Changedstring or null

The date and time when the client assortment was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the client assortment

CulturesArray of objects(ClientAssortmentCultureModel)

The culture-specific information for the client assortment

GetCulturePropertiesArray of strings

Gets the list of properties that have culture-specific values

]
Response
application/json
[
  {
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Code": "string",
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [ … ],
    "GetCultureProperties": [ … ]
  }
]

Add new assortment

Request

Add a new assortment to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Assortment to create

Idinteger(int32)

The assortment identifier

Namestring or null

The name of the client assortment in the current culture

DefaultNamestring or null

The default name of the client assortment

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null

The description of the client assortment in the current culture

DefaultDescriptionstring or null

The default description of the client assortment

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

Codestring or null

The unique code for the client assortment

Changedstring or null

The date and time when the client assortment was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the client assortment

CulturesArray of objects(ClientAssortmentCultureModel)

The culture-specific information for the client assortment

GetCulturePropertiesArray of strings

Gets the list of properties that have culture-specific values

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/client/assortment \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Code": "string",
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "IsTranslated": true,
        "EntityCultureIdName": "string"
      }
    ],
    "GetCultureProperties": [
      "string"
    ]
  }'

Responses

If the assortment was successfully created

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

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

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