Order details. For example, an order could include shipments 16736576489251696245 placed on 2023-01-14 06:17:37.
Fields
bags_for_reorder
[BagsForReorder]A list containing details of bags available for reorder. For example, [{ item_id: 95988, quantity: 1 }].
breakup_values
[OrderBreakupValue]A list containing the breakup of various charges and discounts, such as shipping, tax, and coupon adjustments. For example, `breakup_values` can be set to [a OrderBreakupValue object].
order_created_time
StringThe date and time when the order was created. For example, '2023-01-14 06:17:37'.
order_created_ts
StringThe timestamp when the order was created. For example, '2023-01-14T06:17:37Z'.
order_id
StringThe unique identifier for the order. For example, 'FY63C1FBA80195F734C0'.
shipments
[OrderShipment]A list containing details of individual shipments within the order. For example, [{ shipment_id: '16736576489251696245', status: 'credit_note_generated' }].
total_shipments_in_order
IntThe total number of shipments in the order. For example, 1, 2, or 3.
user_info
UserInfoUser info such as name, email, and phone. For example, `user_info` can be set to a UserInfo object.
gstin_code
StringThe GSTIN code of the user who placed the order. For example, '27ABCDE1234F1Z5'.
meta
JSONMetadata for the order used for tracking and analytics. For example, { source: 'ios_app', campaign: 'diwali_sale' }.
charges
[PriceAdjustmentCharge]Order-level charges breakdown applied to this order. For example, [{ name: 'shipping', amount: 40.0 }].
currency
CurrencySchemaThe currency associated with the order. For example, { currency_code: 'INR', currency_symbol: '₹' }.
Was this section helpful?