Get shipment details for the items in a cart, specific to the selected address. Shipment details include delivery promises, seller information, item details, and other relevant information.
Arguments
addressId
StringID allotted to the selected address. Example: 'addr_001'
areaCode
StringCustomer serviceable area code, such as a pincode, ZIP code, or postal code. Example: '400059'.
buyNow
BooleanWhether to get a Buy Now cart. Example: false
id
StringThe unique identifier of the cart. Example: '5bb521cfdc83215e1889b346'
orderType
StringShipment order type (e.g., 'HomeDelivery', 'PickAtStore', 'Digital'). Example: 'HomeDelivery'
includePayment
BooleanSelect true to include payment options in response. Example: false
Response
breakup_values
CartBreakupPrice breakup of cart (coupon, display, loyalty points, etc.). Example: { display: [{ key: 'total', value: 1499.0 }] }
buy_now
BooleanBuy now flag of user cart. Example: false
cart_id
IntCart id of the user cart. Example: 123456
checkout_mode
StringCheckout mode of cart. Example: 'self'
comment
StringComment message added in cart. Example: 'Please call on arrival'
coupon_text
StringCoupon text of coupon applied on cart. Example: 'SAVE10 applied'
currency
CartCurrencyCurrency data of the cart for prices. Example: { code: 'INR', symbol: '₹' }
delivery_charge_info
StringDelivery charge info message on shipment. Example: 'Free delivery over ₹999'
delivery_promise
ShipmentPromiseShipment level promise (formatted time, timestamp, ISO).
error
BooleanWhether an error occurred. Example: false
gstin
StringGSTIN number added in cart. Example: '27AAACI1195H1ZK'
id
StringCart uid of the user cart. Example: '5bb521cfdc83215e1889b346'
is_valid
BooleanCart validity flag. Example: true
last_modified
StringLast modified timestamp of cart. Example: '2025-10-07T14:20:00Z'
message
StringResponse message of get shipments API. Example: 'Shipments fetched successfully'
payment_selection_lock
PaymentSelectionLockPayment Default Selection Schema.
restrict_checkout
BooleanRestrict checkout flag. Example: false
shipments
[ShipmentResponse]List of shipments with items and promise details. Example: [{ shipments: 1, order_type: 'HomeDelivery' }]
uid
StringCart uid of the user cart. Example: 'uid_987'
custom_cart_meta
JSONMetadata for custom cart. Example: { channel: 'web' }
customer_id
StringCustomer user id associated with cart. Example: 'usr_456'
Query
Try it
Input Variables
Response
Was this section helpful?