Light Mode
Shipments
Below are the webhook store events paired with their respective data schema related to the Shipments webhook events:
Shipments Webhook Events Model
The following includes 4 shipments webhook events that share the same model, which are mentioned in the event
enum value under the Data Schema tab
{
"event": "shipment.creating",
"merchant": 136409261,
"created_at": "Sun Jan 29 2023 21:16:38 GMT+0300",
"data": {
"id": 362985662,
"order_id": 560695738,
"order_reference_id": 48927,
"created_at": {
"date": "2023-01-29 21:16:38.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"type": "shipment",
"courier_id": 1927161457,
"courier_name": "Shipping App",
"courier_logo": "https://company.com/logo.png",
"shipping_number": "846984645",
"tracking_number": "4324233",
"pickup_id": null,
"trackable": true,
"tracking_link": "https://www.company/tracking/tracking-express.html?submit=1&tracking-id=12345",
"label": {
"format": "pdf",
"url": "https://company.com/lable.pdf"
},
"payment_method": "cod",
"source": "api",
"status": "delivered",
"total": {
"amount": 25.5,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": 10.7,
"currency": "SAR"
},
"is_international": false,
"total_weight": {
"value": 5,
"units": "kg"
},
"packages": [
{
"item_id": 2077288690,
"external_id": null,
"name": "منتج تجريبي",
"sku": "6ytrrhrhr",
"price": {
"amount": 25.5,
"currency": "SAR"
},
"quantity": 1,
"weight": {
"value": 5,
"unit": "kg"
}
}
],
"ship_from": {
"type": "branch",
"name": "الفرع الرئيسي",
"email": "",
"phone": "966920034002",
"country": "السعودية",
"city": "Mecca",
"address_line": "Mecca,السعودية",
"street_number": null,
"block": null,
"postal_code": null,
"latitude": 21.3825905096851,
"longitude": 39.77319103068542,
"branch_id": 1987977866
},
"ship_to": {
"type": "address",
"name": "Username",
"email": "[email protected]",
"phone": "966501806978",
"country": "السعودية",
"city": "الرياض",
"address_line": " شارع 2345، الحي السلام 95128،, شارع عبدالله سنابل السلام مكة السعوديه,, الرياض, السعودية",
"street_number": "2345",
"block": "السلام",
"postal_code": "95128",
"latitude": 21.382590509685,
"longitude": 39.773191030685
},
"meta": {
"app_id": 1222362158,
"policy_options": {
"boxes": 1
}
}
}
}
Last modified: 23 days ago