COMMERCE QUERY

Query API 3.0

OrderItemInfo

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

DeliveryNoteItem

idinteger(int64)

The unique identifier of the delivery note item.

deliveryNoteIdinteger(int64)

The delivery note identifier.

lineNumbernumber or null(decimal)

The line number.

partNostring[ 0 .. 50 ] charactersrequired

The part number.

externalPartNostring or null[ 0 .. 50 ] characters

The external part number, not commonly used.

productNamestring or null[ 0 .. 255 ] characters

The product name.

stockUnitOfMeasurementCountnumber(decimal)

The stock unit of measurement count.

priceUnitOfMeasurementCountnumber(decimal)

The price unit of measurement count.

qtyOrderednumber(decimal)

The quantity ordered, should be same as on Sales Order, if not, that Sales Order has probably been modified in the ERP.

quantitynumber(decimal)

The quantity in the delivery.

qtyBackOrderednumber(decimal)

The quantity back ordered, goods not delivered yet on the sales order.

isPartDeliveryboolean

Indicates whether the delivery item has only partially fulfilled the order.

salesRepContactIdinteger or null(int32)

The sales rep contact identifier, not used anymore.

vatRatenumber(decimal)

The VAT rate, commonly not used, check invoice or the order.

valueMstnumber(decimal)

The value mst, not commonly used.

noteTextstring or null[ 0 .. 255 ] characters

The note text.

departmentstring or null[ 0 .. 10 ] characters

The department, not commonly used.

centrestring or null[ 0 .. 10 ] characters

The centre, not commonly used.

transIdinteger(int32)

The trans identifier, 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.

orderItemIdinteger or null(int64)

The order item identifier, link to the OrderItem.

purchaseOrderItemIdinteger or null(int64)

The purchase order item identifier, not used anymore.

lineNumberStringstring or null[ 0 .. 50 ] characters

The line number string.

clientIdinteger or null(int32)

The client identifier.

{
  "id": 0,
  "deliveryNoteId": 0,
  "lineNumber": 0,
  "partNo": "string",
  "externalPartNo": "string",
  "productName": "string",
  "stockUnitOfMeasurementCount": 0,
  "priceUnitOfMeasurementCount": 0,
  "qtyOrdered": 0,
  "quantity": 0,
  "qtyBackOrdered": 0,
  "isPartDelivery": true,
  "salesRepContactId": 0,
  "vatRate": 0,
  "valueMst": 0,
  "noteText": "string",
  "department": "string",
  "centre": "string",
  "transId": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "orderItemId": 0,
  "purchaseOrderItemId": 0,
  "lineNumberString": "string",
  "clientId": 0
}

OrderItemInfo

orderItemIdinteger(int64)

The order item identifier.

typeIdinteger(int32)

The info type identifier.

valuestringnon-emptyrequired

The value.

updatedstring(date-time)

The date and time the record was last updated.

updatedByinteger(int32)

The identifier of the user who last updated the record.

clientIdinteger or null(int32)

The client identifier.

type(OrderInfoType (object or null))

The order info type.

One of:

The order info type.

{
  "orderItemId": 0,
  "typeId": 0,
  "value": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "clientId": 0,
  "type": {
    "id": 0,
    "clientId": 0,
    "applicationId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "sortOrder": 0,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "groupId": 0,
    "cultures": [ … ]
  }
}

OrderInfoType

idinteger(int32)

The unique identifier of the order info type.

clientIdinteger(int32)

The client identifier.

applicationIdinteger(int32)

The application identifier.

codestring[ 0 .. 50 ] charactersrequired

The code of the order info type.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the order info type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the order info type.

sortOrderinteger or null(int32)

The sort order for display purposes.

isActiveboolean

Indicates whether the order info type 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.

groupIdinteger(int32)

The group identifier, Order (1), OrderItem (2).

culturesArray of objects or null(OrderInfoTypeCulture)

{
  "id": 0,
  "clientId": 0,
  "applicationId": 0,
  "code": "string",
  "defaultName": "string",
  "defaultDescription": "string",
  "sortOrder": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "groupId": 0,
  "cultures": [
    { … }
  ]
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations