OrderItem

The line items in the order. May include products, discounts, or vouchers.

idstring

The unique identifier for this item.

namestring

The name of the item

ageRestrictedboolean

Is this item subject to an age restriction check?

barcodestring

An optional item barcode

vendorReferencestring

An optional item reference that can be used to identify the item at the vendor

typestring

What this line item is

• product: A physical product that has been ordered
• offer: e.g You've added 2 items and you get the third free ... the offer entry would be a price negation of the third item.
• voucher: The consumer has used a promotional voucher code
• adjustment: An adjustment made after the order was placed (defective products, price matching etc).

Possible values: [product, offer, voucher, adjustment]

optionCategories object[]

If this item can be customised, this contains the categories of options that can be chosen (e.g 'Toppings', 'Sides' etc)

Array [

namestring

The name of the group of options (e.g 'Sides', 'Toppings', 'Drinks' etc).

selectedOptions object[]

The options that were selected (e.g 'Plain Chips', 'Peri-Peri Chips', 'Noodles' etc)

Array [

namestring

The name of the selected option (e.g 'Chips')

optionPrice object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

]

]

quantityOrderedint32

The quantity of this item that was ordered.

quantityFulfilledint32

The quantity of this item that was supplied to the customer.

price object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

total object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

priceAdjustmentDetails object

If the price of this item was adjusted after the order was placed, this contains further information

itemsAdjustedstring[]

If this item is an adjustment, this contains a list of items that this adjustment relates to

relatedPriceAdjustmentstring

If this item is a product which has been price adjusted, this is the associated adjustment id

substitutionDetails object

If this item was substituted by another item / substitutes an item, this contains further information

substitutedBystring[]

List of item ids that this item has been replaced by

substitutedForstring[]

List of item ids that this item replaces

OrderItem

{
  "id": "string",
  "name": "string",
  "ageRestricted": true,
  "barcode": "string",
  "vendorReference": "string",
  "type": "product",
  "optionCategories": [
    {
      "name": "string",
      "selectedOptions": [
        {
          "name": "string",
          "optionPrice": {
            "amount": 1099,
            "currency": "GBP"
          }
        }
      ]
    }
  ],
  "quantityOrdered": 0,
  "quantityFulfilled": 0,
  "price": {
    "amount": 1099,
    "currency": "GBP"
  },
  "total": {
    "amount": 1099,
    "currency": "GBP"
  },
  "priceAdjustmentDetails": {
    "itemsAdjusted": [
      "string"
    ],
    "relatedPriceAdjustment": "string"
  },
  "substitutionDetails": {
    "substitutedBy": [
      "string"
    ],
    "substitutedFor": [
      "string"
    ]
  }
}