POST/package/{package_id}/cancel
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to cancel a package and its associated tracking number.
The packageId value of the package to be canceled must be input as a path parameter in the request.
Note: Packages cannot be canceled if they are currently being processed.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| package_id | string | This path parameter specifies the unique identifier of the package being canceled. This ID value is returned when creating a package through the createPackage method. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/scope/sell.edelivery
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
This call has no payload.
Response fields
This call has no field definitions.
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 355000 | API_EDIS | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 355004 | API_EDIS | REQUEST | The specified packageId {packageId} is not recognized. Please check and try again. |
| 355036 | API_EDIS | REQUEST | Package processing. Please try again later. |
| 355037 | API_EDIS | REQUEST | Invalid packageId {packageId}. Please verify and try again. |
| 355042 | API_EDIS | REQUEST | The package cannot be cancelled due to its current status. Please check status and try again. |
| 355044 | API_EDIS | REQUEST | Cancel failed on logistic service provider side. Please contact logistic customer service for help. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Cancel a package
This method can be used to cancel a package and its tracking number.
Input
To use this method, the ID of the packages you wish to cancel must be input in the package_id path parameter. No other request payload is required.
POSThttps://api.ebay.com/sell/edelivery_international_shipping/v1/package/1********6/cancel
Output
If the call is successful, HTTP status code 204 No Content will be returned, and the package and its associated tracking number will be cancelled.