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

Get application country

Request

Get a specific country for the application

Path
idinteger(int32)required

The system wide unique internal Norce Id of the country

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

Responses

Bodyapplication/json
Idinteger(int32)required

The system wide unique internal Norce Id of the country

Namestring or null

Country name, cannot be updated, for display purposes only

IsPrimaryboolean

Primary application country. Must be set for only one of the active countries. Can be updated on an existing ApplicationCountry.

IsActiveboolean

If false, the country is soft deleted from the application

Changedstring or null

The date and time the ApplicationCountry was last changed, in the application's timezone format

ChangedBystring or null

Fullname or Systemname of the user who last changed the ApplicationCountry, null if never changed

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

Update application country

Request

Update an existing country in the application

Path
idinteger(int32)required

The system wide unique internal Norce Id of the country

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

ApplicationCountry model, only IsPrimary and IsActive can be changed

Idinteger(int32)required

The system wide unique internal Norce Id of the country

Namestring or null

Country name, cannot be updated, for display purposes only

IsPrimaryboolean

Primary application country. Must be set for only one of the active countries. Can be updated on an existing ApplicationCountry.

IsActiveboolean

If false, the country is soft deleted from the application

Changedstring or null

The date and time the ApplicationCountry was last changed, in the application's timezone format

ChangedBystring or null

Fullname or Systemname of the user who last changed the ApplicationCountry, null if never changed

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

Responses

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

Delete application country

Request

(Soft)Delete a country from the application

Path
idinteger(int32)required

The system wide unique internal Norce Id of the country

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

Responses

Response
No content

List application countries

Request

List all countries 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/country \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of application countries, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)required

The system wide unique internal Norce Id of the country

Namestring or null

Country name, cannot be updated, for display purposes only

IsPrimaryboolean

Primary application country. Must be set for only one of the active countries. Can be updated on an existing ApplicationCountry.

IsActiveboolean

If false, the country is soft deleted from the application

Changedstring or null

The date and time the ApplicationCountry was last changed, in the application's timezone format

ChangedBystring or null

Fullname or Systemname of the user who last changed the ApplicationCountry, null if never changed

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

Insert application country

Request

Add a new country to the application

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

ApplicationCountry model, only Id required, If IsPrimary is set to true the last primary country will be unset

Idinteger(int32)required

The system wide unique internal Norce Id of the country

Namestring or null

Country name, cannot be updated, for display purposes only

IsPrimaryboolean

Primary application country. Must be set for only one of the active countries. Can be updated on an existing ApplicationCountry.

IsActiveboolean

If false, the country is soft deleted from the application

Changedstring or null

The date and time the ApplicationCountry was last changed, in the application's timezone format

ChangedBystring or null

Fullname or Systemname of the user who last changed the ApplicationCountry, null if never changed

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

Responses

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

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

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