POST/package/bulk_cancel_packages
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to cancel multiple packages and their associated tracking numbers.
The package ID values for the packages to be canceled must be input in the packageIds array of the request.
Note: Packages cannot be cancelled 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
This method has no URI parameters.
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
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| requests | CancelPackagesRequestData | This container is used to specify the package ID values for the packages being canceled. Occurrence: Required |
| requests.packageIds | array of string | This comma-delimited array lists the unique identifiers of the packages being canceled. Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| responses | array of CancelPackagesResponsesData | This array returns the result code and message for each cancelled package. Each package is denoted by its package ID value. Occurrence: Always |
| responses.message | string | This string returns any additional information about the cancelation of the package. Occurrence: Always |
| responses.packageId | string | The unique identifier of the canceled package. Occurrence: Always |
| responses.resultCode | string | The result code detailing the results cancelation process. Occurrence: Always |
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 |
|---|---|
| 200 | OK |
| 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 multiple packages
This method can be used to cancel multiple packages and their tracking numbers.
Input
To use this method, the IDs of the packages you wish to cancel must be input in the packageIds array and be delimited by a comma.
POSThttps://api.ebay.com/sell/edelivery_international_shipping/v1/package/bulk_cancel_packages
Output
If the call is successful, HTTPS result code 200 OK will be returned, and the result code, message, and identifier of each package that has been cancelled will be returned in the responses array.