createBundle: eBay Edelivery_international_shipping API

POST/bundle

Important! This method is only available for Greater-China based sellers with an active eDIS account.

This method is used to create a bundle for multiple packages in an order.

To create a bundle, the consign address to be associated with the bundle and the tracking numbers of the packages to be used in the bundle must be specified in the request.

If the call is successful, the bundleId for the newly created bundle will be returned.

Note: Sellers should keep track of the returned bundleId, as there is no programmatic way to retrieve this value at this time.

Input

Resource URI

POST https://api.ebay.com/sell/edelivery_international_shipping/v1/bundle

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 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

Copy complete valid JSON to clipboard

{ /* CreateBundleRequest */

"bundle" :

{ /* CreateBundleRequestData */

"consignPreferenceId" : "string",

"trackingNumbers" : [

"string"

]

}

Request fields

Input container/field	Type	Description
bundle	CreateBundleRequestData	This container is used to specify the information needed to create a bundle, such as the consign address associated with the bundle and the tracking numbers of the packages to be included in the bundle. Occurrence: Required
bundle.consignPreferenceId	string	The unique identifier of the consign address to be associated with the bundle. This ID can be retrieved using the getConsignPreferences method. Occurrence: Required
bundle.trackingNumbers	array of string	This array specifies the tracking numbers of the packages to be included in the bundle. Tracking numbers are returned when creating a package through the createPackage method. Occurrence: Required

Input container/field

Type

Description

bundle

CreateBundleRequestData

This container is used to specify the information needed to create a bundle, such as the consign address associated with the bundle and the tracking numbers of the packages to be included in the bundle.

Occurrence: Required

bundle.consignPreferenceId

string

The unique identifier of the consign address to be associated with the bundle.

This ID can be retrieved using the getConsignPreferences method.

Occurrence: Required

bundle.trackingNumbers

array of string

This array specifies the tracking numbers of the packages to be included in the bundle.

Tracking numbers are returned when creating a package through the createPackage method.

Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* CreateBundleResponse */

"bundle" :

{ /* CreateBundleResponseData */

"bundleId" : "string"

}

Response fields

Output container/field	Type	Description
bundle	CreateBundleResponseData	This container returns information about the newly created bundle, such as its bundleId value. Occurrence: Always
bundle.bundleId	string	The unique identifier of the newly created bundle. Occurrence: Always

Output container/field

Type

Description

bundle

CreateBundleResponseData

This container returns information about the newly created bundle, such as its bundleId value.

Occurrence: Always

bundle.bundleId

string

The unique identifier of the newly created 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
201	Created
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.
355078	API_EDIS	REQUEST	Missing consign preference ID. Please check.
355079	API_EDIS	REQUEST	Missing tracking numbers. Please check.
355080	API_EDIS	REQUEST	Please choose packages with same consign preference option.
355081	API_EDIS	REQUEST	Total weight exceeded. Please check.
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: Create a bundle

This method can be used to create a bundle of one or more packages specified by their tracking numbers. Once the bundle has been created, the bundle ID value will be returned in the response.

Input

To use this method, the following information must be provided in the request payload: the consignPreferenceId to be associated with the bundle and the trackingNumbers of each package to be included in the bundle.

POSThttps://api.ebay.com/sell/edelivery_international_shipping/v1/bundle

Output

If the call is successful, HTTP status code 201 Created will be returned along with the bundleId value for the newly created bundle.