Skip to main content
POST
Create or resume an ordering session

Authorizations

X-Cart-Token
string
header
required

Purpose-limited capability returned for a guest cart.

Headers

Idempotency-Key
string
required

Caller-stable key reused only for retries of this exact request.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9._:-]{16,128}$
If-Match
string

Required when existingCartId is present.

Pattern: ^(?:W/)?"cart-(?:0|[1-9][0-9]*)"$

Path Parameters

locationId
string
required
Required string length: 1 - 128

Body

application/json
fulfillmentMethod
enum<string>
required
Available options:
takeout,
table_side,
room_service,
delivery
marketplaceId
string
Required string length: 1 - 128
existingCartId
string | null
Pattern: ^[a-f\d]{24}$
channel
enum<string>
Available options:
qr,
web,
kiosk,
app,
pos,
unknown
metadata
object
returnUrl
string<uri>
Maximum string length: 2048

Response

Created or resumed ordering session.

cart
object
required
cartAccessToken
string