object

CheckCart

Checkout cart detail respoonse schema includes cart id, delivery promise, items, comment, coupon text etc.
Fields
breakup_values
CartBreakup
Price breakup of cart (coupon, display, loyalty points, etc.). Example: { display: [{ key: 'total', value: 1499.0 }] }
buy_now
Boolean
Buy now flag of user cart. Example: false
cart_id
Int
Cart id of the user cart for which the order placed. Example: 123456
checkout_mode
String
Checkout mode of user cart. Example: 'self'
cod_available
Boolean
Whether Cash On Delivery available. Example: true
cod_charges
Int
Cash On Delivery charges of the user cart. Example: 50
cod_message
String
Cash On Delivery message for the order placed. Example: 'Available for orders up to ₹10,000'
comment
String
Comment message added in cart after order placed. Example: 'Leave at reception'
coupon_text
String
Coupon text of the applied coupon on order placed. Example: 'SAVE10 applied'
currency
CartCurrency
Currency data of the cart for prices. Example: { code: 'INR', symbol: '₹' }
delivery_charge_info
String
Delivery charge information message on shipment. Example: 'Free delivery over ₹999'
custom_cart_meta
JSON
Metadata for custom cart
delivery_charge_order_value
Int
Delivery charge order value. Example: 999
delivery_charges
Int
Delivery charges of the order placed via checkout API. Example: 0
delivery_promise
ShipmentPromise
Shipment level promise (formatted, timestamp, ISO).
error_message
String
Error message if any. Example: 'Payment pending'
gstin
String
GSTIN number added in cart. Example: '27AAACI1195H1ZK'
Cart uid of the user cart. Example: '5bb521cfdc83215e1889b346'
is_valid
Boolean
Valid flag for the checkout response. Example: true
Items details in cart after order placed. Example: [{ quantity: 2 }]
last_modified
String
Last modified timestamp of cart. Example: '2025-10-07T14:20:00Z'
message
String
Message of the cart checkout API response. Example: 'Checkout successful'
order_id
String
Order id generated after placing order. Example: 'FY2025-10001'
payment_selection_lock
PaymentSelectionLock
Payment Default Selection Schema.
restrict_checkout
Boolean
Restrict checkout flag. Example: false
store_code
String
Store code from which the order placed. Example: 'ANDH001'
store_emps
[JSON]
Store employees data. Example: [{ id: 'emp_01' }]
success
Boolean
Success flag of checkout cart API response. Example: true
Cart uid of user cart. Example: 'uid_987'
user_type
String
User type of the cart who places the order. Example: 'guest'