View a merchant’s menu.

Menu Request

HTTP Request

GET /merchant/{merchant_id}/menu

Parameter Name Value Description
Required Parameters
merchant_id Integer The id of the merchant from the Search endpoint.
Optional Parameters
item_only 0|1 If 1 is passed, then only items will be returned without any of their options. This will generally return faster, but you’ll have to make another API call to get the full list of options if the user views an item.
hide_unavailable 0|1 If 1 is passed, then only the items that are currently available to order will be returned. For example: breakfast menu may have a schedule from 8:00am-11:00am, if you do a search at 2:00pm, the breakfast menu/items will NOT be returned if hide_unavailable is set to 1.

Request Body

Do not supply a request body with this method.

Responses

Success

HTTP 200 OK

Example

{
    "schedule": [
        {
            "id": 2,
            "times": [
                {
                    "day": "Monday",
                    "from": "2013-09-30T15:00:00+0000",
                    "to": "2013-09-30T20:00:00+0000"
                },
                {
                    "day": "Tuesday",
                    "from": "2013-10-01T15:00:00+0000",
                    "to": "2013-10-01T20:00:00+0000"
                },
                {
                    "day": "Wednesday",
                    "from": "2013-10-02T15:00:00+0000",
                    "to": "2013-10-02T20:00:00+0000"
                },
                {
                    "day": "Thursday",
                    "from": "2013-09-26T15:00:00+0000",
                    "to": "2013-09-26T20:00:00+0000"
                },
                {
                    "day": "Friday",
                    "from": "2013-09-27T15:00:00+0000",
                    "to": "2013-09-27T20:00:00+0000"
                },
                {
                    "day": "Saturday",
                    "from": "2013-09-28T16:00:00+0000",
                    "to": "2013-09-28T20:00:00+0000"
                },
                {
                    "day": "Sunday",
                    "from": "2013-09-29T16:00:00+0000",
                    "to": "2013-09-29T20:00:00+0000"
                }
            ]
        },
        {
            "id": 4,
            "times": [
                {
                    "day": "Monday",
                    "from": "2013-09-30T21:00:00+0000",
                    "to": "2013-09-30T23:00:00+0000"
                },
                {
                    "day": "Tuesday",
                    "from": "2013-10-01T21:00:00+0000",
                    "to": "2013-10-01T23:00:00+0000"
                },
                {
                    "day": "Wednesday",
                    "from": "2013-10-02T21:00:00+0000",
                    "to": "2013-10-02T23:00:00+0000"
                },
                {
                    "day": "Thursday",
                    "from": "2013-09-26T21:00:00+0000",
                    "to": "2013-09-26T23:00:00+0000"
                },
                {
                    "day": "Friday",
                    "from": "2013-09-27T21:00:00+0000",
                    "to": "2013-09-27T23:00:00+0000"
                },
                {
                    "day": "Saturday",
                    "from": "2013-09-28T21:00:00+0000",
                    "to": "2013-09-28T23:00:00+0000"
                },
                {
                    "day": "Sunday",
                    "from": "2013-09-29T21:00:00+0000",
                    "to": "2013-09-29T23:00:00+0000"
                }
            ]
        }
    ],
    "warnings": [
        {
            "type": "alcohol",
            "items": [
                "N2",
                "N8"
            ]
        },
        {
            "type": "tobacco",
            "items": [
                "N10"
            ]
        }
    ],
    "menu": [
        {
            "id": "N1",
            "name": "Test Menu",
            "description": "Items of each type are represented here.",
            "type": "menu",
            "children": [
                {
                    "id": "N2",
                    "name": "Simple Item",
                    "description": null,
                    "schedule": [
                        2,
                        4
                    ],
                    "min_qty": "1.00",
                    "max_qty": "25.00",
                    "price": "5.99",
                    "max_price": "5.99",
                    "type": "item",
                    "children": [
                        {
                            "id": "N56",
                            "name": "Simple Item IMAGES",
                            "url": "/images/path/1234.jpg",
                            "description": null,
                            "type": "image",
                            "children": []
                        }
                    ]
                },
                {
                    "id": "N3",
                    "name": "Item, Price Group",
                    "description": null,
                    "min_qty": "1.00",
                    "max_qty": "25.00",
                    "price": "1.99",
                    "max_price": "3.99",
                    "type": "item",
                    "children": [
                        {
                            "id": "N4",
                            "name": "Pick One",
                            "description": null,
                            "min_selection": "1",
                            "max_selection": "1",
                            "type": "price group",
                            "children": [
                                {
                                    "id": "N5",
                                    "name": "Small",
                                    "description": null,
                                    "price": "1.99",
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N6",
                                    "name": "Medium",
                                    "description": null,
                                    "price": "2.99",
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N7",
                                    "name": "Large",
                                    "description": null,
                                    "price": "3.99",
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "N8",
                    "name": "Item, Option Group : Single",
                    "description": null,
                    "schedule": [
                        4
                    ],
                    "min_qty": "1.00",
                    "max_qty": "25.00",
                    "price": "5.99",
                    "max_price": "5.99",
                    "type": "item",
                    "children": [
                        {
                            "id": "N11",
                            "name": "Single Option Group",
                            "description": null,
                            "min_selection": "1",
                            "max_selection": "1",
                            "sel_dep": 0,
                            "type": "option group",
                            "children": [
                                {
                                    "id": "N12",
                                    "name": "Un",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N13",
                                    "name": "Dos",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N14",
                                    "name": "Tres",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "N9",
                    "name": "Item, Option Group : Multiple",
                    "description": null,
                    "min_qty": "1.00",
                    "max_qty": "25.00",
                    "price": "5.99",
                    "max_price": "5.99",
                    "type": "item",
                    "children": [
                        {
                            "id": "N15",
                            "name": "Multiple Option Group",
                            "description": null,
                            "min_selection": "0",
                            "max_selection": "3",
                            "sel_dep": 0,
                            "type": "option group",
                            "children": [
                                {
                                    "id": "N16",
                                    "name": "Salt",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N17",
                                    "name": "Pepper",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N18",
                                    "name": "Spice",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "N10",
                    "name": "Item, Option Group : Quantity",
                    "description": null,
                    "min_qty": "1.00",
                    "max_qty": "25.00",
                    "price": "5.99",
                    "max_price": "5.99",
                    "type": "item",
                    "children": [
                        {
                            "id": "N19",
                            "name": "Option Group Quantity (Select 5)",
                            "description": null,
                            "min_selection": "5",
                            "max_selection": "5",
                            "sel_dep": 0,
                            "type": "option group",
                            "children": [
                                {
                                    "id": "N20",
                                    "name": "Option 1",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "min_qty": "0.00",
                                    "max_qty": "5.00",
                                    "increment": "1.00",
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N21",
                                    "name": "Option 2",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "min_qty": "0.00",
                                    "max_qty": "5.00",
                                    "increment": "1.00",
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N22",
                                    "name": "Option 3",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "min_qty": "0.00",
                                    "max_qty": "5.00",
                                    "increment": "1.00",
                                    "type": "option",
                                    "children": []
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "N23",
                    "name": "Item, Option Group : Upto One",
                    "description": null,
                    "schedule": [
                        2
                    ],
                    "min_qty": "1.00",
                    "max_qty": "25.00",
                    "price": "5.99",
                    "max_price": "9.98",
                    "type": "item",
                    "children": [
                        {
                            "id": "N24",
                            "name": "Optional Condiments",
                            "description": null,
                            "min_selection": "0",
                            "max_selection": "1",
                            "sel_dep": 0,
                            "type": "option group",
                            "children": [
                                {
                                    "id": "N25",
                                    "name": "Egg Roll",
                                    "description": null,
                                    "price": "1.99",
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N26",
                                    "name": "Tuna Roll",
                                    "description": null,
                                    "price": "2.99",
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N27",
                                    "name": "Jellyfish Roll",
                                    "description": null,
                                    "price": "3.99",
                                    "max_price": null,
                                    "type": "option",
                                    "children": []
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "N28",
                    "name": "Item, Nested Option Group",
                    "description": null,
                    "min_qty": "1.00",
                    "max_qty": "25.00",
                    "price": "5.99",
                    "max_price": "5.99",
                    "type": "item",
                    "children": [
                        {
                            "id": "N29",
                            "name": "Choice of Combo",
                            "description": null,
                            "min_selection": "1",
                            "max_selection": "1",
                            "sel_dep": 0,
                            "type": "option group",
                            "children": [
                                {
                                    "id": "N30",
                                    "name": "Burger and Soda",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "type": "option",
                                    "children": [
                                        {
                                            "id": "N33",
                                            "name": "Choice of Soda",
                                            "description": null,
                                            "min_selection": "1",
                                            "max_selection": "1",
                                            "sel_dep": 0,
                                            "type": "option group",
                                            "children": [
                                                {
                                                    "id": "N34",
                                                    "name": "Pepsi",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                },
                                                {
                                                    "id": "N35",
                                                    "name": "Coke",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                },
                                                {
                                                    "id": "N36",
                                                    "name": "Sprite",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                },
                                                {
                                                    "id": "N37",
                                                    "name": "Fanta",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                }
                                            ]
                                        }
                                    ]
                                },
                                {
                                    "id": "N31",
                                    "name": "Pizza and Soda",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "type": "option",
                                    "children": [
                                        {
                                            "id": "N39",
                                            "name": "Choice of Soda",
                                            "description": null,
                                            "min_selection": "1",
                                            "max_selection": "1",
                                            "sel_dep": 0,
                                            "type": "option group",
                                            "children": [
                                                {
                                                    "id": "N40",
                                                    "name": "Pepsi",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                },
                                                {
                                                    "id": "N41",
                                                    "name": "Coke",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                },
                                                {
                                                    "id": "N42",
                                                    "name": "Sprite",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                },
                                                {
                                                    "id": "N43",
                                                    "name": "Fanta",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                }
                                            ]
                                        }
                                    ]
                                },
                                {
                                    "id": "N32",
                                    "name": "Chowmein and Soda",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "type": "option",
                                    "children": [
                                        {
                                            "id": "N38",
                                            "name": "Choice of Soda",
                                            "description": null,
                                            "min_selection": "1",
                                            "max_selection": "1",
                                            "sel_dep": 0,
                                            "type": "option group",
                                            "children": [
                                                {
                                                    "id": "N44",
                                                    "name": "Pepsi",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                },
                                                {
                                                    "id": "N45",
                                                    "name": "Coke",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                },
                                                {
                                                    "id": "N46",
                                                    "name": "Sprite",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                },
                                                {
                                                    "id": "N47",
                                                    "name": "Fanta",
                                                    "description": null,
                                                    "price": null,
                                                    "max_price": null,
                                                    "type": "option",
                                                    "children": []
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "N48",
                    "name": "Item, Dozen Bagels",
                    "description": null,
                    "min_qty": "1.00",
                    "max_qty": "25.00",
                    "price": "5.99",
                    "max_price": "5.99",
                    "type": "item",
                    "children": [
                        {
                            "id": "N49",
                            "name": "Choose 12 Bagels",
                            "description": null,
                            "min_selection": "12",
                            "max_selection": "12",
                            "sel_dep": 1,
                            "type": "option group",
                            "children": [
                                {
                                    "id": "N50",
                                    "name": "Plain",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "min_qty": "0.00",
                                    "max_qty": "12.00",
                                    "increment": "1.00",
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N51",
                                    "name": "Salred",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "min_qty": "0.00",
                                    "max_qty": "12.00",
                                    "increment": "1.00",
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N52",
                                    "name": "Garlic",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "min_qty": "0.00",
                                    "max_qty": "12.00",
                                    "increment": "1.00",
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N53",
                                    "name": "Onion",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "min_qty": "0.00",
                                    "max_qty": "12.00",
                                    "increment": "1.00",
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N54",
                                    "name": "Everything",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "min_qty": "0.00",
                                    "max_qty": "12.00",
                                    "increment": "1.00",
                                    "type": "option",
                                    "children": []
                                },
                                {
                                    "id": "N55",
                                    "name": "Poppy",
                                    "description": null,
                                    "price": null,
                                    "max_price": null,
                                    "min_qty": "0.00",
                                    "max_qty": "12.00",
                                    "increment": "1.00",
                                    "type": "option",
                                    "children": []
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "N56",
                    "name": "Cream Cheese",
                    "description": null,
                    "min_qty": "0.25",
                    "max_qty": "25.00",
                    "price": "7.99",
                    "max_price": "7.99",
                    "increments": 0.25,
                    "qty_name_singular": "lb.",
                    "qty_name_plural": "lbs.",
                    "type": "item",
                    "children": []
                },
            ]
        }
    ]
}
Property Name Value Description
schedule Object[] Array of schedules. Schedules are used when certain menus/items are only available during certain time windows, like in the case of breakfast menu.
schedule.id Integer Id of this schedule. Menus/Items will reference schedules using this id.
schedule.times Object[] The time ranges for the schedule over the next 7 days. Times are in UTC.
warnings Object[] Some items require a disclaimer to be shown. There are two types, alcohol and tobacco. TODO: Get disclaimer text.
warnings.items String[] the item IDs that these warnings apply to.
menu Entity[] The array of menu entities.

Invalid Merchant Id

This is returned when an invalid merchant id is passed.
HTTP 400 Bad Request

Example

{
    "message": [
        { "code" : "no_rest",     "user_msg" : "Sorry, we weren't able to find the merchant." },
    ]
}

Item Request

Used to request a single item.

HTTP Request

GET /merchant/{merchant_id}/menu/{item_id}

Parameter Name Value Description
Required Parameters
merchant_id Integer The id of the merchant from the Search endpoint.
item_id String The item id which starts with ‘N’.

Request Body

Do not supply a request body with this method.

Responses

Success

HTTP 200 OK

Example

{
    "schedule": [],
    "warnings": [],
    "item": [
        {
            "id": "N2668",
            "name": "Apple Juice",
            "description": "",
            "min_qty": 1,
            "max_qty": 25,
            "price": 3.95,
            "max_price": 3.95,
            "increment": 1,
            "type": "item",
            "children": []
        }
    ]
}
Property Name Value Description
schedule Object[] Array of schedules. Schedules are used when certain menus/items are only available during certain time windows, like in the case of breakfast menu.
schedule.id Integer Id of this schedule. Menus/Items will reference schedules using this id.
schedule.times Object[] The time ranges for the schedule over the next 7 days. Times are in UTC.
warnings Object[] Some items require a disclaimer to be shown. There are two types, alcohol and tobacco. TODO: Get disclaimer text.
item Entity[] An single object array that contains an item entity.

Invalid Item Id

This is returned when an invalid item id is passed.
HTTP 400 Bad Request

Example

{
    "message": [
        {
            "code": "no_item",
            "user_msg": "Item not found.",
            "dev_msg": "Item not found."
        }
    ]
}