Setup
Your account manager assists with setup. The setup process includes creating and adding the following information to the account:
Sites : Sites define the location(s) that receive, prepare, and fulfill orders.
Menu Items: Menu items define products, prices, and menu structures, including combos and modifiers.
Sites
Sites are physical locations that receive and fulfill orders. Use store number and id parameters to place orders.
Site Example
{
"is_active": true,
"created_at": "20YY-03-10T17:52:16.000Z",
"created_by": null,
"updated_at": null,
"updated_by": null,
"name": "1085",
"phone_number": "",
"website": "",
"email": "",
"store_number": "AAA999",
"preferred_language": "en-US",
"aliases": [
{
"name": "xprt-init",
"value": "9999999999999999"
}
],
"timezone": "America/New_York",
"location": {
"address_1": "1234 Main Street",
"address_2": "",
"city": "Springfield",
"state": "AL",
"zip": "54321",
"country": "US",
"formatted_address": "1234 Main Street, Springfield, AL, United States"
},
"access_code": "9999999999999999999999999999",
"automatic_updates": false,
"apps": [
{
"app_code": "XPOS",
"preferred_version": {
"version": "2.4",
"uri": "https://releases.xenial.com/pos/v2.4/"
},
"installed_version": {
"version": "2.2",
"uri": "https://releases.xenial.com/pos/v2.2/"
}
}
],
"connected_devices": [],
"company": {
"id": "Company ID",
"name": "Restaurant Name",
"subscriptions": [
{
"product": "CDM",
"name": "CDM",
"is_active": true,
"count": 1,
"external_data": {},
"notified": false
},
{
"product": "OnlineOrdering",
"name": "Online Ordering",
"is_active": true,
"count": 1,
"external_data": {},
"notified": false
},
{
"product": "Heartbeat",
"name": "Heartbeat",
"is_active": true,
"count": 1,
"external_data": {},
"notified": false
},
{
"product": "POS",
"name": "POS",
"is_active": true,
"count": 1,
"external_data": {},
"notified": false
}
]
},
"roles": [],
"subscriptions": [
"CDM",
"OnlineOrdering",
"Heartbeat",
"POS"
],
"is_demo": false,
"id": "9999999999999999",
"active": true
}Menu Items
Menu items define the products, prices, and product groups that comprise menus and online orders. The main types of menu items are products and modifiers. Products can be single items or combination items, represented by bundles. Each product can also have an attached modifier collection, which provides all of the modifiers that can be applied to the product. Both products and modifiers include pricing information.
See the Menu Structure topic for additional information on the different types of menu items and the way menus are constructed. Menu items may not always be available for ordering, due to order source restrictions or running out of stock; see the Item Availability topic for additional information on how integrators can manage when menu items are displayed and available.
Use the _id parameter to add an item to an order:
Menu Item Example
{
"_id": "product_identifier",
"effective_date": "20YY-02-15T11:38:41.734Z",
"entity_id": "entity_identifier",
"is_deleted": false,
"external_id": "999999",
"product_id": "999999",
"name": "X-FISH 1PC",
"builds": [],
"external_category_ids": [],
"is_bundle": false,
"is_open_price": false,
"include_in_plain_builds": false,
"product_type": "standard",
"revenue_class": "default",
"modifier_collection_entity_id": "",
"reporting_category": {},
"variation_info": {
"variant_entity_id": "",
"parent_entity_id": "",
"variations": [
{
"variant_entity_id": "variant_entity_identifier",
"product_entity_id": "product_entity_identifier",
"variant": {
"_id": "variant_identifier",
"entity_id": "variant_entity_identifier",
"name": "Substitute"
}
}
}
"external_tag_ids": [
"400",
"491"
],
"product_tag_entity_ids": [
"999999999999999999999",
"999999999999999999999"
],
"tax_group_entity_id": "999999999999999999999",
"tax_group": {
"_id": "999999999999999999999",
"effective_date": "20YY-02-15T11:38:42.312Z",
"entity_id": "999999999999999999999",
"is_deleted": false,
"name": "Tax",
"eat_in_mask": "YNNNNNNNNN",
"eat_out_mask": "YNNNNNNNNN",
"tax_code": "0",
"external_id": "0"
},
"tags": [
{
"_id": "999999999999999999999",
"effective_date": "20YY-02-15T11:38:41.727Z",
"entity_id": "999999999999999999999",
"is_deleted": false,
"category_id": "400",
"external_id": "400",
"name": "Modifiers",
"text_color": "#ffffff",
"background_color": "#888888",
"lookup_tag_type_ids": [
"999999999999999999999"
]
},
{
"_id": "999999999999999999999",
"effective_date": "20YY-02-15T11:38:41.728Z",
"entity_id": "999999999999999999999",
"is_deleted": false,
"category_id": "491",
"external_id": "491",
"name": "Others",
"text_color": "#ffffff",
"background_color": "#888888",
"lookup_tag_type_ids": [
"999999999999999999999"
]
}
],
"prices": [
{
"_id": "999999999999999999999",
"effective_date": "20YY-02-15T11:38:41.946Z",
"entity_id": "999999999999999999999",
"is_deleted": false,
"unit_price": 1.64,
"external_id": "999999",
"product_id": "999999",
"type": "standard",
"product_entity_id": "999999999999999999999",
"time_period_entity_ids": [
"999999999999999999999"
],
"time_periods": [
{
"_id": "999999999999999999999",
"effective_date": "20YY-02-15T11:38:41.943Z",
"entity_id": "999999999999999999999",
"is_deleted": false,
"external_id": "1",
"name": "All",
"available_days": [
{
"start_time": "20YY-12-30 00:00:00Z",
"end_time": "20YY-12-30 23:59:59Z"
}
]
}
]
}
],
"child_prices": []
}