WEBHOOK
shipment.updated
{
  "reference_number": "<string>",
  "status": "unscheduled",
  "total_weight": 123,
  "total_boxes": 123,
  "shipment_items_count": 123,
  "shipment_items": [
    {
      "product_id": "<string>",
      "product_name": "<string>",
      "product_image_url": "<string>",
      "sku": "<string>",
      "quantity": 123,
      "free_quantity": 123,
      "is_free_item": true
    }
  ],
  "shipping_amount": 123,
  "shipping_tax_amount": 123,
  "shipping_amount_including_tax": 123,
  "courier_company_name": "<string>",
  "shipping_label_url": "<string>",
  "awb_no": "<string>",
  "tracking_url": "<string>",
  "eta_delivery": "<string>",
  "shipped_date": "2023-11-07T05:31:56Z",
  "delivered_date": "2023-11-07T05:31:56Z",
  "cancellation_reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z"
}
{
  "message": "<string>",
  "success": true,
  "code": "<string>",
  "error": {
    "fieldname": [
      "<string>"
    ]
  }
}

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
total_weight
number
total_boxes
integer
shipment_items_count
integer
shipment_items
ShipmentItem Β· object[]
shipping_amount
number
shipping_tax_amount
number
shipping_amount_including_tax
number
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