API Documentation

# Order API Resources v1.0

Each resource used in the Order API version 1.0 is listed below.

A representation of the menu item or option set item with information about an associated POS item.

Name Required Type Description
key true int64 The unique key for the menu item.
itemType true string The type of item.
name true string The name of the item.
currency true string The currency for the price of the menu item.
price true double The price of the menu item.
posItem true PosItem The POS item is the item in POS that represents a menu item or option set item.

# Sample

{
    "key": 811000176,
    "menuKey": "ROCO-ZA-3",
    "menuVersion": 202004,
    "itemType": "Item",
    "name": "Classic Cheese Burger",
    "currency": "ZAR",
    "price": 64.00,
    "aggregated": false,
    "posItem": {
        "key": 24713,
        "pointOfSale": "Pilot",
        "dataSet": "PILOT_ROCO_STD_ZA",
        "dataSetVersion": "1200914",
        "code": "1204",
        "name": "Classic Cheese",
        "currency": "ZAR",
        "price": 67.00,
        "enabled": true
    }
}

# PosItem

The item in POS that represents a menu item or option set item.

Name Required Type Description
key false int The unique key for the POS item.
pointOfSale false string The POS system that the item is from.
dataSet false string The POS dataset the item is from.
dataSetVersion false string The version of the dataset the item is from.
code false string The POS code for the item.
name false string The name of the item in the POS dataset.
currency false string The currency for the item price.
price false double The price of the item in POS.
enabled false boolean Indicates if the item is active or not.
aggregated false boolean Indicates if the POS code is aggregated.

# Sample

{
    "key": 24713,
    "pointOfSale": "Pilot",
    "dataSet": "PILOT_ROCO_STD_ZA",
    "dataSetVersion": "1200914",
    "code": "1204",
    "name": "Classic Cheese",
    "currency": "ZAR",
    "price": 67.00,
    "enabled": true
}

← Lookup POS Codes →