COMMERCE QUERY

Query API 3.0

OrderItem

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

InvoiceItem

idinteger(int64)

The unique identifier of the invoice item.

invoiceIdinteger(int64)

The invoice identifier.

lineNumbernumber or null(decimal)

The line number.

statusIdinteger or null(int32)

The status identifier, commonly Invoiced (5).

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.

warehouseIdinteger or null(int32)

The warehouse identifier, not used anymore.

locationIdinteger or null(int32)

The location identifier, not used anymore.

quantityinteger(int32)

The quantity as an integer, use Quantity2 for decimal values.

currencyIdinteger(int32)

The currency identifier.

vatRatenumber(decimal)

The VAT rate, in percent.

costUnitnumber or null(decimal)

The cost unit.

priceSalenumber or null(decimal)

The price sale, excluding VAT.

discountPercentagenumber(decimal)

The discount percentage.

discountAmountnumber(decimal)

The discount amount, excluding VAT.

lineAmountnumber(decimal)

The line amount, excluding VAT.

deliveryModestring or null[ 0 .. 255 ] characters

The delivery mode.

isPartDeliveryboolean

Indicates whether the invoice item is part delivery, not commonly used.

deliveryDatestring or null(date-time)

The delivery date.

salesRepContactIdinteger or null(int32)

The sales rep contact identifier, not commonly used.

ledgerAccountstring or null[ 0 .. 50 ] characters

The ledger account, not used anymore.

departmentstring or null[ 0 .. 10 ] characters

The department, not commonly used.

centrestring or null[ 0 .. 10 ] characters

The centre, not commonly used.

transIdinteger(int64)

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, links the invoice item to an order item.

purchaseOrderItemIdinteger or null(int64)

The purchase order item identifier, links the invoice item to a purchase order item, not used anymore.

lineNumberStringstring or null[ 0 .. 50 ] characters

The line number as string.

priceUnitnumber or null(decimal)

The price unit, excluding VAT, its the price sale / Unit of measurement count, commonly same as PriceSale.

quantity2number or null(decimal)

The quantity in decimal value.

clientIdinteger or null(int32)

The client identifier.

orderItem(OrderItem (object or null))

One of:

{
  "id": 0,
  "invoiceId": 0,
  "lineNumber": 0,
  "statusId": 0,
  "partNo": "string",
  "externalPartNo": "string",
  "productName": "string",
  "stockUnitOfMeasurementCount": 0,
  "priceUnitOfMeasurementCount": 0,
  "warehouseId": 0,
  "locationId": 0,
  "quantity": 0,
  "currencyId": 0,
  "vatRate": 0,
  "costUnit": 0,
  "priceSale": 0,
  "discountPercentage": 0,
  "discountAmount": 0,
  "lineAmount": 0,
  "deliveryMode": "string",
  "isPartDelivery": true,
  "deliveryDate": "2019-08-24T14:15:22Z",
  "salesRepContactId": 0,
  "ledgerAccount": "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",
  "priceUnit": 0,
  "quantity2": 0,
  "clientId": 0,
  "orderItem": {
    "id": 0,
    "orderId": 0,
    "lineNumber": 0,
    "parentLineNumber": 0,
    "statusId": 0,
    "partNo": "string",
    "externalPartNo": "string",
    "productName": "string",
    "stockUnitOfMeasurementCount": 0,
    "priceUnitOfMeasurementCount": 0,
    "warehouseId": 0,
    "locationId": 0,
    "qtyOrdered": 0,
    "currencyId": 0,
    "vatRate": 0,
    "costUnit": 0,
    "priceSale": 0,
    "discountPercentage": 0,
    "discountAmount": 0,
    "lineAmount": 0,
    "deliveryMode": "string",
    "isPartDelivery": true,
    "expectedDeliveryDate": "2019-08-24T14:15:22Z",
    "confirmedDeliveryDate": "2019-08-24T14:15:22Z",
    "salesRepContactId": 0,
    "ledgerAccount": "string",
    "department": "string",
    "centre": "string",
    "transId": 0,
    "externalStatusText": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "lineNumberString": "string",
    "priceRecommended": 0,
    "priceCatalog": 0,
    "priceStandard": 0,
    "clientId": 0,
    "childTypeId": 0,
    "invoiceItem": [ … ],
    "infos": [ … ]
  }
}

OrderItem

idinteger(int64)

The unique identifier of the order item.

orderIdinteger(int64)

The order identifier.

lineNumbernumber(decimal)

The line number.

parentLineNumbernumber or null(decimal)

