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

Get application

Request

Get a specific application by its unique internal Norce Id

Path
idinteger(int32)required

The environment wide unique internal Norce Id of 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/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

An Application

Bodyapplication/json
Idinteger(int32)read-only

The environment wide unique internal Norce Id of the application

Keystring(guid)read-only

The unique key of the application

Namestring or null<= 50 characters

The friendly name of the application

Descriptionstring or null<= 500 characters

A longer description of the application

HostClientIdinteger(int32)

The Host Client Id that owns this application

Urlstring or null<= 255 characters

The URL of the application, e.g. "https://demo.shop.com"

ProductUrlstring or null<= 255 characters

The base URL of the product catalog for the application, used together with a product unique identifier to get the product page from the shop. The allowed "wildcards" are {uniqueurl}, {productid} and {partno}, e.g. "https://demo.shop.com/products/{productId}", "https://demo.shop.com/products/{partNo}" or "https://demo.shop.com/products/{uniqueUrl}"

IsActiveboolean

If false, the application is deactivated and cannot be used by customers

Changedstring or null

The date and time when the Application entity was last changed

ChangedBystring or null

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

Response
application/json
{ "Id": 0, "Key": "string", "Name": "string", "Description": "string", "HostClientId": 0, "Url": "string", "ProductUrl": "string", "IsActive": true, "Changed": "string", "ChangedBy": "string" }

Update application

Request

Update an existing application

Path
idinteger(int32)required

The environment wide unique internal Id of the application to update

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Application model, only Name, Description, Url, ProductUrl and IsActive are updateable

Namestring or null<= 50 characters

The friendly name of the application

Descriptionstring or null<= 500 characters

A longer description of the application

HostClientIdinteger(int32)

The Host Client Id that owns this application

Urlstring or null<= 255 characters

The URL of the application, e.g. "https://demo.shop.com"

ProductUrlstring or null<= 255 characters

The base URL of the product catalog for the application, used together with a product unique identifier to get the product page from the shop. The allowed "wildcards" are {uniqueurl}, {productid} and {partno}, e.g. "https://demo.shop.com/products/{productId}", "https://demo.shop.com/products/{partNo}" or "https://demo.shop.com/products/{uniqueUrl}"

IsActiveboolean

If false, the application is deactivated and cannot be used by customers

Changedstring or null

The date and time when the Application entity was last changed

ChangedBystring or null

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

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

Responses

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

List applications for the current client

Request

List all applications belonging to the current 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/application/byclient \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Bodyapplication/jsonArray [
Idinteger(int32)read-only

The environment wide unique internal Norce Id of the application

Keystring(guid)read-only

The unique key of the application

Namestring or null<= 50 characters

The friendly name of the application

Descriptionstring or null<= 500 characters

A longer description of the application

HostClientIdinteger(int32)

The Host Client Id that owns this application

Urlstring or null<= 255 characters

The URL of the application, e.g. "https://demo.shop.com"

ProductUrlstring or null<= 255 characters

The base URL of the product catalog for the application, used together with a product unique identifier to get the product page from the shop. The allowed "wildcards" are {uniqueurl}, {productid} and {partno}, e.g. "https://demo.shop.com/products/{productId}", "https://demo.shop.com/products/{partNo}" or "https://demo.shop.com/products/{uniqueUrl}"

IsActiveboolean

If false, the application is deactivated and cannot be used by customers

Changedstring or null

The date and time when the Application entity was last changed

ChangedBystring or null

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

]
Response
application/json
[ { "Id": 0, "Key": "string", "Name": "string", "Description": "string", "HostClientId": 0, "Url": "string", "ProductUrl": "string", "IsActive": true, "Changed": "string", "ChangedBy": "string" } ]

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