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

PriceListType

typeIdinteger(int32)

The price list type identifier.

codestring or null[ 0 .. 50 ] characters

The code of the price list type.

sortOrderinteger(int32)

The sort order of the price list type.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

priorityinteger or null(int32)

The priority of the price list type, used by best price calculation when the UsePriceListPriority client setting is enabled.

defaultNamestring or null[ 0 .. 50 ] characters

The default name of the price list type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the price list type.

apiEditableboolean or null

Whether the price list type is editable through the API.

culturesArray of objects or null(PriceListTypeCulture)
{ "typeId": 0, "code": "string", "sortOrder": 0, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "priority": 0, "defaultName": "string", "defaultDescription": "string", "apiEditable": true, "cultures": [ { … } ] }

PriceListTypeCulture

typeIdinteger(int32)

The price list type identifier.

cultureCodestring or null[ 0 .. 16 ] characters

The culture code.

namestring or null[ 0 .. 50 ] characters

The localized name of the price list type.

descriptionstring or null[ 0 .. 500 ] characters

The localized description of the price list type.

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.

{ "typeId": 0, "cultureCode": "string", "name": "string", "description": "string", "updated": "2019-08-24T14:15:22Z", "updatedBy": 0 }

PriceList

idinteger(int32)

The unique identifier of the price list.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the price list.

defaultDescriptionstring or null

The default description of the price list.

agreementstring or null[ 0 .. 50 ] characters

The agreement, called Code in the admin tool, and in connect.

startDatestring or null(date-time)

The start date, not used see start date in PriceListClient.

endDatestring or null(date-time)

The end date, not used see end date in PriceListClient.

isPublicboolean

Indicates whether the price list is public, not used see IsPublic in PriceListClient.

isLimitedToStockboolean

Indicates whether the price list is limited to stock, not used see IsLimitedToStock in PriceListClient.

isBidboolean

Indicates whether the price list is bid, not used see IsBid in PriceListClient.

isStakoboolean

Indicates whether the price list is stako, not used see IsStako in PriceListClient.

isActiveboolean

Indicates whether the price list is active, commonly always set, see IsActive in PriceListClient.

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.

{ "id": 0, "defaultName": "string", "defaultDescription": "string", "agreement": "string", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "isPublic": true, "isLimitedToStock": true, "isBid": true, "isStako": true, "isActive": true, "created": "2019-08-24T14:15:22Z", "createdBy": 0, "updated": "2019-08-24T14:15:22Z", "updatedBy": 0 }

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations