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
Cash on delivery details.
Shipment Cash On Delivery Amount
Shipment Cash On Delivery Currency. You may refer to the external Merchant API Docs of the List of Currencies here
Shipment destination details.
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 Address Line
Shipment Ship To Street Number
Shipment Ship To Block
Shipment Ship To Postal Code
Shipment source details.
Shipment Ship From Type
Shipment Ship From Name
Shipment Ship From Phone
Shipment Ship From Country
Shipment Ship From City
Shipment Ship From Address Line
Shipment Ship From Street Number
Shipment Ship From Block
Shipment Ship From Postal Code
Shipment Ship From Latitude
Shipment Ship From Longitude
Shipment Ship From Branch ID
Shipment package details.
Shipment Packages Name
Shipment Packages SKU
Shipment Packages Quantity
{
"shipment_id": 0,
"courier_id": 1723506348,
"order_id": 28475601,
"overwrite_exists_pending": true,
"shipment_type": "return",
"policy_options": {
"boxes": 2
},
"payment_method": "cod",
"cash_on_delivery": {
"amount": 200,
"currency": "SAR"
},
"ship_to": {
"name": "username",
"email": "username@gmailcom",
"phone": "555-555-555",
"country_id": "1473353380",
"city_id": "123",
"address_line": "Tahlia Street",
"street_number": "120",
"block": "Block AB",
"postal_code": "1000",
"geo_coordinates": {
"lat": 10.1234,
"lng": 43.2105
}
},
"ship_from": {
"type": "address",
"name": "Username",
"email": "[email protected]",
"phone": "555-555-555",
"country": "Saudi Arabia",
"city": "Mecca",
"address_line": "Mecca Street",
"street_number": "string",
"block": "string",
"postal_code": "string",
"latitude": 10.2345,
"longitude": 54.321,
"branch_id": 194309
},
"packages": [
{
"name": "Package 1",
"sku": "SKU-123-456",
"price": {
"amount": 200,
"currency": "sar"
},
"quantity": 2,
"weight": {
"value": 3,
"units": "kg"
}
}
]
}Request samples
[api.label.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": "anim",
"success": false,
"data": [
{
"id": -32645125.3234493,
"order_id": 93507000.57084745,
"order_reference_id": null,
"created_at": {
"date": "2024-02-12T14:09:27.127Z",
"timezone_type": 70745330,
"timezone": "America/Sao_Paulo"
},
"type": "shipment",
"courier_id": 8948698,
"courier_name": "esse numquam doloribus",
"courier_logo": "cupidatat fugiat qui id tempor",
"shipping_number": "velit est",
"tracking_number": "sint ad minim cillum",
"pickup_id": null,
"trackable": true,
"tracking_link": "https://high-level-footstep.name",
"label": {
"format": "2024-02-13T00:46:47.084Z",
"url": "http://wasteful-facet.name"
},
"payment_method": "pre_paid",
"source": "tempor",
"status": "delivered",
"total": {
"amount": -87094298.04461335,
"currency": "SHP"
},
"cash_on_delivery": {
"amount": 42126404.63522267,
"currency": "ILS"
},
"is_international": false,
"total_weight": {
"value": -57799137.09990661,
"units": "mollit laboris fugiat pariatur consectetur"
},
"packages": [
{
"item_id": 62924221,
"external_id": null,
"name": "explicabo dolores nesciunt",
"sku": "dolore non sed est incididunt",
"price": {
"amount": 88829593.05470765,
"currency": "SOS"
},
"quantity": -32542040,
"weight": {
"value": 38160911,
"units": "kg"
}
}
],
"ship_from": {
"type": "id",
"name": "laudantium ullam earum",
"email": "[email protected]",
"phone": "(065) 723-2847",
"country": "ليبيريا",
"city": "عجمان",
"address_line": "Excepteur",
"street_number": null,
"block": null,
"postal_code": null,
"latitude": 8.5867,
"longitude": -69.9668,
"branch_id": -1346031
},
"ship_to": {
"type": "dolor veniam dolor",
"name": "eligendi accusantium eum",
"email": "[email protected]",
"phone": "453.850.0142 x8168",
"country": "بهماس",
"city": "الإسكندرية",
"address_line": "ad sunt dolor",
"street_number": "37934 جادة بركات",
"block": "sunt aliquip deserunt Ut",
"postal_code": "Duis sit do proident occaecat",
"latitude": -39.1654,
"longitude": 93.9262
},
"meta": {
"app_id": 3349694,
"policy_options": {
"shipment_content_type": [
"document"
],
"packaging_type": [
"pallet"
],
"boxes": -69384132
}
}
}
]
}