Skip to main content
GET
Get cart

Authorizations

X-API-Key
string
header
required

API Key required to authenticate requests

Path Parameters

locationId
string
required
cartId
string
required

Response

Cart retrieved successfully.

id
string
Example:

"cart_123"

locationId
string
Example:

"loc_456def"

status
string
Example:

"OPEN"

lockedAt
string<date-time> | null

Timestamp when the cart was locked for checkout. Null while the cart is editable.

Example:

null

discountCode
string | null
Example:

"SAVE10"

currency
string
Example:

"usd"

fulfilmentMethod
string

Current fulfillment method for the cart. Note: the API responds with the UK spelling fulfilmentMethod; when updating a cart send fulfillmentMethod in the request body.

Example:

"pickup"

statementDescriptor
string | null

Descriptor that appears on the shopper’s card statement.

Example:

"CRAVE*Downtown Pizza Co"

pickupType
string
Example:

"ASAP"

orderDate
string
Example:

"2024-11-12"

orderTime
string
Example:

"18:30"

totalQuantity
integer
Example:

3

subTotal
string
Example:

"3600"

subTotalFormatted
string
Example:

"$36.00"

discountTotal
string
Example:

"0.00"

discountTotalFormatted
string
Example:

"$0.00"

waiterTipTotal
string
Example:

"540"

waiterTipTotalFormatted
string
Example:

"$5.40"

taxTotal
string
Example:

"280"

taxTotalFormatted
string
Example:

"$2.80"

taxAndFeeTotal
string
Example:

"320"

taxAndFeeTotalFormatted
string
Example:

"$3.20"

serviceFeeTotal
string
Example:

"120"

serviceFeeTotalFormatted
string
Example:

"$1.20"

paymentProcessingFeeTotal
string
Example:

"40"

paymentProcessingFeeTotalFormatted
string
Example:

"$0.40"

applicationFeeTotal
string
Example:

"0.00"

applicationFeeTotalFormatted
string
Example:

"$0.00"

netSalesTotal
string
Example:

"3600"

netSalesTotalFormatted
string
Example:

"$36.00"

fulfillmentMethodFeeTotal
string
Example:

"0.00"

fulfillmentMethodFeeTotalFormatted
string
Example:

"$0.00"

orderTotalWithServiceFee
string
Example:

"4460"

orderTotalWithServiceFeeFormatted
string
Example:

"$44.60"

orderTotalWithServiceFeeAmount
number

Order total with fees converted into the smallest currency unit.

Example:

4460

orderTotal
string
Example:

"4040"

orderTotalFormatted
string
Example:

"$40.40"

enterpriseFeeTotal
string
Example:

"0.00"

enterpriseFeeTotalFormatted
string
Example:

"$0.00"

subTotalWithoutDiscount
string
Example:

"3600"

subTotalWithoutDiscountFormatted
string
Example:

"$36.00"

restaurantDisplayName
string
Example:

"Downtown Pizza Co"

deliveryInfo
object | null
tableServiceInfo
object | null
roomServiceInfo
object | null
fees
object
metadata
object | null
checkoutUrl
string | null
fulfillmentIdentifier
string | null
Example:

null