Schemas

OrderItem

OrderItemobjectOrderItem

Name, prices and tax rate are taken as sent. productId / modifierOptionId are matched to the restaurant's product or option; a line that cannot be matched still reaches the till with your data. Switched-off items are matched and accepted.

Attributes

lineIdstringRequired1-128 chars

Unique within the order

productIdstringRequired1-128 chars

The menu file's products[].id

namestringRequired1-200 chars

As the customer saw it

quantityintegerRequired1-999

unitPriceintegerRequired0-10000000

Gross

taxRatenumberRequired0-100

The line's tax rate (the menu file's taxRate); it applies to the line's modifiers too

notestringOptional0-500 chars

modifiersarray of objectOrderModifierRequired0-100 items

[] for none

Show child attributesHide child attributes

modifierGroupIdstringRequired1-128 chars

The menu file's modifierGroups[].id

modifierOptionIdstringRequired1-128 chars

The menu file's options[].id

namestringRequired1-200 chars

As the customer saw it

quantityintegerRequired1-999

Per piece of the line

unitPriceintegerRequired0-10000000

Gross

Example

{
  "lineId": "string",
  "productId": "string",
  "name": "string",
  "quantity": 1,
  "unitPrice": 1,
  "taxRate": 1.5,
  "note": "string",
  "modifiers": [
    {
      "modifierGroupId": "string",
      "modifierOptionId": "string",
      "name": "string",
      "quantity": 1,
      "unitPrice": 1
    }
  ]
}