Create Cart

Use this API to create a cart, by providing a list of products and the fulfillment mode. Upon successful creation, this API will generate a cart ID which can later be retrieved using the Retrieve Cart API and used to place an order using the Create Order API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

The optional ID of an existing cart to update.

items
array of objects
required
Defaults to [object Object]

List of cart items.

items*
string
required

The product's ID.

integer

The selected quantity (must be greater than 0). If not provided, a quantity of 1 is selected.

integer

The self-provided marked price (in cents) to be used in the email receipt.

selected_options
array of objects

The list of selected options for the product.

selected_options
string

The product notes for the store.

boolean
required
Defaults to false

Whether to the order fulfillment type is pickup or delivery.

integer
Defaults to 100

The tip for the driver, in cents.

number
Defaults to 37.7786357

The latitude of the user.

number
Defaults to -122.3918135

The longitude of the user.

string
Defaults to 188

Street number of the user.

string
Defaults to King Street

Street name of the user.

string

Apartment number of the user

string
Defaults to San Francisco

City of the user.

string
Defaults to CA

State of the user.

string
Defaults to US

Country of the user. Can be US or CA.

string
Defaults to 94107

Zipcode of the user.

string
Defaults to Leave in lobby

Dropoff delivery notes for the user.

string
Defaults to Steve Jobs

User's name, so the store and/or driver know who to give the food to at dropoff.

string
Defaults to [email protected]

User's email, for the order confirmation, updates, and tracking link.

integer
Defaults to 14044442058

User's phone number, so the store and/or driver know who to call for pickup or delivery. Must include country code.

string
required
Defaults to 7B36A9CF

Unique User ID for the API customer's platform.

boolean
Defaults to false

Whether to send the user order status updates via SMS.

email_receipt_specifications
object

Set of optional configurations used to modify email reciept

string

The self provided order id to attach to this order. This will be returned in the response from Get Orders when looking up an order.

boolean
Defaults to false

Whether to automatically select the default quantity for all options and fulfill all customization requirements.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json