Chowly Third Party Online Ordering Service API (2.0.0)

Download OpenAPI specification:Download

Chowly Engineering Team: [email protected]

The Chowly TOOS API (v2) has been built around the principles of efficiency and ease of use. Methods include the vast majority of actions directly related to the Chowly platform’s core functionalities, such as creating and viewing orders, accessing menu items and modifiers, and more.

Orders

Inbound Orders

Chowly Inc.

Create Order

Creates a new order. Required fields will differ based on service_type. These will be specifically called out.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required	object
required	object
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"customer": {"id": "078eb998-3b05-4ae3-8b5c-9063124338cd",
"name": "Jane J. Doe",
"phone": "5555555555",
"email": "[email protected]",
"address1": "1234 S Main Street",
"address2": "Suite 180",
"city": "New York",
"state": "NY",
"zip": "10001",
"cross_street": "Rodeo Drive",
"special_instructions": "Doorman will let you up."
},
"info": {"id": "4f20a834-d67b-4c76-bb04-2d79fb4c71f7",
"include_utensils": true,
"scheduled_time": "2021-01-01T12:00:00Z",
"pickup_code": "AZ45jd9pQckJf078",
"service_type": "Delivery",
"payment_is_cash": false,
"payment_type": "credit",
"tip_payment_is_cash": true,
"tip_payment_type": "cash",
"subtotal": "28.75",
"delivery_charge": "3.75",
"sales_tax": "2.87",
"tip": "4.59",
"total": "38.21",
"coupon_description": "New York Restaurant Coupons - neighborhood discount",
"coupon_amount": "1.75"
},
"items": [{"id": "586240980",
"name": "Large - Brooklyn Style Pizza",
"external_id": "A8271710",
"price": "26.42",
"quantity": "1",
"notes": "Please do not include the default Ranch dip.",
"mods": [{"id": "bc06e801-17f5-4350-a914-6a10bc0192f1",
"name": "Pepperoni - Slices",
"category": "Toppings - MEATS",
"external_id": "A8271711",
"price": "2.33",
"quantity": "1",
"mods": [{ }
]
}
]
}
]
}

Response samples

Content type

application/json

{"customer": {"id": "078eb998-3b05-4ae3-8b5c-9063124338cd",
"name": "Jane J. Doe",
"phone": "5555555555",
"email": "[email protected]",
"address1": "1234 S Main Street",
"address2": "Suite 180",
"city": "New York",
"state": "NY",
"zip": "10001",
"cross_street": "Rodeo Drive",
"special_instructions": "Doorman will let you up."
},
"info": {"id": "4f20a834-d67b-4c76-bb04-2d79fb4c71f7",
"include_utensils": true,
"scheduled_time": "2021-01-01T12:00:00Z",
"pickup_code": "AZ45jd9pQckJf078",
"service_type": "Delivery",
"payment_is_cash": false,
"payment_type": "credit",
"tip_payment_is_cash": true,
"tip_payment_type": "cash",
"subtotal": "28.75",
"delivery_charge": "3.75",
"sales_tax": "2.87",
"tip": "4.59",
"total": "38.21",
"coupon_description": "New York Restaurant Coupons - neighborhood discount",
"coupon_amount": "1.75"
},
"items": [{"id": "586240980",
"name": "Large - Brooklyn Style Pizza",
"external_id": "A8271710",
"price": "26.42",
"quantity": "1",
"notes": "Please do not include the default Ranch dip.",
"mods": [{"id": "bc06e801-17f5-4350-a914-6a10bc0192f1",
"name": "Pepperoni - Slices",
"category": "Toppings - MEATS",
"external_id": "A8271711",
"price": "2.33",
"quantity": "1",
"mods": [{ }
]
}
]
}
],
"id": "078eb998-3b05-4ae3-8b5c-9063124338cd"
}

Fetch an Order

Retrieve details about a specific order. The unique identifier associated with the Order must be passed in as a parameter: id: '6D5E8CA3-33C9-4C2B-9481-10CF8B360A61'

Authorizations:

ApiKeyAuth

path Parameters

required

string^[A-Z0-9\-]+$

Unique identifier associated with the Order that was provided in the previous /orders response.

Responses

Response samples

Content type

application/json

{"order": {"id": "6D5E8CA3-33C9-4C2B-9481-10CF8B360A61",
"payload": "string",
"external_id": "be08e7b8-efe4-4fd1-b99e-e5831ac0717f",
"created_at": "2019-01-01T12:00:00Z",
"completed_at": "2019-01-01T12:00:00Z",
"error_at": "2019-01-01T12:00:00Z",
"error_string": "string",
"ticket_payload": "string"
}
}

Menus

Third Party Menu Feed

Get Menu

Pull a feed of the standard 3rd party menu

Authorizations:

ApiKeyAuth

Responses

Response samples

Content type

application/json

