Skip to main content

orderItem

An orderItem refers to a specific product has been purchased and must be shipped to the consumer. It is a line item that details the quantity, description, price, and other relevant information about the product.

idinteger

The id is the internally assigned id of an orderItem. Only during and POST v3/orders is it possible to use arbitrary integer values to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 52008118
typerequired
Constant value: orderItem
Default value: orderItem
Example: orderItem
attributes object
skuproductSkurequired

SKU (stock keeping unit) of a product used to identify products.

Possible values: >= 2 characters and <= 80 characters, Value must match regular expression ^[\x21-\x7E][\x20-\x7E]*[\x21-\x7E]$

Examples:
Example: TSH-000-S
channelIdentifierchannelOrderItemIdentifier

The channelIdentifier is the (technical) id for the orderItem as assigned by the external channel. For example Shopify, Amazon, Bol, Zalando, etc. may assign a unique id for communication and synchronization purposes.

Possible values: <= 250 characters

Example: 338fd344-c902-4b1c-8733-1e7fcd01495a
quantityintegerrequired
fulfillFromwarehouseCode

When specified indicates that the item can only be fulfilled from the indicated warehouse.

Possible values: [BW, DD, FL, FP, GN, NR]

pricenumber

Specifies the price of a single unit of the product as sold to the consumer / recipient. Note that all products sold to consumers and shipped internationally must have a price greater than 0.00, as many customs agencies do not accept negative values. Furthermore, some carriers may impose a minimum price—typically around 1.000 in the order’s currency.

vatnumber

This field represents the VAT percentage that was included in the price. If omitted, the value 0.000 is assumed as the percentage. The value must be between [0.000 and 1.000⟩, with an accuracy of up to three decimal places after the comma.

Possible values: >= 0 and < 1

Default value: 0
Examples:
Example: 0.210
namestring

The name / description for this product on this orderItem. If no value is provided here, then the name of the product will be used instead whenever a name is required (for example when declaring to customs)

metadata object

Allows the specification of arbitrary name-value pairs. note currently only the names 'extra6' and 'extra7' are supported.

extra6string
extra7string
relationships object
order object

Represents a relationship to an order resource.

data object

Represents a self-link of an order resource.

idinteger

The id is an internally assigned id of an order. Only during and POST v3/orders is it possible to use arbitrary integer value which might be used to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 24006341
type
Constant value: order
Default value: order
links object
selfstring<uri>
Example: https://shopapi.activeants.nl/v3/orders/24006341
product object

Represents a relationship to a product resource.

data object

Represents a self-link of a product resource.

idinteger

The id is an internally assigned id of a product. It is possible to assign an arbitrary value in a POST request to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 1267733
type
Constant value: product
Default value: product
links object
selfstring<uri>
Example: https://shopapi.activeants.nl/v3/products/1267733
links object
selfstring<uri>
Example: https://shopapi.activeants.nl/v3/orderItems/634006341
orderItem
{
  "id": 52008118,
  "type": "orderItem",
  "attributes": {
    "sku": "TSH-000-S",
    "channelIdentifier": "338fd344-c902-4b1c-8733-1e7fcd01495a",
    "quantity": 0,
    "fulfillFrom": "BW",
    "price": 0,
    "vat": "0.210",
    "name": "string",
    "metadata": {
      "serviceLevel": "premium",
      "purchases": "140",
      "reference": "#74571"
    }
  },
  "relationships": {
    "order": {
      "data": {
        "id": 24006341,
        "links": {
          "self": "https://shopapi.activeants.nl/v3/orders/24006341"
        }
      }
    },
    "product": {
      "data": {
        "id": 1267733,
        "links": {
          "self": "https://shopapi.activeants.nl/v3/products/1267733"
        }
      }
    }
  },
  "links": {
    "self": "https://shopapi.activeants.nl/v3/orderItems/634006341"
  }
}