The parent line number, is the line has a relationship to another line, like a bundle or an accessory grouped together in the purchase (warrantied, services, etc.).

statusIdinteger(int32)

The status identifier, common values are Created (0), Allocation (1), Confirmed (2), Delivered (4), Invoiced (5), Cancelled (6), Partly delivered (8).

partNostring[ 0 .. 50 ] charactersrequired

The product part number.

externalPartNostring or null[ 0 .. 50 ] characters

The optional external part number, not commonly used.

productNamestring or null[ 0 .. 255 ] characters

The product name.

stockUnitOfMeasurementCountnumber(decimal)

The stock unit of measurement count, should be same as unit of measurement count on the ProductSku, commonly 1.000.

priceUnitOfMeasurementCountnumber(decimal)

The price unit of measurement count, should be same as unit of measurement count on the ProductSku, commonly 1.000.

warehouseIdinteger or null(int32)

The warehouse identifier, not used anymore.

locationIdinteger or null(int32)

The location identifier, not used anymore.

qtyOrderednumber(decimal)

The quantity ordered.

currencyIdinteger(int32)

The currency identifier.

vatRatenumber(decimal)

The VAT rate, in percent for example 25.0000 for 25%.

costUnitnumber(decimal)

The unit cost, excluding VAT when order was created.

priceSalenumber(decimal)

The price sale, unit price excluding VAT when order was created, including any discounts.

discountPercentagenumber(decimal)

The discount percentage, from promotions only, campaign price lists are not included.

discountAmountnumber(decimal)

The discount amount excluding VAT, from promotions only, campaign price lists are not included.

lineAmountnumber(decimal)

The line amount, subtotal excluding VAT (PriceSale * QtyOrdered).

deliveryModestring or null[ 0 .. 255 ] characters

The delivery mode, not commonly used.

isPartDeliveryboolean

Indicates whether the order item is part delivery, can be true if quantity ordered is partly delivered by a DeliveryNote.

expectedDeliveryDatestring or null(date-time)

The expected delivery date, not used anymore.

confirmedDeliveryDatestring or null(date-time)

The confirmed delivery date, not used anymore.

salesRepContactIdinteger or null(int32)

The sales rep contact identifier, not used anymore.

ledgerAccountstring or null[ 0 .. 50 ] characters

The ledger account, not used anymore.

departmentstring or null[ 0 .. 10 ] characters

The department, not used anymore.

centrestring or null[ 0 .. 10 ] characters

The centre, not used anymore.

transIdinteger(int64)

The trans identifier, not used anymore.

externalStatusTextstring or null[ 0 .. 255 ] characters

The external status text, 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.

lineNumberStringstring or null[ 0 .. 50 ] characters

The line number in a string format.

priceRecommendednumber or null(decimal)

The recommended price, when order was created, commonly used as reference to undiscounted price when campaign price lists are applied to SalePrice, if null check PriceStandard instead.

priceCatalognumber or null(decimal)

The price catalog, when order was created.

priceStandardnumber or null(decimal)

The Sale price from the parent price list if parent exists, when order was created, can be used as reference to undiscounted price when campaign price lists are applied to SalePrice, if PriceRecommended is null.

clientIdinteger or null(int32)

The client identifier.

childTypeIdinteger or null(int32)

invoiceItemArray of objects or null(InvoiceItem)

infosArray of objects or null(OrderItemInfo)

{
  "id": 0,
  "orderId": 0,
  "lineNumber": 0,
  "parentLineNumber": 0,
  "statusId": 0,
  "partNo": "string",
  "externalPartNo": "string",
  "productName": "string",
  "stockUnitOfMeasurementCount": 0,
  "priceUnitOfMeasurementCount": 0,
  "warehouseId": 0,
  "locationId": 0,
  "qtyOrdered": 0,
  "currencyId": 0,
  "vatRate": 0,
  "costUnit": 0,
  "priceSale": 0,
  "discountPercentage": 0,
  "discountAmount": 0,
  "lineAmount": 0,
  "deliveryMode": "string",
  "isPartDelivery": true,
  "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  "confirmedDeliveryDate": "2019-08-24T14:15:22Z",
  "salesRepContactId": 0,
  "ledgerAccount": "string",
  "department": "string",
  "centre": "string",
  "transId": 0,
  "externalStatusText": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "lineNumberString": "string",
  "priceRecommended": 0,
  "priceCatalog": 0,
  "priceStandard": 0,
  "clientId": 0,
  "childTypeId": 0,
  "invoiceItem": [
    { … }
  ],
  "infos": [
    { … }
  ]
}

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
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations