Light Mode
Create Shipment
POST
/shipmentsLast modified: a month ago
This endpoint allows you to create a shipment related to your store directly from this endpoint.
Request
Body Params application/json
object {0}
Example
{
"courier_id": 1927161457,
"order_id": 54534523,
"overwrite_exists_pending": true,
"shipment_type": "shipment",
"policy_options": {
"boxes": 1
},
"payment_method": "pre_paid",
"cash_on_delivery": {
"amount": 10.7,
"currency": "SAR"
},
"ship_to": {
"name": "Mohammed Khalid",
"email": "[email protected]",
"phone": "966501636784",
"country_id": 1473353380,
"city_id": 1473353380,
"postal_code": "95128",
"street_number": "2345",
"block": "السلام",
"address_line": "شارع عبدالله سنابل السلام مكة السعوديه",
"geo_coordinates": {
"lat": 21.3825905096851,
"lng": 39.77319103068542
}
},
"ship_from": {
"type": "branch",
"branch_id": 1987977866,
"name": "الفرع الرئيسي",
"email": "",
"phone": "966501636784",
"country": [
"السعودية"
],
"country_id": 1473353380,
"country_code": "SA",
"city": [
"Mecca"
],
"city_id": 1939592358,
"address_line": "Mecca,السعودية",
"street_number": "1234",
"block": "block",
"postal_code": "1234",
"geo_coordinates": {
"latitude": [
21.3825905096851
],
"longitude": [
39.77319103068542
]
}
},
"packages": [
{
"item_id": 2077288690,
"external_id": null,
"name": " منتج تجريبي",
"sku": "52743-145",
"quantity": 1,
"price": {
"amount": 25.5,
"currency": "SAR"
},
"weight": {
"value": 5,
"units": "kg"
}
}
]
}
Request samples
Responses
Success(200)
Error Validation(422)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
Example
{
"status": 200,
"success": true,
"data": {
"id": 362985662,
"order_id": 560695738,
"order_reference_id": 48927,
"created_at": {
"date": "2023-01-12 14:19:08.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"type": "shipment",
"courier_id": 814202285,
"courier_name": "DHL",
"courier_logo": "https://company.com/logo.png",
"shipping_number": "0",
"tracking_number": "0",
"pickup_id": null,
"trackable": true,
"tracking_link": "https://www.company/tracking/tracking-express.html?submit=1&tracking-id=12345",
"label": [],
"payment_method": "cod",
"source": "api",
"status": "creating",
"total": {
"amount": 100,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": "10.70",
"currency": "SAR"
},
"meta": {
"app_id": null,
"policy_options": {
"types": "",
"boxes": "1"
}
},
"ship_from": {
"type": "branch",
"name": "Riyadh",
"email": "",
"phone": "0555555555",
"country": "السعودية",
"city": "RIYADH",
"address_line": "7687 طريق الملك فهد الفرعي,الملك فهد,12262, 7687 طريق الملك فهد الفرعي، الملك فهد، الرياض 12262 3010، السعودية, RIYADH,السعودية",
"street_number": "7687 طريق الملك فهد الفرعي",
"block": "الملك فهد",
"postal_code": "12262",
"latitude": 24.7431373,
"longitude": 46.6570741,
"branch_id": 1723506348
},
"ship_to": {
"type": "address",
"name": "Username",
"email": "[email protected]",
"phone": "055-555-555",
"country": "السعودية",
"city": "الرياض",
"address_line": " شارع 2345، الحي السلام 95128،, شارع عبدالله سنابل السلام مكة السعوديه,, الرياض, السعودية",
"street_number": "2345",
"block": "السلام",
"postal_code": "95128",
"latitude": 21.382590509685,
"longitude": 39.773191030685
},
"packages": [
{
"item_id": 2077288690,
"external_id": null,
"name": "منتج تجريبي",
"sku": "6ytrrhrhr",
"price": {
"amount": "50.00",
"currency": "SAR"
},
"quantity": 2,
"weight": {
"value": "1.00",
"unit": "kg"
}
}
]
}
}
Last modified: a month ago