{"sections": [{"section_id": "9b143f99-ce2f-482c-b7ab-d983d530ca33",
"title": "Menu",
"subtitle": "10:30 AM – 10:00 PM",
"service_availability": [{"enabled": true,
"day_of_week": "sunday",
"time_periods": [{"start_time": "10:30",
"end_time": "22:00"
}
]
},
{"enabled": false,
"day_of_week": "monday",
"time_periods": [{"start_time": "10:30",
"end_time": "22:00"
}
]
},
{"enabled": true,
"day_of_week": "tuesday",
"time_periods": [{"start_time": "10:30",
"end_time": "22:00"
}
]
},
{"enabled": true,
"day_of_week": "wednesday",
"time_periods": [{"start_time": "10:30",
"end_time": "22:00"
}
]
},
{"enabled": true,
"day_of_week": "thursday",
"time_periods": [{"start_time": "10:30",
"end_time": "22:00"
}
]
},
{"enabled": true,
"day_of_week": "friday",
"time_periods": [{"start_time": "10:30",
"end_time": "22:00"
}
]
},
{"enabled": true,
"day_of_week": "saturday",
"time_periods": [{"start_time": "10:30",
"end_time": "22:00"
}
]
}
],
"subsections": [{"subsection_id": "d813a3be-3e63-485e-ba03-e8e22bfb602f",
"title": "Most Popular",
"items": [{"title": "1 Order Wings",
"disable_instructions": true,
"price": 9.99,
"image_url": "https://d1ralsognjng37.cloudfront.net/bcfba6cc-b59d-4799-b890-6f60d7055273",
"currency_code": "USD",
"item_id": "f238bb98-1a51-4744-b7c5-209a72340c81",
"tax_rate": 7.8,
"external_id": "f238bb98-1a51-4744-b7c5-209a72340c81",
"item_description": "10 wings. Served the order with a side of carrots and ranch.",
"is_alcohol": false,
"suspend_until": 1613973659,
"customizations": [{"title": "Boneless or Bone-In",
"customization_id": "27ee9e7d-d421-5ead-a41e-496ac0f798dc",
"max_permitted": 1,
"min_permitted": 0,
"supports_quantity_modifiers": false,
"customization_options": [{"title": "Boneless",
"price": 0,
"external_id": "95a0624a-0053-4b0e-9e7c-c2c51beab0d4",
"customization_option_id": "95a0624a-0053-4b0e-9e7c-c2c51beab0d4",
"suspend_until": null,
"customizations": [{"title": "Boneless Sauces",
"customization_id": "c1e49fdf-438f-4c5e-811e-0a8e35ab1a57",
"max_permitted": 1,
"min_permitted": 0,
"supports_quantity_modifiers": false,
"customization_options": [{"title": "BBQ",
"price": 0,
"external_id": "c21720a8-5b1e-4126-9b6b-f1b235904cd6",
"customization_option_id": "a81720a8-5b1e-4126-9b6b-f1b235904cd1",
"suspend_until": null,
"customizations": [{"title": "BBQ Sauces",
"customization_id": "a5f49fdf-438f-4c5e-811e-0a8e35ab1a57",
"max_permitted": 1,
"min_permitted": 0,
"supports_quantity_modifiers": false,
"customization_options": [{"title": "Spicy BBQ",
"price": 0,
"external_id": "f74330a8-3c1a-2125-3b6c-c1b235904aa5",
"customization_option_id": "a81720a8-5b1e-4126-9b6b-f1b235904cd2",
"suspend_until": null,
"customizations": [ ]
},
{"title": "Honey BBQ",
"price": 0,
"external_id": "j91720a8-5b1e-4111-3b6b-f1b235904fa6",
"customization_option_id": "a81720a8-5b1e-4126-9b6b-f1b235904cd6",
"suspend_until": null,
"customizations": [ ]
}
]
}
]
}
]
}
]
},
{"title": "Bone-In",
"price": 0,
"external_id": "7ca1821d-3c39-41c5-9f19-3cd627c3d22c",
"customization_option_id": "7ca1821d-3c39-41c5-9f19-3cd627c3d22c",
"suspend_until": null,
"customizations": [{"title": "Bone-In Sauces",
"customization_id": "320d1341-5637-4e4b-b6de-d25d28ead785",
"max_permitted": 1,
"min_permitted": 0,
"supports_quantity_modifiers": false,
"customization_options": [{"title": "Sweet Chili",
"price": 0,
"external_id": "465ef578-bde0-4091-9bed-4187c44ae455",
"customization_option_id": "465ef578-bde0-4091-9bed-4187c44ae455",
"suspend_until": null,
"customizations": [ ]
}
]
}
]
}
]
}
]
}
]
},
{"subsection_id": "3f8a1c22-9b4e-47d6-8a1f-2c5e7d904bb1",
"title": "Breakfast",
"items": [{"title": "Build Your Own Dozen Donuts",
"disable_instructions": false,
"price": 12.99,
"image_url": "https://d1ralsognjng37.cloudfront.net/9b4e47d6-8a1f-2c5e-7d90-4bb13f8a1c22",
"currency_code": "USD",
"item_id": "4a2b6d18-7c3e-49f1-b0a5-1e8d3c6f2a90",
"tax_rate": 7.8,
"external_id": "4a2b6d18-7c3e-49f1-b0a5-1e8d3c6f2a90",
"item_description": "Pick a dozen donuts in any mix of flavors.",
"is_alcohol": false,
"suspend_until": null,
"customizations": [{"title": "Donut Flavors",
"customization_id": "8c1d5e30-4a9b-4c2e-9f71-6b0a2d8e4c13",
"max_permitted": 12,
"min_permitted": 12,
"supports_quantity_modifiers": true,
"customization_options": [{"title": "Glazed",
"price": 0,
"external_id": "1a7f9c04-2b6d-4e83-9a15-7c0e3d5f8b21",
"customization_option_id": "1a7f9c04-2b6d-4e83-9a15-7c0e3d5f8b21",
"suspend_until": null,
"customizations": [ ]
},
{"title": "Chocolate",
"price": 0.5,
"external_id": "2b8a0d15-3c7e-4f94-8b26-6d1f4e6a9c32",
"customization_option_id": "2b8a0d15-3c7e-4f94-8b26-6d1f4e6a9c32",
"suspend_until": 1893456000,
"customizations": [ ]
},
{"title": "Cinnamon Sugar",
"price": 0.5,
"external_id": "3c9b1e26-4d8f-40a5-9c37-7e2a5f7b0d43",
"customization_option_id": "3c9b1e26-4d8f-40a5-9c37-7e2a5f7b0d43",
"suspend_until": null,
"customizations": [ ]
}
]
}
]
},
{"title": "Avocado Toast",
"disable_instructions": false,
"price": 8.5,
"image_url": "https://d1ralsognjng37.cloudfront.net/7c3e49f1-b0a5-1e8d-3c6f-2a904a2b6d18",
"currency_code": "USD",
"item_id": "5b3c7e29-8d4f-40a2-b1c6-2f9e4d7a3b81",
"tax_rate": 7.8,
"external_id": "5b3c7e29-8d4f-40a2-b1c6-2f9e4d7a3b81",
"item_description": "Sourdough toast with smashed avocado.",
"is_alcohol": false,
"suspend_until": 1893456000,
"customizations": [{"title": "Add an Egg",
"customization_id": "9d2e6f41-5b0c-4d3a-8e72-1a7c4b9d6e05",
"max_permitted": 2,
"min_permitted": 0,
"supports_quantity_modifiers": false,
"customization_options": [{"title": "Fried Egg",
"price": 1.5,
"external_id": "6c4d8f30-9e5a-41b3-b2d7-3a0f5e8b4c92",
"customization_option_id": "6c4d8f30-9e5a-41b3-b2d7-3a0f5e8b4c92",
"suspend_until": null,
"customizations": [ ]
},
{"title": "Poached Egg",
"price": 1.5,
"external_id": "7d5e9a41-0f6b-42c4-d3e8-4b1a6f9c5d03",
"customization_option_id": "7d5e9a41-0f6b-42c4-d3e8-4b1a6f9c5d03",
"suspend_until": null,
"customizations": [ ]
}
]
}
]
}
]
}
]
}
]
}

