COMMERCE QUERY
/
Query API 3.0
/
Application
/
List client cultures

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

List category structure items

Request

Gets all category structure items.

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of category structure items.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the category structure item.

structureIdinteger(int32)

The structure identifier.

defaultNamestring or null[ 0 .. 50 ] characters

The default name of the category structure item.

useCategoryNameboolean

Indicates whether category name is used.

categoryIdinteger or null(int32)

The category identifier.

structureLevelinteger(int32)

The structure level.

parentItemIdinteger or null(int32)

The parent item identifier.

isParentboolean

Indicates whether the category structure item is parent.

isDisplayOnlyboolean

Indicates whether the category structure item is display only.

sortOrderinteger(int32)

The sort order for display purposes.

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.

keystring(guid)

The key.

category(Category (object or null))
One of:
structure(CategoryStructure (object or null))
One of:
]
Response
application/json
[
  {
    "id": 0,
    "structureId": 0,
    "defaultName": "string",
    "useCategoryName": true,
    "categoryId": 0,
    "structureLevel": 0,
    "parentItemId": 0,
    "isParent": true,
    "isDisplayOnly": true,
    "sortOrder": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "key": "string",
    "category": { … },
    "structure": { … }
  }
]

List client cultures

Request

Gets all client cultures.

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of client cultures.

Bodyapplication/jsonArray [
cultureCodestring or null[ 0 .. 16 ] characters

The culture code (e.g. en-US).

isPrimaryboolean

Indicates whether the client culture is primary for the client.

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.

collationstring or null[ 0 .. 128 ] characters

The collation.

aiInstructionstring or null
]
Response
application/json
[
  {
    "cultureCode": "string",
    "isPrimary": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "collation": "string",
    "aiInstruction": "string"
  }
]

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

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations