object

OrderShipment

Shipment details.
Fields
awb_no
String
The airway bill number for the shipment. For example, '8802086113909'.
An array containing details about the individual bags in the shipment. For example, [{ line_number: 1, quantity: 2 }].
beneficiary_details
Boolean
Indicates if there are any beneficiary details. For example, true when refund beneficiary exists.
breakup_values
[OrderBreakupValue]
An array containing the breakup of various charges and discounts, such as shipping, tax, and promo adjustments. For example, `breakup_values` can be set to [a OrderBreakupValue object].
can_break
JSON
An object containing details about the breakability of the shipment. For example, { can_break: true }.
can_cancel
Boolean
Indicates if the shipment can be canceled. For example, false once shipped.
can_return
Boolean
Indicates if the shipment can be returned. For example, true within the return window.
comment
String
Any comments related to the shipment. For example, 'Gift wrap requested'.
custom_meta
[JSON]
An object containing custom metadata for the shipment. For example, { campaign: 'diwali' }.
delivery_address
DeliveryAddress
An object containing the delivery address details. For example, { city: 'Mumbai', pincode: '400001' }.
delivery_date
String
The expected delivery date. For example, '2024-11-05'.
dp_name
String
The name of the delivery partner. For example, 'fyndr'.
fulfilling_company
FulfillingCompany
Fulfilling company details. For example, { id: 12, name: 'Fynd Logistics' }.
fulfilling_store
FulfillingStore
Store fulfilling the shipment. For example, { id: 1001, name: 'Mumbai DC' }.
invoice
Invoice
Schema for invoice, for example to provide invoice download URLs. For example, `invoice` can be set to a Invoice object.
need_help_url
String
The URL for customer support or help. For example, 'https://support.example.com/help'.
order_id
String
The unique identifier for the order. For example, 'FY63C1FBA80195F734C0'.
order_type
OrderTypeEnum
Order type of the shipment (e.g., 'PickAtStore', 'HomeDelivery','Digital). Example: 'HomeDelivery'
An object containing payment details. For example, { mode: 'ONLINE', amount: 1499.0 }.
prices
Prices
Different prices related to the shipment (refund_amount, discount, etc). For example, { discount: 100.0 }.
promise
Promise
An object containing promise details for delivery. For example, { timestamp: { min: '2024-11-05', max: '2024-11-07' } }.
refund_details
JSON
An object containing details of any refunds. For example, { amount: 500.0 }.
return_meta
JSON
An object containing metadata about the return process. For example, { return_mode: 'pickup' }.
returnable_date
String
The last date by which the item can be returned. For example, '2024-11-20'.
shipment_created_at
String
The date and time when the shipment was created. For example, '2023-01-14T06:17:37Z'.
shipment_id
String
The unique identifier for the shipment. For example, '16736576489251696245'.
shipment_status
ShipmentStatus
An object containing the current status of the shipment. For example, { title: 'Credit Note Generated', value: 'credit_note_generated' }.
show_download_invoice
Boolean
Indicates if the download invoice option should be shown. For example, true for prepaid orders.
show_track_link
Boolean
Indicates if the track link should be shown. For example, true once AWB is assigned.
size_info
JSON
An object containing size information for the items in the shipment. For example, { sizes: ['M','L'] }.
total_bags
Int
The total number of bags in the shipment. For example, 3.
An object containing the total details of the shipment. For example, { total_price: 2499.0 }.
track_url
String
The URL for tracking the shipment. For example, 'https://track.example.com/SHIP123'.
tracking_details
[TrackingDetails]
An array containing details of the tracking history of the shipment. For example, [{ status: 'Out for Delivery', time: '2024-11-05T07:45:00Z' }].
traking_no
String
The tracking number for the shipment. For example, 'TRACK987654321'.
User information for the shipment. For example, { first_name: 'John', last_name: 'Doe', mobile: '9876543210', email: 'user@example.com' }.
billing_address
BillingAddress
Billing details for the order shipment, such as billing address records. For example, `billing_address` can be set to a BillingAddress object.
Payment information for the order shipment, for example a list of COD and prepaid splits. For example, `payment_info` can be set to [a ShipmentPaymentInfo object].
gstin_code
String
The GSTIN code for the shipment. For example, '27ABCDE1234F1Z5'.
shipment_created_ts
String
The timestamp when the shipment was created. For example, '2023-01-14T06:17:37Z'.
Metadata for the order. For example, { platform: 'android' }.
Order charges information. For example, [{ name: 'packaging', amount: 20.0 }].
fulfillment_option
FulfillmentOption
Fulfillment option, for example 'home-delivery' or 'store-pickup'. For example, `fulfillment_option` can be set to a FulfillmentOption object.
ndr_details
NdrDetails
An object containing Non-Delivery Report (NDR) related details. For example, { show_ndr_form: true }.
refund_modes
[RefundModeData]
An object containing Refund Mode details.
refund_breakup_values
[OrderBreakupValue]
An array containing the breakup of various charges and discounts and refund amount.
is_refund_config_enabled
Boolean
Indicates whether refund configuration is enabled for the sales channel; if disabled, no refund options are shown, and if enabled, the applicable refund modes are displayed.