COMMERCE QUERY

Query API 3.0

Client

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

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

client(Client (object or null))

One of:

{
  "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",
  "client": {
    "id": 0,
    "key": "string",
    "hostId": 0,
    "corporationId": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "secretKey": "string",
    "applicationEnvironment": "string",
    "slug": "string",
    "merchant": "string",
    "applications": [ … ],
    "clientHost": { … }
  }
}

Client

idinteger(int32)

keystring(guid)

hostIdinteger(int32)

corporationIdinteger(int32)

isActiveboolean

createdstring(date-time)

createdByinteger(int32)

updatedstring or null(date-time)

updatedByinteger or null(int32)

secretKeystring(guid)

applicationEnvironmentstring or null[ 0 .. 50 ] characters

slugstring or null[ 0 .. 50 ] characters

merchantstring or null[ 0 .. 50 ] characters

applicationsArray of objects or null(Application)

clientHost(ClientHost (object or null))

One of:

{
  "id": 0,
  "key": "string",
  "hostId": 0,
  "corporationId": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "secretKey": "string",
  "applicationEnvironment": "string",
  "slug": "string",
  "merchant": "string",
  "applications": [
    { … }
  ],
  "clientHost": {
    "id": 0,
    "key": "string",
    "clientId": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "clients": [ … ]
  }
}

ClientHost

idinteger(int32)

keystring(guid)

clientIdinteger(int32)

isActiveboolean

createdstring(date-time)

createdByinteger(int32)

updatedstring or null(date-time)

updatedByinteger or null(int32)

clientsArray of objects or null(Client)

{
  "id": 0,
  "key": "string",
  "clientId": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clients": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations