Fields
applied_promos
[AppliedPromos]An array containing information about applied promotions. For example, [{ promo_id: 'PROMO10', amount: 100.0 }].
can_cancel
BooleanIndicates if the shipment can be canceled. For example, false when dispatched.
can_return
BooleanIndicates if the item can be returned. For example, true for returnable apparel.
currency_code
StringThe code of the currency used. For example, 'INR'.
currency_symbol
StringThe symbol of the currency used. For example, '₹'.
current_status
CurrentStatusAn object containing the current status of the item. For example, { status: 'delivered' }.
delivery_date
StringThe date and time when the item is expected to be delivered. For example, '2024-11-05T18:00:00Z'.
financial_breakup
[FinancialBreakup]The date and time when the item is expected to be delivered. For example, `financial_breakup` can be set to [a FinancialBreakup object].
id
IntThe unique identifier for the order item. For example, 21500347.
item
OrderItemAn object containing details about the item. For example, { name: 'Cotton Shirt' }.
line_number
IntThe line number of the item in the order. For example, 1.
meta
JSONAn object containing metadata for the item. For example, { personalization: true }.
parent_promo_bags
JSONAn object containing details of parent promotional bags. For example, { parent_bag_id: 10 }.
prices
PricesAn object containing price details for the item. For example, { price_effective: 999.0 }.
quantity
IntThe quantity of the item. For example, 2.
returnable_date
StringThe last date and time by which the item can be returned. For example, '2024-11-20T23:59:59Z'.
seller_identifier
StringThe identifier for the seller. For example, '85'.
article
ArticleOrder bags article details, for example article metadata and attributes. For example, `article` can be set to a Article object.
charges
[PriceAdjustmentCharge]Bags charges details. For example, [{ name: 'gift_wrap', amount: 30.0 }].
is_bundle_item
BooleanIndicates if the item is a bundle item. For example, true for bundle SKU.
bundle_details
BundleDetailsBundle details containing information about the bundle. For example, `bundle_details` can be set to a BundleDetails object.
custom_fields
[CustomField]Additional custom attributes associated with the order bag for extended order information and tracking metadata
Was this section helpful?