Commerce Query API (v3.0)

Download OpenAPI description
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/query/3.0/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/query/3.0/

Production

https://{slug}.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

Operations

List client currencies

Request

Gets all client currencies.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Application/ClientCurrencies \
  -H 'ApplicationId: 0'

Responses

A queryable collection of client currencies.

Bodyapplication/jsonArray [
currencyIdinteger(int32)

The currency identifier.

exchangeRatenumber or null(decimal)

The exchange rate, conversion rate between the currency and EUR.

isPrimaryboolean

Indicates whether the currency client is primary.

thresholdPercentnumber or null(decimal)

The threshold percent, used for determining when to trigger certain actions based on the currency value, currently not used.

schedulestring or null[ 0 .. 1000 ] characters

The schedule, defining the timing or frequency of currency updates, currently not used.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

]
Response
application/json
[ { "currencyId": 0, "exchangeRate": 0, "isPrimary": true, "thresholdPercent": 0, "schedule": "string", "updated": "2019-08-24T14:15:22Z", "updatedBy": 0 } ]

List client manufacturers

Request

Gets all client manufacturers.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Application/ClientManufacturers \
  -H 'ApplicationId: 0'

Responses

A queryable collection of client manufacturers.

Bodyapplication/jsonArray [
manufacturerIdinteger(int32)

The manufacturer identifier.

manufacturerCodestring or null[ 0 .. 50 ] characters

The manufacturer code.

namestring or null[ 0 .. 100 ] characters

The name of the client manufacturer.

isActiveboolean

Indicates whether the client manufacturer is active.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

uniqueUrlNamestring[ 0 .. 255 ] charactersrequired

The unique url name.

isUniqueUrlNameManuallyMaintainedboolean

Indicates whether the client manufacturer is unique url name manually maintained.

manufacturer(Manufacturer (object or null))
One of:
info(ManufacturerInfo (object or null))
One of:
]
Response
application/json
[ { "manufacturerId": 0, "manufacturerCode": "string", "name": "string", "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0, "uniqueUrlName": "string", "isUniqueUrlNameManuallyMaintained": true, "manufacturer": { … }, "info": { … } } ]

List supplier manufacturer mappings

Request

Gets all supplier-to-manufacturer mappings.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Application/SupplierManufacturerMappings \
  -H 'ApplicationId: 0'

Responses

A queryable collection of supplier manufacturer mappings.

Bodyapplication/jsonArray [
clientIdinteger(int32)
supplierIdinteger(int32)
manufacturerSupplierIdinteger(int32)
codestring
productCountinteger(int32)
isActiveboolean
]
Response
application/json
[ { "clientId": 0, "supplierId": 0, "manufacturerSupplierId": 0, "code": "string", "productCount": 0, "isActive": true } ]

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations