Cart
Type: schema
Description
This cart model is structured to capture a wide range of details, facilitating accurate representation and management of user shopping carts in an e-commerce platform.
TypeScript Definition
typescript
Cart: {{
/** @description Unique identifier for the cart. */
id: string;
/** @description Indicates whether the cart is currently active or inactive. */
active: boolean;
/** @description customer note for shipping or product customization. */
customer_note: string | null;
/** @description Indicates if a promotion is applied or not. */
is_promotion_applied: boolean;
/** @description Indicates if a coupon is applied or not. */
is_coupon_applied: boolean;
/** @description Code of the applied coupon. */
coupon_code: string | null;
/**
* Format: double
* @description Discount amount due to the coupon.
*/
coupon_discount_amount: number;
/**
* Format: double
* @description Discount amount due to the coupon.
*/
coupon_discount_percent: number;
/**
* Format: double
* @description Discount amount due to promotions(If Applied).
*/
promotion_discount_amount: number;
/**
* Format: double
* @description Discount amount due to promotions(If Applied).
*/
promotion_discount_percent?: number;
/**
* Format: double
* @description Subtotal amount for items in the cart.
*/
subtotal: number;
/**
* Format: double
* @description Total tax amount for items.
*/
items_tax_amount: number;
/**
* Format: double
* @description Subtotal including tax.
*/
subtotal_including_tax: number;
/** @description Estimated cost of shipping. */
shipping_estimated_cost: number | null;
/** @description Discount applied on estimated shipping cost. */
shipping_discount_amount: number | null;
/** @description Shipping amount chargable to customer. */
shipping_amount: number | null;
/** @description Shipping tax rate applied on shipping amount. */
shipping_tax_rate: number | null;
/** @description Tax applied on shipping_amount. */
shipping_tax_amount: number | null;
/** @description Shipping amount including shipping tax. */
shipping_amount_including_tax: number | null;
fulfillment_preference?: components["schemas"]["FulfillmentPreference"];
estimated_delivery_days: number | null;
/**
* Format: double
* @description The additional charge applied to cover the costs associated with processing, packaging, and handling an order. This fee is separate from shipping charges and may include materials, or special handling requirements.
*/
handling_charge_excluding_tax: number;
/** Format: double */
handling_charge_tax_amount: number;
/** Format: double */
handling_charge_including_tax: number;
/**
* Format: double
* @description Total tax amount for the entire cart.
*/
total_tax: number;
/**
* Format: double
* @description Grand total amount for the cart.
*/
grand_total: number;
/**
* Format: double
* @description Amount of credit balance used.
*/
credit_balance_used: number;
/**
* Format: double
* @description Amount to be paid by the customer.
*/
to_be_paid: number;
/** @description Number of loyalty points redeemed. */
loyalty_points_redeemed: number;
/** @description Number of loyalty points earned. */
loyalty_points_earned: number;
/** @description Number of items in the cart. */
cart_items_count: number;
/** @description List containing detailed information about each item in the cart. */
cart_items: components["schemas"]["CartItem"][];
/** @description Details of the billing address. */
billing_address: components["schemas"]["CustomerAddress"];
/** @description Details of the shipping address. */
shipping_address: components["schemas"]["CustomerAddress"];
/** @description Details about the currency being used, including `name`, `code`, and `symbol`. */
currency: components["schemas"]["Currency"];
/** @description Additional metadata associated with the cart. */
metadata: {
[key: string]: string;
} | null;
/**
* Format: date-time
* @description ISO 8601 timestamp when this cart expires. After expiry, the cart is no longer valid and a new cart must be created.
*/
expires_at: string | null;
/** @description Information about the promotional offers that have been applied to the cart. */
applied_promotions: components["schemas"]["AppliedPromotion"][];
/** @description This key provides details about the savings in cart after coupon have been applied to the cart. */
applied_coupons: components["schemas"]["AppliedCoupon"][];
/** @description List containing detailed information about each shipment in the cart. */
shipments: components["schemas"]["CartShipment"][];
/** @description Total savings from auto-applied promotions. */
promotion_savings: number;
/** @description Total savings from the applied coupon code. */
coupon_savings: number;
/** @description Total savings from loyalty points, credit balance, and other non-promotion/coupon discounts. */
other_savings: number;
/** @description Combined savings across promotions, coupons, and other discounts (`promotion_savings` + `coupon_savings` + `other_savings`). */
total_savings: number;
/** @description Free shipping threshold of the cart */
free_shipping_threshold: number | null;
/**
* @description Checkout readiness of the cart. A cart is `ready-for-payment` only when it has items, a valid address, and a fulfillment preference set. Use `status_error_message` for the specific reason when `not-ready-for-payment`.
* @default not-ready-for-payment
* @enum {string}
*/
status: "not-ready-for-payment" | "ready-for-payment";
/** @description Human-readable reason why the cart is not ready for payment. `null` when `status` is `ready-for-payment`. */
status_error_message: string | null;
};
/** CartBasedFulfillmentCheck */
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["FulfillmentPreference"] | FulfillmentPreference |
components["schemas"]["CartItem"] | CartItem |
components["schemas"]["CustomerAddress"] | CustomerAddress |
components["schemas"]["Currency"] | Currency |
components["schemas"]["AppliedPromotion"] | AppliedPromotion |
components["schemas"]["AppliedCoupon"] | AppliedCoupon |
components["schemas"]["CartShipment"] | CartShipment |
OpenAPI Schema
json
{
"title": "Cart",
"description": "This cart model is structured to capture a wide range of details, facilitating accurate representation and management of user shopping carts in an e-commerce platform.",
"type": "object",
"externalDocs": {
"url": "https://llm-docs.commercengine.io/storefront/schemas/Cart",
"description": "API reference for the Cart schema"
},
"required": [
"id",
"active",
"customer_note",
"is_promotion_applied",
"is_coupon_applied",
"coupon_code",
"coupon_discount_amount",
"coupon_discount_percent",
"promotion_discount_amount",
"subtotal",
"items_tax_amount",
"subtotal_including_tax",
"shipping_estimated_cost",
"shipping_discount_amount",
"shipping_amount",
"shipping_tax_rate",
"shipping_tax_amount",
"shipping_amount_including_tax",
"estimated_delivery_days",
"handling_charge_excluding_tax",
"handling_charge_tax_amount",
"handling_charge_including_tax",
"total_tax",
"grand_total",
"credit_balance_used",
"to_be_paid",
"loyalty_points_redeemed",
"loyalty_points_earned",
"cart_items_count",
"cart_items",
"billing_address",
"shipping_address",
"currency",
"metadata",
"expires_at",
"applied_promotions",
"applied_coupons",
"shipments",
"promotion_savings",
"coupon_savings",
"other_savings",
"total_savings",
"free_shipping_threshold",
"status",
"status_error_message"
],
"properties": {
"id": {
"description": "Unique identifier for the cart.",
"type": "string",
"pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$"
},
"active": {
"description": "Indicates whether the cart is currently active or inactive.",
"type": "boolean"
},
"customer_note": {
"description": "customer note for shipping or product customization.",
"type": [
"string",
"null"
]
},
"is_promotion_applied": {
"description": "Indicates if a promotion is applied or not.",
"type": "boolean"
},
"is_coupon_applied": {
"description": "Indicates if a coupon is applied or not.",
"type": "boolean"
},
"coupon_code": {
"description": "Code of the applied coupon.",
"type": [
"string",
"null"
]
},
"coupon_discount_amount": {
"description": "Discount amount due to the coupon.",
"type": "number",
"format": "double",
"minimum": 0
},
"coupon_discount_percent": {
"description": "Discount amount due to the coupon.",
"type": "number",
"format": "double",
"minimum": 0
},
"promotion_discount_amount": {
"description": "Discount amount due to promotions(If Applied).",
"type": "number",
"format": "double",
"minimum": 0
},
"promotion_discount_percent": {
"description": "Discount amount due to promotions(If Applied).",
"type": "number",
"format": "double",
"minimum": 0
},
"subtotal": {
"description": "Subtotal amount for items in the cart.",
"type": "number",
"format": "double",
"minimum": 0
},
"items_tax_amount": {
"description": "Total tax amount for items.",
"type": "number",
"format": "double",
"minimum": 0
},
"subtotal_including_tax": {
"description": "Subtotal including tax.",
"type": "number",
"format": "double",
"minimum": 0
},
"shipping_estimated_cost": {
"description": "Estimated cost of shipping.",
"type": [
"number",
"null"
]
},
"shipping_discount_amount": {
"description": "Discount applied on estimated shipping cost.",
"type": [
"number",
"null"
]
},
"shipping_amount": {
"description": "Shipping amount chargable to customer.",
"type": [
"number",
"null"
]
},
"shipping_tax_rate": {
"description": "Shipping tax rate applied on shipping amount.",
"type": [
"number",
"null"
]
},
"shipping_tax_amount": {
"description": "Tax applied on shipping_amount.",
"type": [
"number",
"null"
]
},
"shipping_amount_including_tax": {
"description": "Shipping amount including shipping tax.",
"type": [
"number",
"null"
]
},
"fulfillment_preference": {
"$ref": "#/components/schemas/FulfillmentPreference"
},
"estimated_delivery_days": {
"type": [
"integer",
"null"
]
},
"handling_charge_excluding_tax": {
"description": "The additional charge applied to cover the costs associated with processing, packaging, and handling an order. This fee is separate from shipping charges and may include materials, or special handling requirements.",
"type": "number",
"format": "double",
"minimum": 0
},
"handling_charge_tax_amount": {
"type": "number",
"format": "double",
"minimum": 0
},
"handling_charge_including_tax": {
"type": "number",
"format": "double",
"minimum": 0
},
"total_tax": {
"description": "Total tax amount for the entire cart.",
"type": "number",
"format": "double",
"minimum": 0
},
"grand_total": {
"description": "Grand total amount for the cart.",
"type": "number",
"format": "double",
"minimum": 0
},
"credit_balance_used": {
"description": "Amount of credit balance used.",
"type": "number",
"format": "double",
"minimum": 0
},
"to_be_paid": {
"description": "Amount to be paid by the customer.",
"type": "number",
"format": "double",
"minimum": 0
},
"loyalty_points_redeemed": {
"description": "Number of loyalty points redeemed.",
"type": "integer",
"minimum": 0
},
"loyalty_points_earned": {
"description": "Number of loyalty points earned.",
"type": "integer",
"minimum": 0
},
"cart_items_count": {
"description": "Number of items in the cart.",
"type": "integer",
"minimum": 0
},
"cart_items": {
"description": "List containing detailed information about each item in the cart. ",
"type": "array",
"items": {
"$ref": "#/components/schemas/CartItem"
}
},
"billing_address": {
"description": "Details of the billing address.",
"$ref": "#/components/schemas/CustomerAddress"
},
"shipping_address": {
"description": "Details of the shipping address.",
"$ref": "#/components/schemas/CustomerAddress"
},
"currency": {
"description": "Details about the currency being used, including `name`, `code`, and `symbol`.",
"$ref": "#/components/schemas/Currency"
},
"metadata": {
"description": "Additional metadata associated with the cart.",
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
}
},
"expires_at": {
"description": "ISO 8601 timestamp when this cart expires. After expiry, the cart is no longer valid and a new cart must be created.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"applied_promotions": {
"description": "Information about the promotional offers that have been applied to the cart.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AppliedPromotion"
}
},
"applied_coupons": {
"description": "This key provides details about the savings in cart after coupon have been applied to the cart.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AppliedCoupon"
}
},
"shipments": {
"description": "List containing detailed information about each shipment in the cart.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CartShipment"
}
},
"promotion_savings": {
"description": "Total savings from auto-applied promotions.",
"type": "number",
"minimum": 0
},
"coupon_savings": {
"description": "Total savings from the applied coupon code.",
"type": "number",
"minimum": 0
},
"other_savings": {
"description": "Total savings from loyalty points, credit balance, and other non-promotion/coupon discounts.",
"type": "number",
"minimum": 0
},
"total_savings": {
"description": "Combined savings across promotions, coupons, and other discounts (`promotion_savings` + `coupon_savings` + `other_savings`).",
"type": "number",
"minimum": 0
},
"free_shipping_threshold": {
"description": "Free shipping threshold of the cart",
"type": [
"number",
"null"
]
},
"status": {
"description": "Checkout readiness of the cart. A cart is `ready-for-payment` only when it has items, a valid address, and a fulfillment preference set. Use `status_error_message` for the specific reason when `not-ready-for-payment`.",
"type": "string",
"default": "not-ready-for-payment",
"enum": [
"not-ready-for-payment",
"ready-for-payment"
]
},
"status_error_message": {
"description": "Human-readable reason why the cart is not ready for payment. `null` when `status` is `ready-for-payment`.",
"type": [
"string",
"null"
]
}
},
"examples": []
}Auto-generated from OpenAPI spec and TypeScript definitions