Light Mode
Cancel Order Shipment
DeprecatedPOST
/orders/{order_id}/cancel-shipmentModified at:Â 6 days ago
This endpoint allows you to cancel specific Order Shipment by providing the ID of the order you want to cancel in the order.id path parameter.
💡 Note
You will need to send the parameters in your request: shipment_number and shipment_type
Request
Path Params
order_id
integerÂ
required
The Order ID
Body Params application/json
shipment_number
stringÂ
required
Shipment Number
Example:
846984644455Ali
shipment_type
enum<string>Â
required
Shipment Type; either shipment
or return
Allowed values:
shipmentreturn
Example:
shipment
Example
{
"shipment_number": "846984644455",
"shipment_type": "shipment"
}
Request samples
Responses
Success(200)
Not Found(404)
422(422)
HTTP Code:Â 200
Content Type :Â JSONapplication/json
Data Schema
status
numberÂ
optional
Response status Code
Example:
200
success
booleanÂ
optional
Response flag
Default:
true
data
object  | nullÂ
optional
message
stringÂ
optional
Example:
تم الغاء بوليصة الشØÙ† (846984644455)
Example
Example | Cancellation Success
{
"status": 200,
"success": true,
"data": null,
"message": "تم الغاء بوليصة الشØÙ† (846984644455)"
}
Modified at 6 days ago