Skip to main content
POST
/
shipping
/
labels
/
cancel
Cancel a shipping label
curl --request POST \
  --url https://api.salesive.com/api/v1/shipping/labels/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderId": "6640c1b2d4e5f60102030406"
}
'
{
  "status": 200,
  "success": true,
  "message": "Cancel a shipping label",
  "data": null
}
Cancels the carrier-aggregator label for an order’s shipment and marks the shipment as cancelled. Cannot cancel a shipment that is already delivered or cancelled. The order must belong to the store bound to the app token. Requires the WRITE_SHIPPING scope.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Body

application/json
​
orderId
string
required

ObjectId of the order whose label should be cancelled.

Response

Cancel a shipping label.

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
null

No payload is returned for this operation.