Fields
awb_no
StringThe airway bill number for the shipment.
bags
[OrderBags]An array containing details about the individual bags in the shipment.
beneficiary_details
BooleanIndicates if there are any beneficiary details.
breakup_values
[OrderBreakupValues]An array containing the breakup of various charges and discounts.
can_break
JSONAn object containing details about the breakability of the shipment.
can_cancel
BooleanIndicates if the shipment can be canceled.
can_return
BooleanIndicates if the shipment can be returned.
comment
StringAny comments related to the shipment.
custom_meta
[JSON]An object containing custom metadata for the shipment.
delivery_address
DeliveryAddressAn object containing the delivery address details.
delivery_date
StringThe expected delivery date.
dp_name
StringThe name of the delivery partner.
fulfilling_company
FulfillingCompanyFulfilling company details.
fulfilling_store
FulfillingStoreStore fulfilling the shipment.
invoice
InvoiceSchema for invoice.
need_help_url
StringThe URL for customer support or help.
order_id
StringThe unique identifier for the order.
order_type
StringThe type of order.
payment
ShipmentPaymentAn object containing payment details.
prices
PricesDifferent prices related to the shipment(refund_amount, discount, etc).
promise
PromiseAn object containing promise details for delivery.
refund_details
JSONAn object containing details of any refunds.
return_meta
JSONAn object containing metadata about the return process.
returnable_date
StringThe last date by which the item can be returned.
shipment_created_at
StringThe date and time when the shipment was created.
shipment_id
StringThe unique identifier for the shipment.
shipment_status
ShipmentStatusAn object containing the current status of the shipment.
show_download_invoice
BooleanIndicates if the download invoice option should be shown.
show_track_link
BooleanIndicates if the track link should be shown.
size_info
JSONAn object containing size information for the items in the shipment.
total_bags
IntThe total number of bags in the shipment.
total_details
ShipmentTotalDetailsAn object containing the total details of the shipment.
track_url
StringThe URL for tracking the shipment.
tracking_details
[TrackingDetails]An array containing details of the tracking history of the shipment.
traking_no
StringThe tracking number for the shipment.
user_info
ShipmentUserInfoUser information for the shipment.
billing_address
BillingAddressBilling details for the order shipment
payment_info
[ShipmentPaymentInfo]Payment information for the order shipment
gstin_code
StringThe GSTIN code for the shipment.
shipment_created_ts
StringThe timestamp when the shipment was created.
order
OrderRequestMetadata for the order.
charges
[PriceAdjustmentCharge]Order charges information.
Was this section helpful?