POST/package/{package_id}/clone
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to clone a package for redelivery, resending the package with the same information input during the createPackage call.
The packageId value of the package to be cloned must be input as a path parameter in the request.
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 packageId value of the package to be cloned. 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
Response fields
| Output container/field | Type | Description |
|---|---|---|
| clonePackageResult | ClonePackageResponsesData | This container returns the package ID, payment cost, and tracking number for the cloned package. Occurrence: Always |
| clonePackageResult.lastMileTrackingNumber | string | The last-mile tracking number of the package. Occurrence: Conditional |
| clonePackageResult.packageId | string | The unique identifier of the package. A new packageId value is generated when a package is cloned. Occurrence: Always |
| clonePackageResult.paymentCost | Amount | The payment cost for the package. Occurrence: Conditional |
| clonePackageResult.paymentCost.currency | CurrencyCodeEnum | This enum value represents the type of currency being used. Both the value and currency fields are required/always returned when expressing cost. Occurrence: Conditional |
| clonePackageResult.paymentCost.value | string | The monetary amount, in the currency specified by the currency field. Occurrence: Conditional |
| clonePackageResult.trackingNumber | string | The tracking number for the cloned package. 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 |
|---|---|
| 201 | Created |
| 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. |
| 355045 | API_EDIS | REQUEST | Current package status does not support re-ship function. Please check. |
| 355046 | API_EDIS | REQUEST | This package have exceeded the limit of re-ship times. |
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: Clone a package
This method can be used to clone a package, based on an previously created package, for redelivery.
Input
To use this method, the ID of the packages you wish to clone 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/clone
Output
If the call is successful, HTTP status code 201 Created will be returned. The package ID, payment cost, tracking number, and last-mile tracking number (if applicable) for the cloned package will also be returned in the clonePackageResult container.