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

Core

Operations

Get application

Request

Gets a single application by its identifier.

Path
idinteger(int32)required

The application identifier.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Core/Applications({id})' \
  -H 'ApplicationId: 0'

Responses

A single application matching the specified identifier.

Bodyapplication/json
queryableArray of objects or null
Response
application/json
{ "queryable": [ { … } ] }

List currencies

Request

Gets all currencies.

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of currencies.

Bodyapplication/jsonArray [
idinteger(int32)

The currency identifier.

codestring[ 0 .. 3 ] charactersrequired

The ISO 4217 currency code (e.g. SEK, EUR, USD).

defaultNamestring[ 0 .. 50 ] charactersrequired

The default display name of the currency.

exchangeRatenumber(decimal)

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

defaultPrefixstring or null[ 0 .. 10 ] characters

The default prefix for the currency (e.g. $).

defaultSuffixstring or null[ 0 .. 10 ] characters

The default suffix for the currency (e.g. kr).

isActiveboolean

Indicates whether the currency 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.

]
Response
application/json
[ { "id": 0, "code": "str", "defaultName": "string", "exchangeRate": 0, "defaultPrefix": "string", "defaultSuffix": "string", "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0 } ]

Get currency

Request

Gets a single currency by its identifier.

Path
idinteger(int32)required

The currency identifier.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Core/Currencies({id})' \
  -H 'ApplicationId: 0'

Responses

A single currency matching the specified identifier.

Bodyapplication/json
queryableArray of objects or null
Response
application/json
{ "queryable": [ { … } ] }

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations