01 Software

Carts

Cart and cart item collections

Carts

carts

Stores shopping cart information. Supports the cart-to-order conversion flow.

FieldTypeDescriptionRequired
customerrelationshipCustomer reference (customers)
statusselectStatus: active, completed, abandoned (default: active)
shippingAddressgroupShipping address
discountCodetextDiscount code
itemsTotalnumberItems subtotal (read-only)
shippingFeenumberShipping fee (default: 0)
discountAmountnumberDiscount amount (default: 0)
totalAmountnumberTotal amount (read-only)
expiresAtdateExpiration date
itemsjoinCart items (cart-items)

Shipping Address (shippingAddress):

FieldTypeDescriptionRequired
recipientNametextRecipient name
phonetextPhone number
postalCodetextPostal code
address1textAddress
address2textDetailed address
deliveryMessagetextDelivery message
// Get active cart
const response = await client.from('carts').find({
  where: {
    customer: { equals: customerId },
    status: { equals: 'active' }
  }
})

cart-items

Stores items in a shopping cart.

FieldTypeDescriptionRequired
cartrelationshipCart reference (carts)
productrelationshipProduct reference (products)
variantrelationshipVariant reference (product-variants)
optionrelationshipOption reference (product-options)
quantitynumberQuantity (min: 1)
unitPricenumberUnit price (min: 0)
// Add item to cart
const item = await client.from('cart-items').create({
  cart: cartId,
  product: productId,
  variant: variantId,
  quantity: 2,
  unitPrice: 15000
})

// Get cart items
const response = await client.from('cart-items').find({
  where: { cart: { equals: cartId } }
})

On this page