Add Item to Cart

Adds an item with modifiers and customizations to an existing cart. Note: specialInstructions can be an empty string and selectedModifiers can be an empty array for products without modifiers.

Path Parameters

locationId · string · required

The unique identifier for the restaurant location

cartId · string · required

The unique identifier for the cart

Request Body

id · string · required

The product ID to add to the cart

quantity · number · required

The quantity of the item (must be non-negative)

specialInstructions · string

Special preparation instructions for this item (optional)

categoryId · string

The category ID (MongoDB ObjectId format, optional)

itemUnavailableAction · string · required

Action to take if item becomes unavailable

Options: remove_item | cancel_entire_order

selectedModifiers · array · required

Array of selected modifier groups and options (can be empty array for products without modifiers)

Show Modifier Group Object

groupId · string · required

The ID of the modifier group

selectedOptions · array · required

Array of selected options within this group

Show Selected Option Object

id · string · required

The ID of the selected option

quantity · number · required

The quantity of this option (must be non-negative)

Request - Basic Item

{
  "id": "64a7b8c9d1e2f3a4b5c6d7e8",
  "quantity": 2,
  "specialInstructions": "",
  "itemUnavailableAction": "remove_item",
  "selectedModifiers": []
}

Response

{
  "cartId": "64a7b8c9d1e2f3a4b5c6d7e8"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

locationId · string · required

The unique identifier for the restaurant location

cartId · string · required

The unique identifier for the cart

Body

application/json

id · string · required

The product ID to add to the cart

quantity · number · required

The quantity of the item (must be non-negative)

itemUnavailableAction · enum<string> · required

Action to take if item becomes unavailable

Available options:

remove_item,

cancel_entire_order

selectedModifiers · object[] · required

Array of selected modifier groups and options (can be empty array for products without modifiers)

Show child attributes

specialInstructions · string

Special preparation instructions for this item (can be empty string)

categoryId · string

The category ID (MongoDB ObjectId format, optional)

Response

200

application/json

Item added successfully.

cartId · string · required

The unique identifier of the cart that was updated