Skip to main content
POST
shipment.cancelled
{
  "message": "<string>",
  "success": true,
  "code": "<string>",
  "error": {}
}

Body

application/json

Order shipment model

​
reference_number
string
​
status
enum<string>
Available options:
unscheduled,
schedule_requested,
scheduled,
packed,
shipped,
in_transit,
out_for_delivery,
delivery_attempted,
undelivered,
return_to_origin,
delivered,
cancelled,
lost
​
total_weight
number
​
total_boxes
integer
​
shipment_items_count
integer
​
shipment_items
ShipmentItem · object[]
​
shipping_amount
number<double>
​
shipping_tax_amount
number<double>
​
shipping_amount_including_tax
number<double>
​
courier_company_name
string
​
shipping_label_url
string
​
awb_no
string
​
tracking_url
string
​
eta_delivery
string
​
shipped_date
string<date-time>
​
delivered_date
string<date-time>
​
cancellation_reason
string
​
created_at
string<date-time>
​
modified_at
string<date-time>

Response

Bad request

​
message
string
required
​
success
boolean
required
​
code
string
required
​
error
object