Cancel a Shipment
PUT
/v1/external/shipments/{orderId}/cancel
Cancel Shipment
Request
PUT{{base_url}}/v1/external/shipments/{orderId}/cancelPath Parameters
orderId (string): The unique identifier of the order whose shipment is to be canceled.Response
200 OKapplication/jsonid (string): The unique identifier for the canceled shipment.createdAt (string): The timestamp when the cancellation was created.updatedAt (string): The timestamp when the cancellation was last updated.refundStatus (string): The status of the refund process.trackingCode (string): The tracking code associated with the shipment.Request
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/v1/external/shipments//cancel' \
--header 'Authorization: {{auth_token}}'Response Response Example
{
"id": "shp_fe75ed838d8840a5b4d545ace8fba050",
"createdAt": "1750079495822",
"updatedAt": "1750079495822",
"refundStatus": "pending",
"trackingCode": "6901910800973"
}Modified at 2025-08-04 19:55:15