eBay Shopping APIVersion 1085

VariationType

This type is used by the Variation container, which provides full details on each item variation in a multiple-variation listing. A Variation container is returned for each product variation within a multiple-variation listing.

Type that uses VariationType:

Calls that use VariationType:

Fields



DiscountPriceInfo ( DiscountPriceInfoType ) [0..1]
This container provides information for a single variation (within a multiple-variation listing) that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites, while MAP is available only on the US site.

Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a 'special account flag' (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. STP is intended for eBay partners and their sellers only.

As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing.
See the Field Index to learn which calls use DiscountPriceInfo.

ProductID ( ProductIDType (string) ) [0..1]
This field is the unique identifier of the product variation. This identfier can either be an eBay Product ID (also known as an ePID), or a Global Trade Item Number (GTIN) such as UPC, EAN, or ISBN. This field is only returned if the seller has supplied an ePID or GTIN value for the each variation within a multiple-variation listing.

The type attribute's value indicates the type of product identifier.
See the Field Index to learn which calls use ProductID.

Quantity ( int ) [0..1]
This field shows the total quantity associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract the corresponding Variation.SellingStatus.QuantitySold value from this value.

Generally, this integer value will be '1' or greater, but it is possible that the value will be '0' if the variation is currently out of stock, but the seller is using the 'Out-of-Stock Control' feature. When the seller uses the 'Out-of-Stock Control' feature, an item (or item variation) will still surface in search results, although that particular item (or item variation) will not be purchasable.
See the Field Index to learn which calls use Quantity.

QuantitySold ( int ) [0..1]
Not used by any call.

This field is no longer Not used. The quantity sold for the variation is now shown in the Variation.SellingStatus.QuantitySold field.
See the Field Index to learn which calls use QuantitySold.

SellingStatus ( SellingStatusType ) [0..1]
This container shows the quantity sold for the variation, including the quantity that is sold through 'In-Store Pickup' (a logistics option that is only available to a select number of large US sellers with 'brick and mortar' stores). The SellingStatus container is returned for each item variation, even if the quantity sold value is '0'.
See the Field Index to learn which calls use SellingStatus.

SKU ( string ) [0..1]
A SKU (stock keeping unit) is a seller-defined identifier. It is only intended for the seller's use (not necessarily for buyers). A SKU value is not required, but many large sellers like to add SKU values for their products. If SKU values are defined for variations in a multiple-variation listing, the seller can specify a variation's SKU value in the VariationSKU field of a GetSingleItem call to retrieve details on that particular variation. The VariationSKU field is not available in the GetMultipleItems call.

If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU.

This field is only returned if the seller specified a SKU for the variation.
See the Field Index to learn which calls use SKU.

StartPrice ( AmountType (double) ) [0..1]
The fixed price for this item variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 8.00.

The StartPrice is mandatory for each variation, regardless of whether the price is the same for all variations, or if the price differs for different variations. This field will be returned for each Variation container.
See the Field Index to learn which calls use StartPrice.

VariationSpecifics ( NameValueListArrayType ) [0..1]
A list of name/value pairs that uniquely identify the variation within the listing. All variations specify the same set of names, and each variation provides a unique combination of values for those names. For example, if the items vary by color and size, then every variation specifies Color and Size as names, and no two variations can specify the same combination of color and size values. Use this information to identify a variation of interest when you communicate with the seller.

If your application supports PlaceOffer (in the Trading API), you use this information to uniquely identify the variation that you want to purchase.
See the Field Index to learn which calls use VariationSpecifics.