POST
/
api
/
v1
/
locations
/
{locationId}
/
carts
/
{cartId}
/
cart-item
{
  "id": "64a7b8c9d1e2f3a4b5c6d7e8",
  "quantity": 2,
  "specialInstructions": "",
  "itemUnavailableAction": "remove_item",
  "selectedModifiers": []
}
{
  "cartId": "64a7b8c9d1e2f3a4b5c6d7e8"
}

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)
{
  "id": "64a7b8c9d1e2f3a4b5c6d7e8",
  "quantity": 2,
  "specialInstructions": "",
  "itemUnavailableAction": "remove_item",
  "selectedModifiers": []
}
{
  "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

Response

200
application/json

Item added successfully.

The response is of type object.