Skip to main content

Cart Model

A cart holds a user's in-progress selection, checkout choices, payment context, and eventual order reference. The public API reference lists cart operations separately.

Representative fields include id, uuid, status, business_id, user_id, offer_id, driver_tip, paymethod_id, delivery_zone_id, address_id, order_type, moment, order_id, request_data, delivery_option_id, cart_group_id, and site_id. Relations can include products, business, user, address, payment method, offer, wallets, and metafields.

The status meanings are: 0 open, 1 completed, 2 pending payment confirmation, and 4 payment failed with retry possible. Transitions depend on the operation and payment flow; consult the relevant operation for its behavior.

Cart operations require authentication and normally scope data to the caller. See Update order options, Place an order from a cart, and Confirm a cart.

Schema properties​

Schema: Cart

NameTypeDescription
addressobject | null—
address_idinteger | null—
agent_idinteger | null—
business_idinteger | null—
cart_group_idinteger | null—
commentany—
conversation_idinteger | null—
created_atstring | null—
delivery_option_idinteger | null—
delivery_zone_idinteger | null—
driver_tipany—
driver_tip_ratenumber | null—
idinteger | null—
momentstring | null—
offer_idinteger | null—
on_behalf_ofany—
order_idinteger | null—
order_typeany—
pay_referenceany—
paymethod_dataobject | null—
paymethod_idinteger | null—
place_idinteger | null—
request_dataobject | null—
reservationobject | null—
site_idinteger | null—
spot_numberinteger | null—
statusany—
student_idinteger | null—
typeany—
updated_atstring | null—
user_idinteger | null—
uuidany—
vehicleobject | null—