Cancel Shipping Label
Notes
- This endpoint will cancel the shipping label for a fulfillment. The fulfillment will be otherwise unaffected.
- Important Note: executing this request does not mark the fulfillment as unshipped. Refer to Cancel Shipping Label & Mark Unshipped for that workflow.
- The HasShippingLabel property on the Fulfillment entity indicates if a shipping label exists
- If the specified FulfillmentID is valid but the fulfillment does not have a shipping label, the response will be 404 Not Found
- A successful request will cancel the label with the shipping label partner, delete the shipping label document, and set the HasShippingLabel property of the fulfillment to false
- On success, the response status will be 204 No Content
Resource URL / Endpoint
DELETE https://api.channeladvisor.com/v1/Fulfillments(FulfillmentID)/Label
Important and/or Required Parameters
Property | Required | Note |
---|---|---|
FulfillmentID | Yes | Include in URL. The ChannelAdvisor generated unique identifier for the Fulfillment. |
Example Request
DELETE https://api.channeladvisor.com/v1/Fulfillments(123456789)/Label?access_token=xxxxxxxxxx
Example Response (Success)
204 No Content