Skip to main content
WEBHOOK
shipment.cancelled
{
  "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>",
      "variant_id": "<string>",
      "variant_name": "<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",
  "seller_id": "<string>",
  "seller_detail": {
    "id": "<string>",
    "trade_name": "<string>",
    "legal_name": "<string>",
    "business_type": "<string>",
    "tax_identification_number": "<string>"
  }
}
{
  "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>
seller_id
string | null

Seller ID. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.

seller_detail
SellerDetail ยท object

Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.

Response

Bad request

message
string
required
success
boolean
required
code
string
required
error
object