Webhooks

A single universal/static webhook for all locations is required. The webhook needs to contain all required authentication within the URL; we do not have a way to account for additional validation steps.

The webhook must be set up to receive post requests from the Chowly system. This webhook must handle both order and menu events.

Ensure that the webhook is responding to the order confirmation events with a 200. If this is not received, the order will not be processed.

Order Confirmation Webhook

Authorizations:

XSignature

Request Body schema: application/json

This webhook is triggered when an order is integrated into the POS.

order_id	string The Order ID sent by the API user, returned in the info level of the create order API call.
chowly_order_id	string The Order ID assigned to this order by Chowly, returned in the top level of the create order API call.
estimate	number The estimated prep time for the order.

Responses

Request samples

Payload

Content type

application/json

{"order_id": "TEST-ORDER-ABD12",
"chowly_order_id": "B8888021-D5A6-4F9D-8966-D7C0836FC3A3",
"estimate": 15
}

Order Error Webhook

Authorizations:

XSignature

Request Body schema: application/json

This webhook is triggered when there is an error integrating an order to the POS.

event	string Value: "order_issue"
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"event": "order_issue",
"payload": {"entity_id": "TEST-ORDER-ABH29381",
"chowly_order_id": "C54A0E4A-3EFA-40A5-9CB1-5C5110485DAB",
"error_message": "The restaurant is currently not accepting orders."
},
"meta": {"version": "2"
}
}

Menu Updated Webhook

Authorizations:

XSignature

Request Body schema: application/json

This webhook is triggered when the menu has been updated on Chowly. You must re-ingest the menu from the Get Menu endpoint when you get this to prevent order errors.

event	string Value: "menu_updated"
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"event": "menu_updated",
"payload": {"api_key": "ab292hyqa"
},
"meta": {"version": "2"
}
}

Location Status Updated Webhook

Authorizations:

XSignature

Request Body schema: application/json

This webhook is triggered when a location is paused or unpaused. Use the is_open field to determine the current status of the location and update your system accordingly.

event	string Value: "location_status_updated"
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"event": "location_status_updated",
"payload": {"api_key": "ab292hyqa",
"is_open": true
},
"meta": {"version": "2"
}
}