Trading_VariationType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_VariationType.h Trading_VariationType.m |
Overview
This type defines the Variation container, which provides full
details on each item variation in a multi-variation listing.
@ingroup EBayAPIInterface
Tasks
-
sku
A SKU (stock keeping unit) is an identifier defined by a seller.
property
It is only intended for the seller’s use (not for buyers).
Many sellers assign a SKU to an item of a specific type,
size, and color. For the seller’s convenience, eBay preserves the
SKU on the variation, and also on corresponding order line items.
This enables you (as a seller) use the SKU to reconcile your
eBay inventory with your own inventory system instead of using the
variation specifics. It is a good idea to track how many items of
each type, size, and color are selling so that you can restock
your shelves or update the variation quantity on eBay according to
customer demand. (eBay does not use the SKU.)
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.
If you set Item.InventoryTrackingMethod to true,
the variation SKU values are required and they must be
unique across all the seller’s active listings.
For GetItem and related calls: Only returned if the
seller specified a SKU for the variation. -
startPrice
The fixed price of all items identified by this variation.
property
For example, a “Blue, Large” variation price could be USD 10.00,
and a “Black, Medium” variation price could be USD 5.00.
Each variation requires its own price, and the prices can
be different for each variation. This enables sellers to
provide discounts on certain
variations without affecting the price of others.
Required (and always returned) for listings with variations.
You can revise a variation’s price at any time (even if it
has purchases). When you modify a variation during revise or
relist, you need to include both its StartPrice and Quantity. -
quantity
This value indicates the quantity of items in the specific variation that are
property
available for purchase. If you set Variation.Quantity to ‘0’ when
you create, revise, or relist an item listing, the variation is dropped from
the listing.
For GetItem (and other related calls that retrieve the Item
object), the Variation.Quantity value indicates the total number
of items associated with the variation, including the quantity available and the
quantity sold. To calculate the quantity available for sale, subtract
SellingStatus.QuantitySold from this value.
For ReviseFixedPriceItem:
You can revise a variation’s quantity at any time, even if
it has purchases. However, at least one variation must remain
with a non-zero quantity in order for the listing to remain active.
When you modify a variation during revise or
relist, you need to include both its StartPrice and Quantity.
If you revise the Quantity value for a variation after items have
already sold, specify the quantity available for sale.
(eBay will automatically add the
quantity sold to the value you specify.) If you set the quantity to
0 and the variation has no purchases, the variation may be
dropped from the listing.
For GetSellerTransactions: See Item.Quantity instead.
See the Trading API Guide for more details about setting and modifying a variation’s quantity. -
variationSpecifics
A list of name/value pairs that uniquely identify the variation within
property
the listing. All variations must specify the same set of names, and
each variation must provide a unique combination of values for those
names. For example, if the items vary by color and size, then every
variation must specify Color and Size as names, and no two
variations can specify the same combination of color and size values.
When you revise a listing that includes variations, you can
change names in variation specifics by using ModifyNameList. You can also add, delete, or replace individual variations as needed to match your
current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has
sales, then set the Quantity to 0.
For GetSellerEvents To keep the GetSellerEvents
response smaller, variation specifics are not returned if the
variation has a SKU. If the variation has no SKU, then
variation specifics are returned instead. Optionally, you can pass
IncludeVariationSpecifics as true in the request to force
variation specifics to be returned, even when the SKU is returned. -
unitsAvailable
Quantity of items in the seller’s inventory for this
property
Selling Manager product.
This is not the same as the quantity available in a listed item.
Required when a Selling Manager product defines variations. -
unitCost
Cost of the Selling Manager product that matches this variation.
property -
sellingStatus
Contains the variation’s quantity sold.
property
Always returned when variations are present. -
variationTitle
The title of the variation. This is a concatenation of the listing
property
title plus the values (no names) from the VariationSpecifics.
For example, if the Title is “Polo Shirt” and the variation is
for a medium pink shirt, the variation title could be
“Polo Shirt[Pink,M].
PayPal may also use this value
to identify item variations(for buyers and sellers). -
variationViewItemURL
URL for the variation on eBay. This links to eBay’s View Item page,
property
with the page configured to show details of the specified variation.
The syntax of this URL is similar to Item.ViewItemURL (not optimized
for natural search). -
delete
Deletes the specified variation from the listing. In general,
property
a listing with Item Variations must have at least one
variation with a non-zero Quantity in order to remain active.
Additional deletion rules depend
on whether you are revising or relisting.
For ReviseFixedPriceItem only:
If a variation has any purchases (i.e., an order line item was created
and QuantitySold is greather than 0), you can't
delete the variation, but you can set its quantity to zero.
If a variation has no purchases, you can delete it.
To replace a varation, you can delete it and add the new
or corrected one.
However, you can’t specify the same SKU twice in the
same request (because the intent would be ambiguous).
So, either use a new SKU for the newer variation,
or use the call twice (once to delete the variation, and
once to add the new variation with the same SKU).
For RelistFixedPriceItem only:
You can delete any variation, as long as the relisted listing
includes at least 1 variation with a non-zero quantity.
(That is, when you relist, you could delete all but one variation,
or you could delete all existing variations and add a new one.) -
sellingManagerProductInventoryStatus
Container for statistics about the Selling Manager product
property
that is associated with this variation. -
watchCount
The number of watches placed on this variation by eBay users.
property -
privateNotes
A note a user makes on an item with variations in My eBay.
property
For eBay.com, only GetMyeBaySelling (not GetItem) returns this
field, and only if you pass IncludeNotes in the request.
Only visible to the user who created the note.
Not supported as input in ReviseFixedPriceItem.
Use SetUserNotes instead.
In SoldList, notes for variations are only returned at the
Item level, not the variation level. -
discountPriceInfo
This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price
property
(MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings and auction listings with the Buy
It Now opton. STP is available on the US, UK, and German (DE) 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. Sellers should contact their account manager or Customer Service to
see if they qualify for the Strikethrough Pricing program.
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. The following
link details your legal obligations when you utilize Discount Pricing to sell items: Strikethrough Pricing Requirements
For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and
VerifyAddFixedPriceItem:
If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation. -
any
(public property)
property
Properties
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_VariationType.h
delete
Deletes the specified variation from the listing. In general,
a listing with Item Variations must have at least one
variation with a non-zero Quantity in order to remain active.
Additional deletion rules depend
on whether you are revising or relisting.
For ReviseFixedPriceItem only:
If a variation has any purchases (i.e., an order line item was created
and QuantitySold is greather than 0), you can't
delete the variation, but you can set its quantity to zero.
If a variation has no purchases, you can delete it.
To replace a varation, you can delete it and add the new
or corrected one.
However, you can’t specify the same SKU twice in the
same request (because the intent would be ambiguous).
So, either use a new SKU for the newer variation,
or use the call twice (once to delete the variation, and
once to add the new variation with the same SKU).
For RelistFixedPriceItem only:
You can delete any variation, as long as the relisted listing
includes at least 1 variation with a non-zero quantity.
(That is, when you relist, you could delete all but one variation,
or you could delete all existing variations and add a new one.)
@property (nonatomic, retain) NSNumber *delete
Discussion
Deletes the specified variation from the listing. In general,
a listing with Item Variations must have at least one
variation with a non-zero Quantity in order to remain active.
Additional deletion rules depend
on whether you are revising or relisting.
For ReviseFixedPriceItem only:
If a variation has any purchases (i.e., an order line item was created
and QuantitySold is greather than 0), you can't
delete the variation, but you can set its quantity to zero.
If a variation has no purchases, you can delete it.
To replace a varation, you can delete it and add the new
or corrected one.
However, you can’t specify the same SKU twice in the
same request (because the intent would be ambiguous).
So, either use a new SKU for the newer variation,
or use the call twice (once to delete the variation, and
once to add the new variation with the same SKU).
For RelistFixedPriceItem only:
You can delete any variation, as long as the relisted listing
includes at least 1 variation with a non-zero quantity.
(That is, when you relist, you could delete all but one variation,
or you could delete all existing variations and add a new one.)
type : NSNumber, wrapper for primitive bool
Declared In
Trading_VariationType.h
discountPriceInfo
This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price
(MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings and auction listings with the Buy
It Now opton. STP is available on the US, UK, and German (DE) 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. Sellers should contact their account manager or Customer Service to
see if they qualify for the Strikethrough Pricing program.
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. The following
link details your legal obligations when you utilize Discount Pricing to sell items: Strikethrough Pricing Requirements
For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and
VerifyAddFixedPriceItem:
If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation.
@property (nonatomic, retain) Trading_DiscountPriceInfoType *discountPriceInfo
Discussion
This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price
(MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings and auction listings with the Buy
It Now opton. STP is available on the US, UK, and German (DE) 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. Sellers should contact their account manager or Customer Service to
see if they qualify for the Strikethrough Pricing program.
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. The following
link details your legal obligations when you utilize Discount Pricing to sell items: Strikethrough Pricing Requirements
For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and
VerifyAddFixedPriceItem:
If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation.
type : class Trading_DiscountPriceInfoType
Declared In
Trading_VariationType.h
privateNotes
A note a user makes on an item with variations in My eBay.
For eBay.com, only GetMyeBaySelling (not GetItem) returns this
field, and only if you pass IncludeNotes in the request.
Only visible to the user who created the note.
Not supported as input in ReviseFixedPriceItem.
Use SetUserNotes instead.
In SoldList, notes for variations are only returned at the
Item level, not the variation level.
@property (nonatomic, retain) NSString *privateNotes
Discussion
A note a user makes on an item with variations in My eBay.
For eBay.com, only GetMyeBaySelling (not GetItem) returns this
field, and only if you pass IncludeNotes in the request.
Only visible to the user who created the note.
Not supported as input in ReviseFixedPriceItem.
Use SetUserNotes instead.
In SoldList, notes for variations are only returned at the
Item level, not the variation level.
type : NSString, wrapper for primitive string
Declared In
Trading_VariationType.h
quantity
This value indicates the quantity of items in the specific variation that are
available for purchase. If you set Variation.Quantity to ‘0’ when
you create, revise, or relist an item listing, the variation is dropped from
the listing.
For GetItem (and other related calls that retrieve the Item
object), the Variation.Quantity value indicates the total number
of items associated with the variation, including the quantity available and the
quantity sold. To calculate the quantity available for sale, subtract
SellingStatus.QuantitySold from this value.
For ReviseFixedPriceItem:
You can revise a variation’s quantity at any time, even if
it has purchases. However, at least one variation must remain
with a non-zero quantity in order for the listing to remain active.
When you modify a variation during revise or
relist, you need to include both its StartPrice and Quantity.
If you revise the Quantity value for a variation after items have
already sold, specify the quantity available for sale.
(eBay will automatically add the
quantity sold to the value you specify.) If you set the quantity to
0 and the variation has no purchases, the variation may be
dropped from the listing.
For GetSellerTransactions: See Item.Quantity instead.
See the Trading API Guide for more details about setting and modifying a variation’s quantity.
@property (nonatomic, retain) NSNumber *quantity
Discussion
This value indicates the quantity of items in the specific variation that are
available for purchase. If you set Variation.Quantity to ‘0’ when
you create, revise, or relist an item listing, the variation is dropped from
the listing.
For GetItem (and other related calls that retrieve the Item
object), the Variation.Quantity value indicates the total number
of items associated with the variation, including the quantity available and the
quantity sold. To calculate the quantity available for sale, subtract
SellingStatus.QuantitySold from this value.
For ReviseFixedPriceItem:
You can revise a variation’s quantity at any time, even if
it has purchases. However, at least one variation must remain
with a non-zero quantity in order for the listing to remain active.
When you modify a variation during revise or
relist, you need to include both its StartPrice and Quantity.
If you revise the Quantity value for a variation after items have
already sold, specify the quantity available for sale.
(eBay will automatically add the
quantity sold to the value you specify.) If you set the quantity to
0 and the variation has no purchases, the variation may be
dropped from the listing.
For GetSellerTransactions: See Item.Quantity instead.
See the Trading API Guide for more details about setting and modifying a variation’s quantity.
type : NSNumber, wrapper for primitive int
Declared In
Trading_VariationType.h
sellingManagerProductInventoryStatus
Container for statistics about the Selling Manager product
that is associated with this variation.
@property (nonatomic, retain) Trading_SellingManagerProductInventoryStatusType *sellingManagerProductInventoryStatus
Discussion
Container for statistics about the Selling Manager product
that is associated with this variation.
type : class Trading_SellingManagerProductInventoryStatusType
Declared In
Trading_VariationType.h
sellingStatus
Contains the variation’s quantity sold.
Always returned when variations are present.
@property (nonatomic, retain) Trading_SellingStatusType *sellingStatus
Discussion
Contains the variation’s quantity sold.
Always returned when variations are present.
type : class Trading_SellingStatusType
Declared In
Trading_VariationType.h
sku
A SKU (stock keeping unit) is an identifier defined by a seller.
It is only intended for the seller’s use (not for buyers).
Many sellers assign a SKU to an item of a specific type,
size, and color. For the seller’s convenience, eBay preserves the
SKU on the variation, and also on corresponding order line items.
This enables you (as a seller) use the SKU to reconcile your
eBay inventory with your own inventory system instead of using the
variation specifics. It is a good idea to track how many items of
each type, size, and color are selling so that you can restock
your shelves or update the variation quantity on eBay according to
customer demand. (eBay does not use the SKU.)
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.
If you set Item.InventoryTrackingMethod to true,
the variation SKU values are required and they must be
unique across all the seller’s active listings.
For GetItem and related calls: Only returned if the
seller specified a SKU for the variation.
@property (nonatomic, retain) NSString *sku
Discussion
A SKU (stock keeping unit) is an identifier defined by a seller.
It is only intended for the seller’s use (not for buyers).
Many sellers assign a SKU to an item of a specific type,
size, and color. For the seller’s convenience, eBay preserves the
SKU on the variation, and also on corresponding order line items.
This enables you (as a seller) use the SKU to reconcile your
eBay inventory with your own inventory system instead of using the
variation specifics. It is a good idea to track how many items of
each type, size, and color are selling so that you can restock
your shelves or update the variation quantity on eBay according to
customer demand. (eBay does not use the SKU.)
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.
If you set Item.InventoryTrackingMethod to true,
the variation SKU values are required and they must be
unique across all the seller’s active listings.
For GetItem and related calls: Only returned if the
seller specified a SKU for the variation.
type : NSString, wrapper for primitive string
Declared In
Trading_VariationType.h
startPrice
The fixed price of all items identified by this variation.
For example, a “Blue, Large” variation price could be USD 10.00,
and a “Black, Medium” variation price could be USD 5.00.
Each variation requires its own price, and the prices can
be different for each variation. This enables sellers to
provide discounts on certain
variations without affecting the price of others.
Required (and always returned) for listings with variations.
You can revise a variation’s price at any time (even if it
has purchases). When you modify a variation during revise or
relist, you need to include both its StartPrice and Quantity.
@property (nonatomic, retain) Trading_AmountType *startPrice
Discussion
The fixed price of all items identified by this variation.
For example, a “Blue, Large” variation price could be USD 10.00,
and a “Black, Medium” variation price could be USD 5.00.
Each variation requires its own price, and the prices can
be different for each variation. This enables sellers to
provide discounts on certain
variations without affecting the price of others.
Required (and always returned) for listings with variations.
You can revise a variation’s price at any time (even if it
has purchases). When you modify a variation during revise or
relist, you need to include both its StartPrice and Quantity.
type : class Trading_AmountType
Declared In
Trading_VariationType.h
unitCost
Cost of the Selling Manager product that matches this variation.
@property (nonatomic, retain) Trading_AmountType *unitCost
Discussion
Cost of the Selling Manager product that matches this variation.
type : class Trading_AmountType
Declared In
Trading_VariationType.h
unitsAvailable
Quantity of items in the seller’s inventory for this
Selling Manager product.
This is not the same as the quantity available in a listed item.
Required when a Selling Manager product defines variations.
@property (nonatomic, retain) NSNumber *unitsAvailable
Discussion
Quantity of items in the seller’s inventory for this
Selling Manager product.
This is not the same as the quantity available in a listed item.
Required when a Selling Manager product defines variations.
type : NSNumber, wrapper for primitive int
Declared In
Trading_VariationType.h
variationSpecifics
A list of name/value pairs that uniquely identify the variation within
the listing. All variations must specify the same set of names, and
each variation must provide a unique combination of values for those
names. For example, if the items vary by color and size, then every
variation must specify Color and Size as names, and no two
variations can specify the same combination of color and size values.
When you revise a listing that includes variations, you can
change names in variation specifics by using ModifyNameList. You can also add, delete, or replace individual variations as needed to match your
current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has
sales, then set the Quantity to 0.
For GetSellerEvents To keep the GetSellerEvents
response smaller, variation specifics are not returned if the
variation has a SKU. If the variation has no SKU, then
variation specifics are returned instead. Optionally, you can pass
IncludeVariationSpecifics as true in the request to force
variation specifics to be returned, even when the SKU is returned.
@property (nonatomic, retain) Trading_NameValueListArrayType *variationSpecifics
Discussion
A list of name/value pairs that uniquely identify the variation within
the listing. All variations must specify the same set of names, and
each variation must provide a unique combination of values for those
names. For example, if the items vary by color and size, then every
variation must specify Color and Size as names, and no two
variations can specify the same combination of color and size values.
When you revise a listing that includes variations, you can
change names in variation specifics by using ModifyNameList. You can also add, delete, or replace individual variations as needed to match your
current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has
sales, then set the Quantity to 0.
For GetSellerEvents To keep the GetSellerEvents
response smaller, variation specifics are not returned if the
variation has a SKU. If the variation has no SKU, then
variation specifics are returned instead. Optionally, you can pass
IncludeVariationSpecifics as true in the request to force
variation specifics to be returned, even when the SKU is returned.
type : class Trading_NameValueListArrayType
Declared In
Trading_VariationType.h
variationTitle
The title of the variation. This is a concatenation of the listing
title plus the values (no names) from the VariationSpecifics.
For example, if the Title is “Polo Shirt” and the variation is
for a medium pink shirt, the variation title could be
“Polo Shirt[Pink,M].
PayPal may also use this value
to identify item variations(for buyers and sellers).
@property (nonatomic, retain) NSString *variationTitle
Discussion
The title of the variation. This is a concatenation of the listing
title plus the values (no names) from the VariationSpecifics.
For example, if the Title is “Polo Shirt” and the variation is
for a medium pink shirt, the variation title could be
“Polo Shirt[Pink,M].
PayPal may also use this value
to identify item variations(for buyers and sellers).
type : NSString, wrapper for primitive string
Declared In
Trading_VariationType.h
variationViewItemURL
URL for the variation on eBay. This links to eBay’s View Item page,
with the page configured to show details of the specified variation.
The syntax of this URL is similar to Item.ViewItemURL (not optimized
for natural search).
@property (nonatomic, retain) NSString *variationViewItemURL
Discussion
URL for the variation on eBay. This links to eBay’s View Item page,
with the page configured to show details of the specified variation.
The syntax of this URL is similar to Item.ViewItemURL (not optimized
for natural search).
type : NSString, wrapper for primitive string
Declared In
Trading_VariationType.h