Skip to main content
PATCH
Update a cart item quantity

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

Current cart ETag returned by the API.

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

Path Parameters

locationId
string
required
Required string length: 1 - 128
cartId
string
required
Required string length: 1 - 128
itemId
string
required
Required string length: 1 - 128

Body

application/json
quantity
integer
required
Required range: 0 <= x <= 99

Response

Updated cart.

id
string
required
Required string length: 1 - 128
locationId
string
required
Required string length: 1 - 128
merchantId
string
required
Required string length: 1 - 128
status
enum<string>
required
Available options:
OPEN,
LOCKED,
COMPLETED,
EXPIRED
revision
integer
required
Required range: 0 <= x <= 9007199254740991
expiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
restaurantDisplayName
string
required
fulfilmentMethod
enum<string>
required
Available options:
takeout,
table_side,
room_service,
delivery
fulfillmentIdentifier
string
required
pickupType
enum<string>
required
Available options:
ASAP,
LATER
orderDate
string
required
orderTime
string
required
currency
enum<string>
required
Available options:
usd,
gbp,
aed,
aud
subTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
subTotalFormatted
string
required
discountTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
discountTotalFormatted
string
required
waiterTipTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
waiterTipTotalFormatted
string
required
taxTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
taxTotalFormatted
string
required
taxAndFeeTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
taxAndFeeTotalFormatted
string
required
serviceFeeTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
serviceFeeTotalFormatted
string
required
paymentProcessingFeeTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
paymentProcessingFeeTotalFormatted
string
required
applicationFeeTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
applicationFeeTotalFormatted
string
required
netSalesTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
netSalesTotalFormatted
string
required
fulfillmentMethodFeeTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
fulfillmentMethodFeeTotalFormatted
string
required
orderTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
orderTotalFormatted
string
required
orderTotalWithServiceFee
string
required
Pattern: ^-?\d+(?:\.\d+)?$
orderTotalWithServiceFeeFormatted
string
required
orderTotalWithServiceFeeAmount
integer
required
Required range: 0 <= x <= 9007199254740991
enterpriseFeeTotal
string
required
Pattern: ^-?\d+(?:\.\d+)?$
enterpriseFeeTotalFormatted
string
required
subTotalWithoutDiscount
string
required
Pattern: ^-?\d+(?:\.\d+)?$
subTotalWithoutDiscountFormatted
string
required
statementDescriptor
string
required
totalQuantity
integer
required
Required range: 0 <= x <= 9007199254740991
items
object[]
required
fees
object
required
lockedAt
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
metadata
object
discountCode
string
deliveryInfo
object | null
tableServiceInfo
object | null
roomServiceInfo
object | null