Cancel Label
Cancel a shipping label and obtain refunds for those labels that are “pre-paid”.
POST Request
Cancel purchased labels
Label can be cancelled using one of transction id, client request id, or tracking info. If the label is pre-paid using Teapplix Postage Meter, it will be refunded according to our refund policy after cancel.
| Property | Type | Description | Constraints |
|---|---|---|---|
TxnId |
string | TxnId (Order Id) to cancel label. If the order has extra packages, all packages will be cancelled. | |
ClientRequestId |
string | Cancel label by Client Request Id. This is used if you originally used PurchaseLabel API to generate a label without an Order | |
TrackingInfo |
Tracking Info | Tracking info | |
Force |
boolean | Mark order as unshipped in case of FedEx and UPS label cancel error |
Tracking Info
Tracking info
| Property | Type | Description | Constraints |
|---|---|---|---|
TrackingNumber |
string | Tracking number of shipment | Max-Length: 50 |
CarrierName |
string | Carrier name which is assigned with tracking | |
SSCC |
string | Serial Shipping Container Code |
POST Response - 200
CancelLabelResult
Result of cancelling a previously purchased label
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version. | |
Status |
string | Operation status: 'Cancelled' on success. | RequiredOne of: Cancelled |
Message |
string | Human-readable result message. | |
Description |
string[] | Detailed description |
POST Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Response - 500
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |