GET/bundle/{bundle_id}
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method is used to retrieved information about a specific bundle based on the provided bundle ID value.
The bundle_id value of the bundle to be retrieved must be input as a path parameter in the request. If the call is successful, information about the bundle is returned, such as its associated consign preference ID and the tracking numbers of each package in the bundle.
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 |
|---|---|---|
| bundle_id | string | This path parameter specifies the unique identifier of the bundle being retrieved. This ID value is returned when creating a bundle through the createBundle method. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the client credentials 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 |
|---|---|---|
| bundleDetail | BundleDetailResponseData | This container returns information about the retrieved bundle, such as its tracking numbers and consign preference ID. Occurrence: Always |
| bundleDetail.consignPreferenceId | string | The unique identifier of the consign address associated with the retrieved bundle. Occurrence: Always |
| bundleDetail.trackingNumbers | array of string | This array specifies the tracking numbers of the packages included in the bundle. 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 |
| 400 | Bad Request |
| 401 | Unauthorized |
| 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. |
| 355082 | API_EDIS | REQUEST | No permission to access requested data. |
| 355083 | API_EDIS | REQUEST | Missing or invalid bundle_id value. |
| 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: Retrieve a bundle
This method can be used to retrieve a bundle based on the provided bundle ID value.
Input
To use this method, the ID of the bundle for which to retrieve must be input in the bundle_id path parameter. No other request payload is required.
GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/bundle/G********K
Output
If the call is successful, the consignPreferenceId and the trackingNumbers associated with the specified bundle will be returned in the bundleDetail container.