COMMERCE QUERY
/
Query API 3.0
/
Core
/
Get application

Commerce Query API (v3.0)

Download OpenAPI description
openapi.json
openapi.yaml
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

List applications

Request

Gets all applications.

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of applications.

Bodyapplication/jsonArray [
idinteger(int32)
keystring(guid)
namestring[ 0 .. 50 ] charactersrequired
descriptionstring or null[ 0 .. 500 ] characters
urlstring or null[ 0 .. 255 ] characters
cmsUrlstring or null[ 0 .. 255 ] characters
salesUrlstring or null[ 0 .. 255 ] characters
senderEmailAddressstring or null[ 0 .. 255 ] characters
hostClientIdinteger(int32)
isActiveboolean
createdstring(date-time)
createdByinteger(int32)
updatedstring or null(date-time)
updatedByinteger or null(int32)
urlMatchstring or null[ 0 .. 4000 ] characters
parentIdinteger or null(int32)
imageKeystring or null[ 0 .. 50 ] characters
productUrlstring or null[ 0 .. 255 ] characters
aiBrandVoicestring or null
client(Client (object or null))
One of:
]
Response
application/json
[
  {
    "id": 0,
    "key": "string",
    "name": "string",
    "description": "string",
    "url": "string",
    "cmsUrl": "string",
    "salesUrl": "string",
    "senderEmailAddress": "string",
    "hostClientId": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "urlMatch": "string",
    "parentId": 0,
    "imageKey": "string",
    "productUrl": "string",
    "aiBrandVoice": "string",
    "client": { … }
  }
]

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
  }
]

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations