Salla Docs
Create Shipment
POST/shipmentsThis endpoint allows you to create a shipment related to your store directly from this endpoint.
Request
The id of the shipment. Required if shipment_type = "return"
Shipment Courier ID. List of Shipment companies can be found [here](api-5394239.
Whether or not to allow the pending shipment, which was generated during the order creation, to be replace by the new shipment that is assigned by the Order Management App
Shipment Type.
The shipment policy options details.
Shipment Boxes
Shipment Payment Method
Required if payment_method is cod
Shipment Cash On Delivery Amount. Value between 0 and 9999
Shipment Cash On Delivery Currency. You may refer to the external Merchant API Docs of the List of Currencies here
Shipment Ship To Name
Shipment Ship To Email
Shipment Ship To Phone
Shipment Ship To Country. Find a complete list of countries here.
Shipment Ship To CityFind a complete list of cities here.
Shipment Ship To Address Line
Shipment Ship To Street Number
Shipment Ship To Block
Shipment Ship To Postal Code
Shipment Ship From Type
Shipment Ship From Branch ID
Shipment Ship From Name
Shipment Ship From Phone
Shipment Ship From Country
Country code. required if country_id is not set
Country ID. required if country_code is not set
Shipment Ship From City
Shipment Ship From Address Line
Shipment Ship From Street Number
Shipment Ship From Block
Shipment Ship From Postal Code
Shipment package details.
Shipment Packages Name
Shipment Packages SKU
Shipment Packages Quantity
{
"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
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
A unique identifier for the shipment. Shipment list can be found here.
A unique identifier for the order associated with the shipment. List of orders can be found here
This field refers to a reference ID that can be used to look up additional information about the order
Date and time of shipment creations.
Shipment Type
Shipment Courier ID. Find a complete list of Shipment companies here
Shipment Courier Name
Shipment Courier Logo
Shipment Shipping Number
Shipment Tracking Number
Shipment Pickup ID
Whether or not the shipment is trackable
Shipment Tracking Link
Shipment label details.
Shipment Payment Method
Shipment Source.
Shipment Status.
Shipment total.
Shipment cash on delivery details.
Whether the shipment is shipped internationally
Shipment total weight.
Shipment packages details.
Shipment source details.
Shipment destination details.
"Metadata" is data that describes other data, providing details on its creation, format, and context.
{
"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"
}
}
]
}
}