Carts
The carting API allows you to create and manage carts and their contents from initial item selection through checkout. These endpoints are central to any ordering process, so will play a large role in your implementation.
Paths
Create a cart
POST /cartsDescription
Creates a new cart.
Body
affiliate
Optional
Affiliate
The affiliate program to which this cart affects. You'll need to include you information here for tracking purposes.
when_for
Optional
DateTime
If your implementation has access to future ordering functionality, use this to specify when the diner wants the order fulfilled. This time must be within the operating hours of the restaurant, accounting for the time it takes to prepare and fulfill the order. The time must follow this format - "{YYYY}-{MM}-{DD}T{HH}:{MM}:{SS}.000Z".
Responses
Example
{
"id": "Lbr1EIaxEeeIgUXKh-lZqg",
"uri": "/carts/Lbr1EIaxEeeIgUXKh-lZqg",
"already_exists": false
}
Return scheduled carts.
GET /cartsDescription
Returns the contents of all currently scheduled carts for this diner.
Responses
Example
{
"carts": {
"ysChEDdgEeiivC2tWSVyNQ": {
"id": "ysChEDdgEeiivC2tWSVyNQ",
"diner_id": "mBVZAH0kEee5ZUE5jKZbTA",
"group_id": "ysChETdgEeiivC2tWSVyNQ",
"when_for": "2018-04-03T17:02:34.066Z",
"currency": "USD",
"fulfillment_info": null,
"notification_preferences": null,
"charges": null,
"payments": null,
"restaurant_ids": [],
"restaurants": [],
"affiliate": null,
"time_placed": null,
"recommended_tip_settings": {
"minimum_tip_amount": 0,
"minimum_tip_percentage": 0
},
"catering_info": null,
"edit_window_close": null,
"ordering_info": {
"type": "STANDARD",
"tiers": [],
"eta": "2018-04-03T17:02:34.066Z"
},
"state": "ACTIVE",
"status": "ACTIVE",
"asap": true
}
}
}
Return information about a specific cart.
GET /carts/{cart_id}Description
Returns the full details about a single cart.
Path Parameters
cart_id
Required
UUID
The ID of the cart to retrieve.
Responses
Example
{
"id": "ysChEDdgEeiivC2tWSVyNQ",
"diner_id": "mBVZAH0kEee5ZUE5jKZbTA",
"group_id": "ysChETdgEeiivC2tWSVyNQ",
"when_for": "2018-04-03T17:07:40.433Z",
"currency": "USD",
"fulfillment_info": null,
"notification_preferences": null,
"charges": {
"lines": {
"diner_total": 500,
"line_items": [
{
"id": "YW_DcDdhEeitZkUjEeNP-A",
"menu_item_id": "15609481",
"name": "Hamburger",
"price": 500,
"display_price": null,
"quantity": 1,
"diner_total": 500,
"options": [],
"special_instructions": null,
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null
}
]
},
"coupons": [],
"diner_subtotal": 500,
"fees": null,
"taxes": {
"total": 50,
"sales": 50,
"delivery": 0,
"minimum_based_delivery": 0
},
"tip": {
"amount": 0,
"type": "INCLUDE_IN_BILL"
},
"diner_grand_total": null,
"adjustments": null,
"add_ons": null
},
"payments": null,
"restaurant_ids": [
"11402556"
],
"restaurants": [
{
"id": "11402556",
"name": "Design Kitchen Too",
"badges": []
}
],
"affiliate": null,
"time_placed": null,
"recommended_tip_settings": {
"minimum_tip_amount": 200,
"minimum_tip_percentage": 40
},
"catering_info": null,
"edit_window_close": null,
"ordering_info": {
"type": "STANDARD",
"tiers": [],
"eta": "2018-04-03T17:07:40.433Z"
},
"state": "ACTIVE",
"status": "ACTIVE",
"asap": true
}
With enhanced menu items:
{
"id":"g7OQgLxXEei6tT_CLEe6lw",
"diner_id":"mBVZAH0kEee5ZUE5jKZbTA",
"group_id":"g7OQgbxXEei6tT_CLEe6lw",
"when_for":"2018-09-19T22:15:35.193Z",
"currency":"USD",
"fulfillment_info":{
"type":"PICKUP",
"delivery_info":null,
"pickup_info":{
"name":"Fake User",
"phone":"(212) 555-1212",
"email":"fakeuser@mail.com",
"pickup_instructions":null,
"green_indicated":false
},
"incomplete_delivery":null,
"incomplete_pickup":null,
"individual_info":null
},
"notification_preferences":null,
"charges":{
"lines":{
"diner_total":695,
"line_items":[
{
"id":"2oaVsLxXEei7_6HPEQFDLw",
"menu_item_id":"29343955",
"name":"Combo 6: 2 Chulupas Supreme",
"price":695,
"display_price":null,
"quantity":1,
"diner_total":695,
"options":[
{
"id":"69695475",
"name":"Chulupa Supreme 1",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695433",
"name":"Seasoned Beef",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695431",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695427",
"name":"Tomatoes",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695428",
"name":"Romain Lettuce",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695483",
"name":"Reduced Fat Sour Cream",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695479",
"name":"3 Cheese Blend",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
}
]
},
{
"id":"69695476",
"name":"Chulupa Supreme 2",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695433",
"name":"Seasoned Beef",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695431",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695427",
"name":"Tomatoes",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695428",
"name":"Romain Lettuce",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695483",
"name":"Reduced Fat Sour Cream",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695479",
"name":"3 Cheese Blend",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
}
]
},
{
"id":"69695487",
"name":"Crunchy Taco",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695424",
"name":"Seasoned Beef",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695431",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695425",
"name":"Lettuce",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
},
{
"id":"69695426",
"name":"Cheese",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695489",
"name":"Regular",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
}
]
},
{
"id":"69695491",
"name":"Drink",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695422",
"name":"Pepsi",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
{
"id":"69695482",
"name":"Large",
"price":0,
"quantity":1,
"sub_options":null,
"child_options":[
]
}
]
}
]
}
],
"special_instructions":"None",
"restaurant_id":"12267581",
"badges":[
],
"item_coupon":false,
"combinable_with_coupons":true,
"adjustments":null,
"minimum_serving_size":null,
"maximum_serving_size":null,
"lead_time_ms":null,
"minimum_order_quantity":null
}
]
},
"coupons":[
],
"diner_subtotal":695,
"fees":{
"total":0,
"delivery":0,
"service":0,
"fee_items":[
]
},
"donations":null,
"taxes":{
"total":70,
"delivery":0,
"sales":70,
"service":0,
"fee_tax_items":[
]
},
"tip":{
"amount":0,
"type":"INCLUDE_IN_BILL"
},
"diner_grand_total":765,
"adjustments":null,
"add_ons":null
},
"payments":null,
"restaurant_ids":[
"12267581"
],
"restaurants":[
{
"id":"12267581",
"name":"Nabil Test Resto",
"badges":[
]
}
],
"affiliate":null,
"time_placed":null,
"recommended_tip_settings":{
"minimum_tip_amount":0,
"minimum_tip_percentage":0.0
},
"catering_info":null,
"edit_window_close":null,
"ordering_info":{
"type":"STANDARD",
"tiers":[
],
"eta":"2018-09-19T22:15:35.193Z"
},
"action_messages":{
},
"update_metadata":null,
"adjustments":null,
"action_messages_metadata":{
"chain_small_order_fee":null,
"free_menu_item":null
},
"state":"ACTIVE",
"status":"ACTIVE",
"asap":true
}
Update fulfillment time for a cart
POST /carts/{cart_id}Description
Updates a cart with a new fulfillment time, marking it either as a future order or ASAP.
Path Parameters
cart_id
Required
UUID
The ID of the cart to retrieve.
Body
when_for
Optional
DateTime
If your implementation has access to future ordering functionality, use this to specify when the diner wants the order fulfilled. This time must be within the operating hours of the restaurant, accounting for the time it takes to prepare and fulfill the order.
Responses
204
UNKNOWN
No content
Cancel a cart.
DELETE /carts/{cart_id}Description
Removes an in-progress cart or cancels a scheduled order as well as all related ordering information from the system.
This endpoint has a longer timeout than most endpoints: 1500 ms.
Path Parameters
cart_id
Required
UUID
The ID of the cart to delete.
Responses
204
UNKNOWN
No Content
Add a line to a cart.
POST /carts/{cart_id}/linesDescription
Adds a menu item to a cart as a new line, complete with all the necessary choices.
Path Parameters
cart_id
Required
UUID
The ID of the cart to add a menu item to.
Body
restaurant_id
Required
UUID
The ID of the restaurant who offers the menu item that this diner wants to add to the cart.
menu_item_id
Required
String
The ID of the menu item to add to the cart.
quantity
Required
Integer
The number of menu items with these choices to add to the cart.
special_instructions
Optional
String
Diner-provided instructions on how to prepare this menu item.
Responses
Example
{
"id": "YW_DcDdhEeitZkUjEeNP-A",
"uri": "/carts/ysChEDdgEeiivC2tWSVyNQ/lines/YW_DcDdhEeitZkUjEeNP-A",
"already_exists": false
}
Get a line from the cart.
GET /carts/{cart_id}/lines/{id}Description
Returns the full details about a the menu item added as the specified line within the specified cart.
Path Parameters
cart_id
Required
UUID
The ID of the cart to return the line information for.
id
Required
UUID
The ID of the line item for which to return information.
Responses
Example
{
"id": "YW_DcDdhEeitZkUjEeNP-A",
"menu_item_id": "15609481",
"name": "Hamburger",
"price": 500,
"display_price": null,
"quantity": 1,
"diner_total": 500,
"options": [],
"special_instructions": null,
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null
}
Removes a line from the cart.
DELETE /carts/{cart_id}/lines/{id}Description
Removes all of a single menu item from a cart, including the choices made.
Path Parameters
cart_id
Required
UUID
The ID of the cart from which to delete the line.
id
Required
UUID
The ID of the line item to delete.
Responses
204
UNKNOWN
No Content
Update a line in a cart.
PUT /carts/{cart_id}/lines/{id}Description
Updates a line in a cart using the same parameters as in creating the line.
Path Parameters
cart_id
Required
UUID
The ID of the cart to update a menu item.
id
Required
UUID
The ID of the line item to update.
Body
restaurant_id
Required
UUID
The ID of the restaurant who offers the updated menu item.
menu_item_id
Required
String
The ID of the menu item to update in the cart.
options
Optional
Updated selections for the options associated with this menu item.
quantity
Required
Integer
The updated number of menu items for this line.
special_instructions
Optional
String
Updated diner-provided instructions on how to prepare this menu item.
Responses
204
UNKNOWN
No Content
Add tip information.
POST /carts/{cart_id}/tipDescription
Add information about the tip amount and type to the cart.
Path Parameters
cart_id
Required
UUID
The ID of the cart to add tip information to.
Body
amount
Required
Integer
The amount (in cents) of tip to add to the order.
type
Required
String
How the tip amount will be collected. Must be either "INCLUDE_IN_BILL" or "CASH".
Responses
204
UNKNOWN
No Content
Add incomplete pickup information.
PUT /carts/{cart_id}/incomplete_pickupDescription
Allows workflows that may not have all the pickup info to mark a cart for pickup.
Path Parameters
cart_id
Required
UUID
The ID of the cart to mark as a pickup order.
Responses
204
UNKNOWN
No Content
Add incomplete delivery information.
PUT /carts/{cart_id}/incomplete_deliveryDescription
Allows workflows that may not have all the pickup info to mark a cart for delivery.
Path Parameters
cart_id
Required
UUID
The ID of the cart to mark as a delivery order.
Body
latitude
Required
String
The latitude coordinate of the delivery address.
longitude
Required
String
The longitude coordinate of the delivery address.
Responses
204
UNKNOWN
No Content
Add delivery information.
PUT /carts/{cart_id}/delivery_infoDescription
Mark a cart for delivery and provide information on the delivery location and recipient. You will need to geocode the address to get the precise latitude and longitude information. The address that you pass here is for the driver only; we do not validate that it matches the coordinates given.
Path Parameters
cart_id
Required
UUID
The ID of the cart to mark as a delivery order.
Body
street_address1
Required
String
The street address and number of the delivery address.
cross_streets
Optional
String
The nearest cross street or streets to the street address.
street_address2
Optional
String
The unit or apartment information associated with the delivery address.
address_locality
Required
String
The city, town, or other locality in which the delivery address is located.
address_region
Required
String
The state, territory, or other region in which the delivery address is located.
postal_code
Required
String
The ZIP Code or Postcode of the delivery address.
delivery_instructions
Optional
String
Diner-provided delivery instructions.
name
Required
String
The name of the diner receiving the delivery.
phone
Required
String
The phone number of the diner receiving the delivery.
email
Required
String
The email address of the diner who ordered delivery.
address_country
Required
String
The country in which the delivery address is located.
green_indicated
Optional
boolean
Whether the diner has indicated that they want to forgo plastic utensils.
latitude
Required
String
The latitude coordinate of the delivery address.
longitude
Required
String
The longitude coordinate of the delivery address.
Responses
204
UNKNOWN
No Content
Add pickup information.
PUT /carts/{cart_id}/pickup_infoDescription
Mark a cart for pickup and provide information about the delivery recipient.
Path Parameters
cart_id
Required
UUID
The ID of the cart to mark as a pickup order.
Body
pickup_instructions
Optional
String
Diner-provided pickup instructions.
name
Required
String
The name of the diner picking up the order.
phone
Required
String
The phone number of the diner picking up the order.
email
Required
String
The email address of the diner who ordered pickup.
green_indicated
Optional
boolean
Whether the diner has indicated that they want to forgo plastic utensils.
Responses
204
UNKNOWN
No Content
Configure notification channels.
POST /carts/{id}/notification_preferencesDescription
Set the notification channels by which the diner will be informed of the status of their order. If you want to set up custom notifications, set the channels.WEBHOOK.destinations value in the body to the webhook URI that will process the notification payload.
Body
id
Required
UUID
The cart to which to assign notification preferences. This will override the diner's existing preferences. If you specify the `WEBHOOK` channel, then this request will POST a [WebhookPayload](https://grubhub-developers.zendesk.com/hc/en-us/articles/115004586823-Carts#_definitions_WebhookPayload) to the URI specified as the destination. See [Using Webhook Notifications](https://grubhub-developers.zendesk.com/hc/en-us/articles/115004972463-Setting-Custom-Notifications) for more information.
You can disable all notifications by specifying `"DISABLED: []`; that is, a DISABLED channel with an empty array.
channels
Required
The channel(s) by which the diner will notified of their order status.
Responses
Add a payment to a cart.
POST /carts/{cart_id}/paymentsDescription
Adds a previously vaulted or granted payment method to the specified cart.
Path Parameters
cart_id
Required
UUID
The cart to which to attach a payment method. A single cart can have multiple payment methods.
Body
payment_id
Required
String
The ID associated with the payment, returned from `/payments/partner_payment`.
type
Required
String
The type of payment being added to the cart. Currently, we accept "CREDIT_CARD", "PAYPAL_EXPRESS", "AMEX_EXPRESS", "CASH", and "PROMO_CODE".
amount
Optional
Integer
The amount of the bill that this payment method should cover. If not included in the request, then the given payment will cover the remainder of the cart bill or, in the case of a promo code, the remainder of the code amount.
Responses
Example
{
"id": "J1xnxaPdTKyysKo9mxziqQ",
"uri": "/payments/mBVZAH0kEee5ZUE5jKZbTA/credit_card/J1xnxaPdTKyysKo9mxziqQ",
"already_exists": false
}
Get a cart payment
GET /carts/{cart_id}/payments/{id}Description
Returns information about the specified payment attached to this cart.
Path Parameters
cart_id
Required
UUID
The cart to which to return information on a payment.
id
Required
String
The payment ID to return information on.
Responses
Example
{
"id": "J1xnxaPdTKyysKo9mxziqQ",
"diner_id": "mBVZAH0kEee5ZUE5jKZbTA",
"credit_card_type": "Visa",
"credit_card_last4": "1881",
"payment_name": null,
"expiration_date": 1580515200000,
"expiration_month": 1,
"expiration_year": 2020,
"create_date": null,
"last_used_date": null,
"expired": false,
"nonce": null
}
Remove a payment
DELETE /carts/{cart_id}/payments/{id}Description
Removes a payment method from a cart.
Path Parameters
cart_id
Required
UUID
The cart from which to delete a payment method.
id
Required
String
The identifier of the payment to remove.
Responses
204
UNKNOWN
No Content
Update a payment
PUT /carts/{cart_id}/payments/{id}Description
Updates the amount covered by the specified payment attached to this cart.
Path Parameters
cart_id
Required
UUID
The cart in which to update the payment amount.
id
Required
String
The identifier of the payment to update.
Body
amount
Optional
Integer
The amount of the bill to cover with this payment. Leave this field out of the request to have the payment cover the remainder of the bill.
Responses
204
UNKNOWN
No Content
Retrieve the bill.
GET /carts/{cart_id}/billDescription
Checks if the cart is ready for checkout; if so, it returns the cart bill and a checkout token.
Path Parameters
cart_id
Required
UUID
The ID of the cart for which to retrieve the bill.
Responses
Example
{
"id": "ysChEDdgEeiivC2tWSVyNQ",
"diner_id": "mBVZAH0kEee5ZUE5jKZbTA",
"group_id": "ysChETdgEeiivC2tWSVyNQ",
"when_for": "2018-04-03T20:42:16.270Z",
"currency": "USD",
"fulfillment_info": {
"type": "DELIVERY",
"delivery_info": {
"street_address1": "600 Van Raalte Ave",
"cross_streets": "W 27th St.",
"street_address2": null,
"address_locality": "Holland",
"address_region": "MI",
"postal_code": "49423",
"delivery_instructions": "Knock thrice before entering.",
"name": "John Smith",
"phone": "2025551212",
"email": "jsmith@example.com",
"address_country": "USA",
"green_indicated": true,
"latitude": "42.773905",
"longitude": "-86.121708"
},
"pickup_info": null,
"incomplete_delivery": null,
"incomplete_pickup": null,
"individual_info": null
},
"notification_preferences": null,
"charges": {
"lines": {
"diner_total": 3000,
"line_items": [
{
"id": "YW_DcDdhEeitZkUjEeNP-A",
"menu_item_id": "15609481",
"name": "Hamburger",
"price": 500,
"display_price": null,
"quantity": 1,
"diner_total": 500,
"options": [],
"special_instructions": null,
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null
},
{
"id": "SqJdoDd7EeiHLSeLAVON5A",
"menu_item_id": "15609481",
"name": "Hamburger",
"price": 500,
"display_price": null,
"quantity": 5,
"diner_total": 2500,
"options": [],
"special_instructions": null,
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null
}
]
},
"coupons": [],
"diner_subtotal": 3000,
"fees": {
"total": 1500,
"delivery": 1500,
"minimum_based_delivery": 0
},
"taxes": {
"total": 450,
"sales": 300,
"delivery": 150,
"minimum_based_delivery": 0
},
"tip": {
"amount": 0,
"type": "INCLUDE_IN_BILL"
},
"diner_grand_total": 4950,
"adjustments": null,
"add_ons": null
},
"payments": {
"CREDIT_CARD": [
{
"id": "32ffa540-377b-11e8-81f6-d314f95ff2e4",
"payment_id": "J1xnxaPdTKyysKo9mxziqQ",
"amount": 4950,
"metadata": {}
}
]
},
"restaurant_ids": [
"11402556"
],
"restaurants": [
{
"id": "11402556",
"name": "Design Kitchen Too",
"badges": []
}
],
"affiliate": null,
"time_placed": null,
"recommended_tip_settings": {
"minimum_tip_amount": 300,
"minimum_tip_percentage": 10
},
"catering_info": null,
"edit_window_close": null,
"ordering_info": {
"type": "STANDARD",
"tiers": [],
"eta": "2018-04-03T20:42:16.270Z"
},
"available_payment_types": [
"ANDROID_PAY",
"APPLE_PAY",
"AMEX_EXPRESS",
"VENMO_PAY",
"PAYPAL_EXPRESS",
"PROMO_CODE",
"GIFT_CARD"
],
"allowed_payment_types": [
{
"type": "ANDROID_PAY",
"detail_url": null
},
{
"type": "APPLE_PAY",
"detail_url": null
},
{
"type": "AMEX_EXPRESS",
"detail_url": null
},
{
"type": "VENMO_PAY",
"detail_url": null
},
{
"type": "PAYPAL_EXPRESS",
"detail_url": "/payments/mBVZAH0kEee5ZUE5jKZbTA/paypal_express"
},
{
"type": "PROMO_CODE",
"detail_url": null
},
{
"type": "GIFT_CARD",
"detail_url": "/codes/vault/mBVZAH0kEee5ZUE5jKZbTA/giftcards"
}
],
"balance": 0,
"state": "READY_FOR_CHECKOUT",
"checkout_token": "a0f374fbaed664d778d9f6b28d23590b",
"validation_errors": [],
"asap": true
}
Check out a cart.
POST /carts/{cart_id}/checkoutDescription
Check out a cart using the checkout_token produced by the /carts/{cart_id}/bill endpoint. This endpoint has a longer timeout than most endpoints: 12000 ms.
NOTE - The order will not be sent to the restaurant until this endpoint completes successfully. Do not display confirmation messages to diners until you get a 200 success response. Otherwise, you could introduce perceived delays to the diner, potentially triggering interactions with customer care.
Path Parameters
cart_id
Required
UUID
The ID of the cart to checkout.
Body
checkout_token
Required
String
The checkout_token produced by the /carts/{cart_id}/bill endpoint.
Responses
Example
{
"id": "ysChEDdgEeiivC2tWSVyNQ",
"diner_id": "mBVZAH0kEee5ZUE5jKZbTA",
"group_id": "ysChETdgEeiivC2tWSVyNQ",
"when_for": "2018-04-03T20:43:38.622Z",
"currency": "USD",
"fulfillment_info": {
"type": "DELIVERY",
"delivery_info": {
"street_address1": "600 Van Raalte Ave",
"cross_streets": "W 27th St.",
"street_address2": null,
"address_locality": "Holland",
"address_region": "MI",
"postal_code": "49423",
"delivery_instructions": "Knock thrice before entering.",
"name": "John Smith",
"phone": "2025551212",
"email": "jsmith@example.com",
"address_country": "USA",
"green_indicated": true,
"latitude": "42.773905",
"longitude": "-86.121708"
},
"pickup_info": null,
"incomplete_delivery": null,
"incomplete_pickup": null,
"individual_info": null
},
"notification_preferences": null,
"charges": {
"lines": {
"diner_total": 3000,
"line_items": [
{
"id": "YW_DcDdhEeitZkUjEeNP-A",
"menu_item_id": "15609481",
"name": "Hamburger",
"price": 500,
"display_price": null,
"quantity": 1,
"diner_total": 500,
"options": [],
"special_instructions": null,
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null
},
{
"id": "SqJdoDd7EeiHLSeLAVON5A",
"menu_item_id": "15609481",
"name": "Hamburger",
"price": 500,
"display_price": null,
"quantity": 5,
"diner_total": 2500,
"options": [],
"special_instructions": null,
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null
}
]
},
"coupons": [],
"diner_subtotal": 3000,
"fees": {
"total": 1500,
"delivery": 1500,
"minimum_based_delivery": 0
},
"taxes": {
"total": 450,
"sales": 300,
"delivery": 150,
"minimum_based_delivery": 0
},
"tip": {
"amount": 0,
"type": "INCLUDE_IN_BILL"
},
"diner_grand_total": 4950,
"adjustments": null,
"add_ons": null
},
"payments": {
"CREDIT_CARD": [
{
"id": "32ffa540-377b-11e8-81f6-d314f95ff2e4",
"payment_id": "J1xnxaPdTKyysKo9mxziqQ",
"amount": 4950,
"metadata": {
"EXPIRATION_DATE": "01/2020",
"PAYMENT_PROCESSOR": "braintree",
"BILLING_ZIP": "03101",
"CREDIT_CARD_TYPE": "Visa",
"CC_LAST_FOUR": "1881"
}
}
]
},
"restaurant_ids": [
"11402556"
],
"restaurants": [
{
"id": "11402556",
"name": "Design Kitchen Too",
"badges": []
}
],
"affiliate": null,
"time_placed": "2018-04-03T20:13:38.622Z",
"recommended_tip_settings": {
"minimum_tip_amount": 300,
"minimum_tip_percentage": 10
},
"catering_info": null,
"edit_window_close": null,
"ordering_info": {
"type": "STANDARD",
"tiers": [],
"eta": "2018-04-03T20:43:38.622Z"
},
"order_number": "955503845729801",
"order_tracking": {
"enabled": true
},
"asap": true
}
Get a cart after checkout.
GET /carts/{cart_id}/checkoutDescription
Returns cart information after it has been sent to checkout.
Path Parameters
cart_id
Required
UUID
The ID of the cart to view.
Responses
Example
{
"id": "ysChEDdgEeiivC2tWSVyNQ",
"diner_id": "mBVZAH0kEee5ZUE5jKZbTA",
"group_id": "ysChETdgEeiivC2tWSVyNQ",
"when_for": "2018-04-03T20:43:38.622Z",
"currency": "USD",
"fulfillment_info": {
"type": "DELIVERY",
"delivery_info": {
"street_address1": "600 Van Raalte Ave",
"cross_streets": "W 27th St.",
"street_address2": null,
"address_locality": "Holland",
"address_region": "MI",
"postal_code": "49423",
"delivery_instructions": "Knock thrice before entering.",
"name": "John Smith",
"phone": "2025551212",
"email": "jsmith@example.com",
"address_country": "USA",
"green_indicated": true,
"latitude": "42.773905",
"longitude": "-86.121708"
},
"pickup_info": null,
"incomplete_delivery": null,
"incomplete_pickup": null,
"individual_info": null
},
"notification_preferences": null,
"charges": {
"lines": {
"diner_total": 3000,
"line_items": [
{
"id": "YW_DcDdhEeitZkUjEeNP-A",
"menu_item_id": "15609481",
"name": "Hamburger",
"price": 500,
"display_price": null,
"quantity": 1,
"diner_total": 500,
"options": [],
"special_instructions": null,
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null
},
{
"id": "SqJdoDd7EeiHLSeLAVON5A",
"menu_item_id": "15609481",
"name": "Hamburger",
"price": 500,
"display_price": null,
"quantity": 5,
"diner_total": 2500,
"options": [],
"special_instructions": null,
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null
}
]
},
"coupons": [],
"diner_subtotal": 3000,
"fees": {
"total": 1500,
"delivery": 1500,
"minimum_based_delivery": 0
},
"taxes": {
"total": 450,
"sales": 300,
"delivery": 150,
"minimum_based_delivery": 0
},
"tip": {
"amount": 0,
"type": "INCLUDE_IN_BILL"
},
"diner_grand_total": 4950,
"adjustments": null,
"add_ons": null
},
"payments": {
"CREDIT_CARD": [
{
"id": "32ffa540-377b-11e8-81f6-d314f95ff2e4",
"payment_id": "J1xnxaPdTKyysKo9mxziqQ",
"amount": 4950,
"metadata": {
"EXPIRATION_DATE": "01/2020",
"PAYMENT_PROCESSOR": "braintree",
"BILLING_ZIP": "03101",
"CREDIT_CARD_TYPE": "Visa",
"CC_LAST_FOUR": "1881"
}
}
]
},
"restaurant_ids": [
"11402556"
],
"restaurants": [
{
"id": "11402556",
"name": "Design Kitchen Too",
"badges": []
}
],
"affiliate": null,
"time_placed": "2018-04-03T20:13:38.622Z",
"recommended_tip_settings": {
"minimum_tip_amount": 300,
"minimum_tip_percentage": 10
},
"catering_info": null,
"edit_window_close": null,
"ordering_info": {
"type": "STANDARD",
"tiers": [],
"eta": "2018-04-03T20:43:38.622Z"
},
"order_number": "955503845729801",
"order_tracking": {
"enabled": true
},
"asap": true
}
Recreate an existing order.
POST /carts/{order_id}/recartDescription
Create a new cart order out of a previously placed order.
Path Parameters
order_id
Required
UUID
The ID of the cart to place the contents of the old order.
Body
brand
Required
String
The brand under which this order should be processed.
affiliate
Optional
Affiliate
The affiliate program associated with this order.
fail_out_on_validation_error
Optional
boolean
Whether this request should fail to create the new cart if it fails to validate.
recart_flags
Optional
RecartFlag
Any flags to modify the new order.
Responses
Example
{
"id": "ZYTuosJrEeifaZN8ozx0dQ",
"diner_id": "mBVZAH0kEee5ZUE5jKZbTA",
"group_id": "ZYTuo8JrEeifaZN8ozx0dQ",
"when_for": "2018-09-27T16:10:35.535Z",
"currency": "USD",
"fulfillment_info": {
"type": "DELIVERY",
"delivery_info": {
"street_address1": "600 Van Raalte Ave",
"cross_streets": "W 27th St.",
"street_address2": null,
"address_locality": "Holland",
"address_region": "MI",
"postal_code": "49423",
"delivery_instructions": "Knock thrice before entering.",
"name": "Fake User",
"phone": "2025551212",
"email": "fakeuser@mail.com",
"address_country": "USA",
"green_indicated": true,
"latitude": "42.773905",
"longitude": "-86.121708"
},
"pickup_info": null,
"incomplete_delivery": null,
"incomplete_pickup": null,
"individual_info": null
},
"notification_preferences": null,
"charges": {
"lines": {
"diner_total": 3500,
"line_items": [
{
"id": "ZYTuoMJrEeifaZN8ozx0dQ",
"menu_item_id": "15609485",
"name": "James's Pizza",
"price": 0,
"display_price": null,
"quantity": 7,
"diner_total": 0,
"options": [],
"special_instructions": "",
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null,
"minimum_serving_size": null,
"maximum_serving_size": null,
"lead_time_ms": null,
"minimum_order_quantity": null
},
{
"id": "ZYTuocJrEeifaZN8ozx0dQ",
"menu_item_id": "15609424",
"name": "House salad",
"price": 500,
"display_price": null,
"quantity": 7,
"diner_total": 3500,
"options": [],
"special_instructions": "",
"restaurant_id": "11402556",
"badges": [],
"item_coupon": false,
"combinable_with_coupons": true,
"adjustments": null,
"minimum_serving_size": null,
"maximum_serving_size": null,
"lead_time_ms": null,
"minimum_order_quantity": null
}
]
},
"coupons": [],
"diner_subtotal": 3500,
"fees": {
"total": 300,
"delivery": 300,
"service": 0,
"fee_items": [
{
"calculated_amount": 300,
"group": "DELIVERY",
"type": "DELIVERY",
"id": null,
"name": "Delivery fee",
"adjustments": null
}
]
},
"donations": null,
"taxes": {
"total": 380,
"delivery": 30,
"sales": 350,
"service": 0,
"fee_tax_items": [
{
"calculated_amount": 30,
"fee_type": "DELIVERY"
}
]
},
"tip": {
"amount": 0,
"type": "INCLUDE_IN_BILL"
},
"diner_grand_total": 4180,
"adjustments": null,
"add_ons": null
},
"payments": null,
"restaurant_ids": [
"11402556"
],
"restaurants": [
{
"id": "11402556",
"name": "Design Kitchen Too",
"badges": []
}
],
"affiliate": null,
"time_placed": null,
"recommended_tip_settings": {
"minimum_tip_amount": 350,
"minimum_tip_percentage": 10
},
"catering_info": null,
"edit_window_close": null,
"ordering_info": {
"type": "STANDARD",
"tiers": [],
"eta": "2018-09-27T16:10:35.535Z"
},
"action_messages": {},
"update_metadata": null,
"adjustments": null,
"action_messages_metadata": {
"chain_small_order_fee": null,
"free_menu_item": null,
"free_menu_category": null
},
"validation_errors": null,
"asap": true
}
Edit a checked out cart.
POST /carts/{cart_id}/editDescription
Edits a cart that has been scheduled as a future order. Does not work for ASAP orders.
Path Parameters
cart_id
Required
UUID
The ID of the cart to re-open for editing.
Responses
Return an editable cart to a checked out state.
POST /carts/{cart_id}/revertDescription
Closes an editable cart and returns it to its checked out state.
Path Parameters
cart_id
Required
UUID
The ID of the cart to revert.
Responses
Models
ActionMessagesMetadata
Information that can be included in messages to diners, which indicate actions that they can take.
Properties
chain_small_order_fee
Optional
Information related to an additional fee charged because an order is below a certain threshold. This will be null if this restaurant does not charge a small order fee.
free_menu_item
Optional
Information about a menu item that the diner could add to their cart for free.
AddOn
Any additional add-on charges not covered by other charge fields. Currently, this only stores information about diner-initiated top-up payments, where the diner adds an amount to the cart in order to meet a restaurant minimum.
Properties
id
Optional
UUID
A universally unique identifier for this particular add on in this cart.
restaurant_id
Optional
String
The restaurant adding this to the cart. Not used for DONATE_THE_CHANGE.
type
Optional
String
The type on of add-on that this object represents. Currently, the only possible value for this is "DONATE_THE_CHANGE", which indicates that the diner rounded their cost up to the nearest dollar as a donation.
Adjustment
Information about how and why an order has been adjusted.
Properties
update_id
Optional
String
A unique identifier for the care update record where this adjustment was applied.
adjustment_id
Optional
String
A unique identifier for this adjustment.
association_id
Optional
String
If the adjustment changes a single line in the order, then this will be the line identifier. If it adjusts the order, then this will be NULL.
association_type
Optional
String
The type of adjustment, either "ORDER" or "LINE".
adjustment_amount
Optional
Integer
The value of the adjustment in cents.
adjustment_type
Optional
String
The method by which the adjustment amount should be applied to the value of the cart. Values can be:
- PERCENT - The amount is a percentage that applies to the entire care value.
- FIXED - The amount listed should be subtracted from the cart total.
- ABSOLUTE - The listed amount should replace the previous cart total.
adjustment_note
Optional
String
Information about why this order was adjusted, added by the Grubhub care team that made the adjustment.
AdjustmentItem
DEPRECATED. Use Adjustment instead.
Properties
id
Optional
UUID
A unique identifier for this adjustment throughout the Grubhub system.
amount
Optional
Integer
The amount, in cents, that this adjustment adds or removes from the cart total.
taxable
Optional
Integer
The amount of this adjustment that is taxable, which may be either added or subtracted from the cart charges, depending on the adjustment.
notes
Optional
String
Information about why this order was adjusted, added by the Grubhub care team that made the adjustment.
Affiliate
An affiliate program descriptor.
Properties
id
Required
String
The ID value of the affiliate program.
type
Required
String
The type of affiliate program.
AvailablePayment
The name and descriptor URI of a single payment type.
Properties
type
Optional
String
The type of payment.
detail_url
Optional
URI
The URI that lists the details of this payment method.
Badge
A badge associated with a restaurant and displayed in search.
Properties
badge_data
Optional
String
A JSON array as a string that describes what the badge applies to.
name
Optional
String
The internal name of the badge.
type
Optional
String
The internally defined type of badge.
Bill
Information about the bill associated with a cart and, if the cart is ready to checkout, a checkout_token.
Properties
available_payment_types
Optional
array
DEPRECATED. Refer to allowed_payment_types instead.
allowed_payment_types
Optional
An array of payment methods available to check this cart out.
balance
Optional
Integer
The total remaining amount to be paid on this cart order.
state
Optional
String
A label indicating where in the order process this cart is.
checkout_token
Optional
String
If the cart is ready to checkout, you can pass this value in the body of the /carts/{cart_id}/checkout request.
validation_errors
Optional
If the cart is not ready for checkout, this will contain information about why that is.
Cart
Information about a cart.
Properties
id
Optional
UUID
The ID of the cart.
diner_id
Optional
UUID
The ID of the diner associated with this cart.
group_id
Optional
UUID
The ID of the group to which this cart belongs.
when_for
Optional
DateTime
When this cart is scheduled to be fulfilled.
is_asap
Optional
boolean
Indicates whether this order is to be completed immediately after checkout.
currency
Optional
String
The three-letter code for the type of currency that will be used to pay for this cart.
fulfillment_info
Optional
Information about how to deliver or arrange pickup for this cart order.
notification_preferences
Optional
The notification preferences that the diner applied to this cart.
restaurant_ids
Optional
array
The IDs of the restaurants associated with the menu items in this cart.
time_placed
Optional
DateTime
The date and time on which the diner placed this order.
recommended_tip_settings
Optional
The recommended tip to apply as both an amount and a percentage of the total bill.
catering_info
Optional
Information as to how this order should be fulfilled if it is a catered event.
adjustments
Optional
The adjustments made by the Grubhub Care Team and how they affect individual cart charges and the total cost.
action_messages_metadata
Optional
Information related to messages for the diner that they can take action on.
has_ordering_info_tier
Optional
boolean
Whether or not the value of this cart qualifies it for longer preparation times listed in an ordering tier.
CartAdjustments
The adjustments made by the Grubhub Care Team and how they affect individual cart charges and the total cost.
Properties
total
Optional
Integer
The total value of the adjustments in cents.
adjustments
Optional
Detailed information about each adjustment applied to this charge item or total.
CartCharges
Details about the costs associated with this cart order.
Properties
lines
Optional
The total amount of the order, as well as a break down of each menu item line.
diner_subtotal
Optional
Integer
The total cost of all the food items in the cart before taxes and fees.
donations
Optional
Any donations applied to the cart total, such as Donate the Change.
diner_grand_total
Optional
Integer
The total amount of the bill for this order, including menu items, taxes, fees, and tip.
adjustments
Optional
The adjustments made by the Grubhub Care Team and how they affect individual cart charges and the total cost.
CartDonations
Information about charity donations, such as to Donate the Change, attached to this cart.
Properties
total
Optional
Integer
The total amount in cents of the donation charged to this cart.
CartFee
Complete information about a specific fee applied to a cart.
Properties
calculated_amount
Optional
Integer
The total amount of the fee. If the fee is percentage-based, this will be computed based on the cart subtotal.
group
Optional
String
The group identifer for the restaurant whose menu items are in this cart.
type
Optional
String
The specific type of fee contained in this object. This will be either 'DELIVERY', 'CHAIN_SERVICE_FEE', 'CHAIN_SMALL_ORDER_FEE', or 'MINIMUM_BASED_DELIVERY'.
id
Optional
String
An identifier for this specific fee.
name
Optional
String
A human-readable name for this fee.
adjustments
Optional
If adjustments have been made to the cart, then this object reflects the portion of that adjustment applicable to this fee.
CartFeeTax
Tax costs associated with a specific fee.
Properties
calculated_amount
Optional
Integer
The amount that this tax on a fee adds to the cart total.
fee_type
Optional
String
The specific type of fee that this tax amount is associated with. This will be either 'DELIVERY', 'CHAIN_SERVICE_FEE', or 'CHAIN_SMALL_ORDER_FEE'.
CartFees
Information about the delivery and other fees that apply to an order.
Properties
total
Optional
Integer
The total amount of fees to add to a cart, in cents.
delivery
Optional
Integer
The fee for delivery.
service
Optional
Integer
The service added in addition to delivery fees.
CartLine
Details about a single menu item line in a cart.
Properties
id
Optional
UUID
The ID for this line within a cart.
menu_item_id
Optional
String
The ID of the menu item added to this line item.
name
Optional
String
The name of the menu item on this line.
price
Optional
Integer
The price the diner is paying for this menu item in cents.
display_price
Optional
Integer
The price displayed for this menu item.
quantity
Optional
int
The total number of this menu item included in this cart.
diner_total
Optional
Integer
The total cost to the diner from this cart line.
special_instructions
Optional
String
Special instructions about this menu item's preparation as provided by the diner.
restaurant_id
Optional
String
The ID of the restaurant that will fulfill this menu item.
adjustments
Optional
The Grubhub-care initiated cost adjustments applied to this cart.
lead_time_ms
Optional
Long
The amount of additional time in milliseconds the restaurant needs to prepare this menu item for an order.
minimum_order_quantity
Optional
Integer
The minimum number of this menu item that a diner must add to their cart in order to checkout.
CartLineOption
The options that the diner selected for a menu item or another option.
Properties
id
Optional
String
The ID associated with this option.
name
Optional
String
The display name of the option.
price
Optional
Integer
The increase in price due to this option, in cents.
quantity
Optional
Integer
The number of menu items that have this particular option applied to them. This number will not exceed the quantity of items in the cart.
child_options
Optional
A list of diner-selectable sub-options for this option. Options can be nested in up to five levels in this way.
CartLineOptionData
Selections for the choices associated with a menu item being added to a cart.
Properties
id
Optional
String
The ID associated with the option being selected.
CartLines
The total amount of the order, as well as a break down of each menu item line.
Properties
diner_total
Optional
BigDecimal
The total charges associated with this cart order.
CartLookup
A mapping of carts by their UUID identifier.
Properties
cart_id
Optional
Information about this cart, including menu items, payment, and fulfillment information.
CartTaxes
Information about the taxes applied to a cart order.
Properties
total
Optional
Integer
The total taxes applied to a cart in cents.
sales
Optional
Integer
The amount of sales taxes applied to a cart in cents.
delivery
Optional
Integer
The taxes related to delivery applied to a cart.
service
Optional
Integer
The taxes applicable to any service charges on the cart.
CartWithValidationErrors
A re-carted order with validation errors.
Properties
validation_errors
Optional
Error messages that describe why this cart failed to validate.
CartsByDinerIdResponse
A map of open carts indexed by diner IDs. Returned by GET /paths/carts.
Properties
CateringInfo
Information on how to fulfill an order as a catered meal.
Properties
estimated_attendees
Optional
Integer
The number of people that the diner expects to attend the catering event.
budget
Optional
Integer
The total budget (in cents) allowed for the catered food.
alternate_name
Optional
Integer
An alternate contact name for the order.
alternate_phone
Optional
Integer
The alternate contact's phone number.
green_indicated
Optional
boolean
Whether the diner indicated they want to forgo plastic utensils.
setup_food
Optional
boolean
Whether the diner indicated that they want to have the food setup for them.
setup_instructions
Optional
String
Diner-provided instructions as to how to setup the catered food.
ChainSmallOrderFeeActionMessageParts
Information about the small order fee - the fee amount and additional cart amount needed to avoid the fee.
Properties
fee_amount_cents
Optional
Integer
The amount of the small order fee - in cents - currently being applied to the cart.
balance_to_waiver_cents
Optional
Integer
The additional amount - in cents - that the diner needs to add to their cart in order to avoid the small order fee.
CheckoutResponse
A cart object after being checked out.
Properties
order_number
Optional
String
The number associated with the order in the Grubhub system.
Coupon
A coupon that applies to a cart, possibly lowering the price or including a free item.
Properties
id
Optional
UUID
A universally unique identifier for this coupon.
coupon_id
Optional
String
A text identifier for this coupon.
description
Optional
String
A human-readable explanation of what this coupon is and how it affects the cart.
amount
Optional
Integer
The total amount, in cents, that this coupon discounts the cart total.
restaurant_id
Optional
String
The identifier of the restaurant for which this coupon applies.
minimum_amount
Optional
Integer
The minimum cart amount needed to apply this coupon to the cart total.
DeliveryInfo
Information on how to delivery this order to the diner.
Properties
street_address1
Optional
String
The primary street address.
cross_streets
Optional
String
The nearest cross street to the street address.
street_address2
Optional
String
Additional address information, such as apartment number.
address_locality
Optional
String
The city, town, or other locality in which this address is located.
address_region
Optional
String
The state or other region in which this address is located.
postal_code
Optional
String
The ZIP Code or Postcode of the address.
delivery_instructions
Optional
String
Any delivery instructions provided by the diner.
name
Optional
String
The diner name. Used to verify the order upon delivery.
phone
Optional
String
The contact phone number for the diner.
email
Optional
String
The contact email address for the diner.
address_country
Optional
String
The country in which this address is located.
green_indicated
Optional
boolean
Whether the diner has indicated that they want the restaurant to not include plastic silverware in order to save the environment.
latitude
Optional
String
The latitude of the address.
longitude
Optional
String
The longitude of the address.
DinerInfo
Information about a diner associated with an order or cart.
Properties
id
Optional
UUID
The ID of the diner.
FreeMenuItemParts
Information about a menu item that the diner can add to their cart for free.
Properties
menu_item_id
Optional
String
The ID of the menu item that the diner can add for free.
FulfillmentEstimate
An estimate of the expected time and maximum time that an order would be fulfilled.
Properties
time
Optional
DateTime
When this order was expected to be fulfilled.
max_time
Optional
DateTime
The latest that this order was expected to be fulfilled.
FulfillmentInfo
Information about how to delivery or handle pickup for the current order.
Properties
type
Optional
String
The type of order fulfillment associate with this order. Either "DELIVERY" or "PICKUP".
incomplete_delivery
Optional
Incomplete delivery information that will still allow the driver to reach the diner.
incomplete_pickup
Optional
IncompletePickup
An empty object used to indicate that the cart is for a pickup order without providing pickup information about the diner.
IncompleteDelivery
Incomplete delivery information that will still allow the driver to reach the diner.
Properties
latitude
Optional
String
The latitude coordinate of the delivery address.
longitude
Optional
String
The longitude coordinate of the delivery address.
IndividualInfo
Information about the individual picking up or receiving delivery.
Properties
individual_name
Optional
String
The name of the diner.
NotificationPreferences
How the diner prefers to be notified about their order.
Properties
channels
Optional
Map
The diner's notification preferences, mapped by the type of channel.
system
Optional
String
The method used to notify the diner.
NotificationType
Settings for an individual notification channel.
Properties
destinations
Optional
String
Where the notification payload will be sent on order status changes. For WEBHOOK notifications, this should be the URI that will process the notification payload.
Order
Information about a previously placed order.
Properties
id
Optional
UUID
The ID of the diner who placed the order.
time_placed
Optional
DateTime
The date and time when this order was placed.
fulfillment_info
Optional
Information about how the restaurant will fulfill the diner's order.
order_number
Optional
Integer
A number given to identify the order to the restaurant. This differs from the order ID, which is a unique UUID in the Grubhub system.
payments
Optional
The payment methods applied to this order and the total order cost that those methods cover.
when_for
Optional
DateTime
The date and time which this order was expected to be ready.
fulfillment_estimate
Optional
Estimates on the earliest and latest that this order was to be fulfilled.
is_test
Optional
Boolean
Whether this order was a test and not intended to be fulfilled.
OrderCharges
The charges associated with an existing order.
Properties
diner_subtotal
Optional
Integer
The total of all menu items added to this cart before fees and taxes.
diner_grand_total
Optional
Integer
The total amount of the bill for this order, including menu items, taxes, fees, and tip.
OrderLines
A break down of each menu item line within a completed order.
Properties
OrderTracking
Information about whether this order is tracked.
Properties
enabled
Optional
boolean
Whether this order is able to be tracked.
Payment
Information about a single payment method attached to a cart.
Properties
id
Optional
String
The ID value that identifies this payment as attached to a specific cart.
type
Optional
String
The type of payment; one of either "CREDIT_CARD", "PAYPAL_EXPRESS", or "AMEX_EXPRESS".
amount
Optional
Integer
The amount of the cart bill that this payment covers.
metadata
Optional
String
An arbitrary string in which to store any information about this payment.
PaymentMethod
A payment applied to a cart or order.
Properties
id
Optional
UUID
The ID of this payment applied to a cart or order.
payment_id
Optional
UUID
The ID of a payment method attached to a diner.
payment_type
Optional
String
The type of payment applied to this order.
amount
Optional
Integer
The amount of the bill that this payment covers.
cc_num_last_four
Optional
Integer
The last four numbers of this payment method if it is a credit card.
cc_type
Optional
String
The card type, i.e. Visa.
Payments
An array of the payment methods applied to a cart or order and the total order cost that those methods cover.
Properties
total
Optional
Integer
The total amount of the bill covered by all payments.
PickupInfo
Information required to arrange pickup with the diner.
Properties
name
Optional
String
The name of the diner picking up the order.
phone
Optional
String
The phone number of the diner.
email
Optional
String
The email address of the diner.
pickup_instructions
Optional
String
Any instructions that the diner has provided to the restaurant for pickup.
green_indicated
Optional
boolean
Whether the diner has indicated that they do not want plastic utensils with their food.
RecommendedTipSettings
The tip amount and percentage that we recommend you apply to this order.
Properties
minimum_tip_amount
Optional
int
The minimum recommended amount of tip (in cents) to apply to this order.
minimum_tip_percentage
Optional
double
The minimum percentage of the total order to add as a tip.
ResourceCreateResponse
A new cart-related resource.
Properties
id
Required
String
The ID of the newly created resource (cart, cart line, etc.).
uri
Optional
URI
The URI that you can use as a RESTful endpoint to affect this cart.
already_exists
Optional
boolean
Indicates whether this resource already has been created.
Restaurant
Information about a single restaurant.
Properties
id
Optional
String
The unique identifier for this restaurant.
name
Optional
String
The display name of the restaurant.
Tip
Information about the tip applied to a cart.
Properties
amount
Optional
Integer
The total amount of the tip in cents.
tip_type
Optional
String
How the tip amount will be collected. This will be either "INCLUDE_IN_BILL" or "CASH".
ValidationError
The error and description as to why a cart failed to validate for checkout.
Properties
property
Optional
String
The item that failed validation.
message_key
Optional
String
The reason that property failed to validate.
WebhookPayload
Information sent to a specified webhook address when a diner's order status changes.
Properties
webhook_sid
Optional
String
A security key Grubhub sends to verify that this payload comes from our servers. It will be the same for every response.
status
Optional
String
The state that the order has entered into. Can be one of "CONFIRMED", "READY_FOR_PICKUP", "OUT_FOR_DELIVERY", "CANCELLED", or "ADJUSTED".