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

Get application sales area

Request

Get a specific sales area for the application

Path
idinteger(int32)required

The system wide unique internal Norce Id of the sales area

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

Responses

Bodyapplication/json
Idinteger(int32)

The system wide unique internal Norce Id of the sales area

Codestring or null<= 50 characters

Sales area code - a unique external identifier used by client systems, e.g. "SE", "US", "44", "FI", can be left as null.

Namestring or null<= 50 characters

Sales area name, cannot be updated, for display purposes only

IsPrimaryboolean

Primary application sales area. Must be set for only one of the active sales areas. Can be updated on an existing ApplicationSalesArea.

IsActiveboolean

If false, the sales area is soft deleted from the application

Changedstring or null

The date and time when the ApplicationSalesArea was last changed

ChangedBystring or null

The name of the user who last changed the ApplicationSalesArea, null if never changed

Response
application/json
{ "Id": 0, "Code": "string", "Name": "string", "IsPrimary": true, "IsActive": true, "Changed": "string", "ChangedBy": "string" }

Update application sales area

Request

Update an existing sales area in the application

Path
idinteger(int32)required

The system wide unique internal Norce Id of the sales area

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

UpdateApplicationSalesArea model, only Code, IsPrimary and IsActive can be changed

Idinteger(int32)

The system wide unique internal Norce Id of the sales area

Codestring or null<= 50 characters

Sales area code - a unique external identifier used by client systems, e.g. "SE", "US", "44", "FI", can be left as null.

Namestring or null<= 50 characters

Sales area name, cannot be updated, for display purposes only

IsPrimaryboolean

Primary application sales area. Must be set for only one of the active sales areas. Can be updated on an existing ApplicationSalesArea.

IsActiveboolean

If false, the sales area is soft deleted from the application

Changedstring or null

The date and time when the ApplicationSalesArea was last changed

ChangedBystring or null

The name of the user who last changed the ApplicationSalesArea, null if never changed

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/application/salesarea/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Code": "string",
    "Name": "string",
    "IsPrimary": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

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

Delete application sales area

Request

(Soft)Delete a sales area from the application

Path
idinteger(int32)required

The system wide unique internal Norce Id of the sales area

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

Responses

Response
No content

List application sales areas

Request

List all sales areas added to the application

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/application/salesarea \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of application sales areas, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The system wide unique internal Norce Id of the sales area

Codestring or null<= 50 characters

Sales area code - a unique external identifier used by client systems, e.g. "SE", "US", "44", "FI", can be left as null.

Namestring or null<= 50 characters

Sales area name, cannot be updated, for display purposes only

IsPrimaryboolean

Primary application sales area. Must be set for only one of the active sales areas. Can be updated on an existing ApplicationSalesArea.

IsActiveboolean

If false, the sales area is soft deleted from the application

Changedstring or null

The date and time when the ApplicationSalesArea was last changed

ChangedBystring or null

The name of the user who last changed the ApplicationSalesArea, null if never changed

]
Response
application/json
[ { "Id": 0, "Code": "string", "Name": "string", "IsPrimary": true, "IsActive": true, "Changed": "string", "ChangedBy": "string" } ]

Insert application sales area

Request

Add a new sales area to the application

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

ApplicationSalesArea model, only id and isPrimary required, Code is optional, If IsPrimary is set to true the last primary sales area will be unset

Idinteger(int32)

The system wide unique internal Norce Id of the sales area

Codestring or null<= 50 characters

Sales area code - a unique external identifier used by client systems, e.g. "SE", "US", "44", "FI", can be left as null.

Namestring or null<= 50 characters

Sales area name, cannot be updated, for display purposes only

IsPrimaryboolean

Primary application sales area. Must be set for only one of the active sales areas. Can be updated on an existing ApplicationSalesArea.

IsActiveboolean

If false, the sales area is soft deleted from the application

Changedstring or null

The date and time when the ApplicationSalesArea was last changed

ChangedBystring or null

The name of the user who last changed the ApplicationSalesArea, null if never changed

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/application/salesarea \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Code": "string",
    "Name": "string",
    "IsPrimary": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

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

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

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