COMMERCE QUERY
/
Query API 3.0
/
Core

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

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

Schemas

Application

Operations

Core

Operations

Gets all applications.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.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
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",
    "client": { … }
  }
]

Gets a single application by its identifier.

Request

Path
idinteger(int32)required

The application identifier.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://norcecommerce.api-se.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": [
    { … }
  ]
}

Gets all currencies.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of currencies.

Bodyapplication/jsonArray [
idinteger(int32)
codestring[ 0 .. 3 ] charactersrequired
defaultNamestring[ 0 .. 50 ] charactersrequired
exchangeRatenumber(decimal)
defaultPrefixstring or null[ 0 .. 10 ] characters
defaultSuffixstring or null[ 0 .. 10 ] characters
isActiveboolean
createdstring(date-time)
createdByinteger(int32)
updatedstring or null(date-time)
updatedByinteger or null(int32)
]
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