Promotion

The promotion endpoint allows users to apply a promotion to their account by putting in a promotion code. This endpoint require an access token in the Authorization HTTP header. Once the promo is applied to the user’s account successfully, the promo will show in the Customer Checkout call’s response. Apply a promo HTTP Request POST […]

Read More

Customer Cart

Overview Cart state is maintained server-side, which frees up developers from the tricky task of client-side cart management. No call is needed to initiate a session; simply add an item for a given merchant ID and the cart can then be manipulated with the calls listed below. Cart Session Modes There are two different cart […]

Read More

Customer Checkout

Overview Checkout is the final endpoint in the customer order flow. It is used to retrieve available payment options and to book orders. Get Payments HTTP Request GET /customer/cart/{merchant_id}/checkout Request Parameters Success Response HTTP 200 OK Place Order – Authenticated Users HTTP Request POST /customer/cart/{merchant_id}/checkout Request Body Request Body Split Payment You can split an order […]

Read More

Customer Orders

View customer orders that have already been placed. All of these requests require an access token in the Authorization HTTP header. View a single order Request GET /customer/orders/recent/{order_id} Parameters Response View order history Request GET /customer/orders/recent Parameters There are no parameters for this request. Response Re-order Request POST /customer/cart/reorder Parameters Response Get Favorite Orders Request […]

Read More

Customer Payment Methods

Payment methods are required for placing an order. All requests require an access token in the Authorization HTTP header. See Authentication. Get Credit Card Request HTTP Request GET /customer/cc Parameters Response

Read More

Customer Addresses

A customer needs to have at least 1 address stored on their account to place an order. All requests require an access token in the Authorization HTTP header. Addresses are verified against the US Postal Service data.. Create Location HTTP Request POST /customer/location Request Body Success Response HTTP 200 OK If successful, the API returns […]

Read More

Customer Info

This endpoint returns basic customer information. This request requires an access token in the Authorization HTTP header. HTTP Request GET /customer/account Request Parameters There are no request parameters, but you must include an access token. Success Response HTTP 200 OK If successful, the API returns you the location_id of the address you just inserted. This […]

Read More

Merchant Info

View general info for a merchant. The normal return type is a Merchant. Request HTTP Request GET /merchant/{merchant_id}/ Parameters Request Body Do not supply a request body with this method. Responses Success HTTP 200 OK Example Invalid Merchant Id This is returned when an invalid merchant id is passed. HTTP 400 Bad Request Example

Read More

Merchant Menu

View a merchant’s menu. Menu Request HTTP Request GET /merchant/{merchant_id}/menu Parameters Request Body Do not supply a request body with this method. Responses Success HTTP 200 OK Example Invalid Merchant Id This is returned when an invalid merchant id is passed. HTTP 400 Bad Request Example Item Request Used to request a single item. HTTP […]

Read More

Merchant Hours

Get a merchant’s business and delivery hours. Notes: There may be multiple open and close times in a single day if the merchant closes during and reopens during the day. A close time may be earlier than open time, in which case the close time is in the morning of the next day. Request HTTP […]

Read More