Salla Docs
Return Shipment
POST/shipments/{shipment_id}/returnThis endpoint allows you to return specific shipment by passing the shipment_id as a path parameter.
Request
Shipment ID
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": 200,
"success": true,
"data": {
"id": 362985662,
"order_id": 560695738,
"order_reference_id": 48927,
"created_at": {
"date": "2023-01-16 23:37:59.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"type": "return",
"courier_id": 814202285,
"courier_name": "DHL",
"courier_logo": "https://company.com/logo.png",
"shipping_number": "23424234354434",
"tracking_number": "23424234354434",
"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": []
},
"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"
}
}
]
}
}