COMMERCE QUERY

Query API 3.0

Warehouse

Commerce Query API (v3.0)

Download OpenAPI description

openapi.json

openapi.yaml

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

ProductInfoTypeCulture

typeIdinteger(int32)

The type identifier.

cultureCodestring or null[ 0 .. 16 ] characters

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

namestring or null[ 0 .. 50 ] characters

The culture specific name of the product info type.

descriptionstring or null[ 0 .. 500 ] characters

The culture specific description of the product info 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.

clientIdinteger or null(int32)

The client identifier.

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

Warehouse

idinteger(int32)

The unique identifier of the warehouse.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the warehouse.

isActiveboolean

Indicates whether the warehouse 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.

{
  "id": 0,
  "defaultName": "string",
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0
}

ClientWarehouse

warehouseIdinteger(int32)

The warehouse identifier.

typeIdinteger(int32)

The type identifier, Warehouse (1), Store (2), Transport (3), Other (4).

codestring or null[ 0 .. 50 ] characters

The code of the client warehouse.

namestring or null[ 0 .. 50 ] characters

The name of the client warehouse.

isStandardboolean

Indicates whether the client warehouse is standard, only one standard warehouse is allowed per client.

standardLeadTimeDayCountinteger or null(int32)

The standard lead time day count, used for calculating the expected delivery time.

freightCostnumber or null(decimal)

The freight cost, not used anymore.

costBlockinteger or null(int32)

The cost block, not used anymore.

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.

locationsArray of objects or null(ClientWarehouseLocation)

{
  "warehouseId": 0,
  "typeId": 0,
  "code": "string",
  "name": "string",
  "isStandard": true,
  "standardLeadTimeDayCount": 0,
  "freightCost": 0,
  "costBlock": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "locations": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations