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

Get customer flag group

Request

Get a specific customer flag group by its internal id

Path
idinteger(int32)required

Customer 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/customer/group/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Bodyapplication/json
Idinteger(int32)

Internal identifier for the flag group. Client-specific.

ClientIdinteger(int32)

The client identifier this customer flag group belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

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

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer 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 customer flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

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

ChangedBystring or null

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

CulturesArray of objects(CustomerFlagGroupCultureModel)

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

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

Update a customer flag group

Request

Update an existing customer flag group on the client

Path
idinteger(int32)required

Customer flag group id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Customer flag group to update

Idinteger(int32)

Internal identifier for the flag group. Client-specific.

ClientIdinteger(int32)

The client identifier this customer flag group belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

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

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer 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 customer flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

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

ChangedBystring or null

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

CulturesArray of objects(CustomerFlagGroupCultureModel)

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

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

Responses

If the customer flag group was successfully updated

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

List customer flag groups

Request

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

Responses

Returns the list of customer flag groups, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the flag group. Client-specific.

ClientIdinteger(int32)

The client identifier this customer flag group belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

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

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer 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 customer flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

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

ChangedBystring or null

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

CulturesArray of objects(CustomerFlagGroupCultureModel)

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

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

Add a customer flag group

Request

Add a new customer flag group to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Customer flag group to create

Idinteger(int32)

Internal identifier for the flag group. Client-specific.

ClientIdinteger(int32)

The client identifier this customer flag group belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

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

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer 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 customer flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

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

ChangedBystring or null

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

CulturesArray of objects(CustomerFlagGroupCultureModel)

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

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

Responses

If the customer flag group was successfully created

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

List (soft) deleted customer flag groups

Request

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

Responses

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

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the flag group. Client-specific.

ClientIdinteger(int32)

The client identifier this customer flag group belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

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

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer 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 customer flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

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

ChangedBystring or null

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

CulturesArray of objects(CustomerFlagGroupCultureModel)

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

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

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