POST/package/bulk_delete_packages
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to delete multiple packages.
The package ID values for the packages to be deleted must be input in the packageIds array of the request.
Note: Packages can only be deleted once they have been cancelled through the cancelPackage or bulkCancelPackages methods and no longer have a tracking number associated with them.
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 | DeletePackagesRequestData | This container is used to specify the package ID values for the packages being deleted. Occurrence: Required |
| requests.packageIds | array of string | This comma-delimited array lists the unique identifiers of the packages being deleted. These values must be for packages that have been cancelled and do not have tracking numbers associated with them. Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| responses | array of DeletePackagesResponsesData | This array returns the result code and message for each deleted package. Each package is denoted by its package ID value. Occurrence: Always |
| responses.message | string | This string returns any additional information about the deletion of the package. Occurrence: Always |
| responses.packageId | string | The unique identifier of the deleted package. Occurrence: Always |
| responses.resultCode | string | The result code detailing the result of the deletion 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. |
| 355064 | API_EDIS | REQUEST | The package cannot be deleted due to its current status. Please check the status and try again. |
| 355400 | API_EDIS | REQUEST | The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list. |
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: Delete multiple packages
This method can be used to delete multiple cancelled packages using one call.
Input
To use this method, the IDs of the packages you wish to delete must be input in the packageIds array and be delimited by a comma. Note that these package ID values must be for packages that have been cancelled and no longer have a tracking number.
POSThttps://api.ebay.com/sell/edelivery_international_shipping/v1/package/bulk_delete_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 deleted will be returned in the responses array.