Bundle

Type defining the bundle container of a product bundle. Product bundle data is included in createBundles and updateBundlescalls, and returned in findBundles and getBundles calls.

Types that use Bundle:

Calls that use one or more fields of Bundle:

Fields

bundleID ( long )
bundleName ( string )
bundleStatus ( BundleStatusEnum )
isoCurrencyCode ( int )
primarySKU ( string )
relatedProductGroup ( RelatedProductGroup )
scheduledEndTime ( dateTime )
scheduledStartTime ( dateTime )
site ( GlobalId (token) )

bundleID ( long ) [0..1]
Unique identifier for a product bundle. bundleID is a required field for the deleteBundles, getBundles, and updateBundleStatus calls. For the updateBundles call, either the bundleID, the bundleName, or both values, must be included in the request. The bundleID is always returned for all product bundles that are successfully created, updated, retrieved, and deleted with the corresponding API calls.
See the Field Index to learn which calls use bundleID.

bundleName ( string ) [1]
The name of the product bundle. bundleName is a required field for the createBundles and updateBundles calls. The bundleName is only available to you as a seller, and can assist you in managing your offers. The bundleName is always returned for all product bundles that are successfully created, updated, retrieved, and deleted with the corresponding API calls.
See the Field Index to learn which calls use bundleName.

bundleStatus ( see BundleStatusEnum for possible values ) [0..1]
This enumeration value indicates the current status of a product bundle. A bundleStatus value is required when using the updateBundleStatus call, and is optional when using the createBundles or updateBundles calls. In both update calls, the specified value will change the state of the existing product bundle if the call is successful.

In the createBundles call, the common use case is to create a new product bundle and have that product bundle automatically activated once the scheduledStartTime is reached. For this use case, the bundleStatus field is not necessarily. However, there may a use case where a seller wants to create a new product bundle, but does not want it active yet, even after the scheduledStartTime is reached. In this case, the seller would include the bundleStatus field and set its value to Disabled.

The bundleStatus field is always returned in the findBundles and getBundles calls if matching product bundle(s) are returned.
See the Field Index to learn which calls use bundleStatus.

isoCurrencyCode ( int ) [0..1]
Currency representation based on ISO 4217 Standard: http://www.iso.org/iso/currency_codes_list-1 Every currency has the following attributes:
  • Numeric Code - 3 Digits Zero Padded Numeric Code, which uniquely identifies a currency.
  • Alphabetic Code - 3 Letter Alphabetic Code, which uniquely identifies a currency.
  • Currency - The name of the currency
  • Entity - The country/Entity, which uses this currency.
This type exposes only a subset of ISO 4217. The enumeration represents the Alphabetic Code. Comments are included for quick reference.
See the Field Index to learn which calls use isoCurrencyCode.

primarySKU ( string ) [1..500]
The seller-defined SKU (Stock Keeping Unit) value of the primary product. All related products in a product bundle are associated with this primary product SKU, appear on the primary product's listings, and are eligible for the product bundle discount. The primarySKU is always returned for all product bundles that are successfully created, updated, retrieved, and deleted with the corresponding API calls.

Up to 500 primarySKU values may be used in a product bundle so the same set of related products is displayed on each primary product's listings.
See the Field Index to learn which calls use primarySKU.

relatedProductGroup ( RelatedProductGroup ) [1..*]
Container consisting of detailed information on a related product group. Related product groups are tied to the primary product in a product bundle, and there can be multiple related product groups in a product bundle.
See the Field Index to learn which calls use relatedProductGroup.

scheduledEndTime ( dateTime ) [1]
This dateTime value indicates the scheduled end time of a product bundle. Once the scheduledEndTime value is reached, the product bundle becomes inactive on eBay and changes to the Ended state. The following dateTime format is used: YYYY-mm-DDTHH:MM:SS + Tz offset. If time zone offset is not set, then time zone will be defaulted to MST.

If time (HH:MM:SS) is not set, then time will be defaulted to 00:00:00 MST.

scheduledEndTime is a required field for the createBundles and updateBundles calls and its value should be further into the future than the scheduledStartTime. The scheduledEndTime is always returned for all product bundles that are successfully retrieved with the findBundles and getBundles calls.
See the Field Index to learn which calls use scheduledEndTime.

scheduledStartTime ( dateTime ) [1]
This dateTime value indicates the scheduled start time of a product bundle. Once the scheduledStartTime value is reached, the product bundle becomes active on eBay and remains active until the scheduledEndTime is reached, or until the product bundle is disabled or ended on the site or through the updateBundles or updateBundleStatus calls. The following dateTime format is used: YYYY-mm-DDTHH:MM:SS + Tz offset. If time zone offset is not set, then time zone will be defaulted to MST.

If time (HH:MM:SS) is not set, then time will be defaulted to 00:00:00 MST.

scheduledStartTime is a required field for the createBundles and updateBundles calls. The scheduledStartTime is always returned for all product bundles that are successfully retrieved with the findBundles and getBundles calls.
See the Field Index to learn which calls use scheduledStartTime.

site ( GlobalId (token) ) [1]
This GlobalId value (such as EBAY-US) indicates the listing site on which the product bundle will appear. This field is required for the createBundles and updateBundles calls, and is always returned for matching product bundles in the findBundles and getBundles calls.
See the Field Index to learn which calls use site.

Copyright © 2011–2012 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developer Network and API License Agreement.