object

CartShipmentsResponse

Cart shipment response schema for get shipments API.
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. Example: 123456
checkout_mode
String
Checkout mode of cart. Example: 'self'
comment
String
Comment message added in cart. Example: 'Please call on arrival'
coupon_text
String
Coupon text of coupon applied on cart. Example: 'SAVE10 applied'
currency
CartCurrency
Currency data of the cart for prices. Example: { code: 'INR', symbol: '₹' }
delivery_charge_info
String
Delivery charge info message on shipment. Example: 'Free delivery over ₹999'
delivery_promise
ShipmentPromise
Shipment level promise (formatted time, timestamp, ISO).
error
Boolean
Whether an error occurred. Example: false
gstin
String
GSTIN number added in cart. Example: '27AAACI1195H1ZK'
Cart uid of the user cart. Example: '5bb521cfdc83215e1889b346'
is_valid
Boolean
Cart validity flag. Example: true
last_modified
String
Last modified timestamp of cart. Example: '2025-10-07T14:20:00Z'
message
String
Response message of get shipments API. Example: 'Shipments fetched successfully'
payment_selection_lock
PaymentSelectionLock
Payment Default Selection Schema.
restrict_checkout
Boolean
Restrict checkout flag. Example: false
List of shipments with items and promise details. Example: [{ shipments: 1, order_type: 'HomeDelivery' }]
Cart uid of the user cart. Example: 'uid_987'
custom_cart_meta
JSON
Metadata for custom cart. Example: { channel: 'web' }
customer_id
String
Customer user id associated with cart. Example: 'usr_456'