Endpoint - CancelLabelEndpoint

Cancels all labels for the consignment by OrderId. If your integration does not support label cancellation implement an error message from this method.

Request

POST

CancelLabelRequest

Field NameTypeDescription
AuthorizationTokenGuidAuthorization token uniquely identifying each integration profile
OrderReferenceStringThe Linnworks unique order ID - this corresponds to the OrderId field in GenerateLabel

Sample

{
  "AuthorizationToken": "a8e53e86eead4b69beaa0afcc29b67fb",
  "OrderReference": "ORDERREFERENCE"
}

Response

CancelLabelResponse

Field NameTypeDescription
IsErrorBooleanIndicates if there is an error
ErrorMessageString / nullError message
{
  "IsError": false,
  "ErrorMessage": null
}