eBay Trading API
|
Enables a seller to specify the definition of a new fixed-price listing and submit the definition to eBay without creating a listing. This enables the seller to test the item definition and get listing fees before actually listing the item. The listing fees may be different from the listing fees returned by AddFixedPriceItem.
The call validates your input fields against the schema. However, some business-logic checks performed for an AddFixedPriceItem call are not executed. For more information, please see the following Knowledge Base article about VerifyAddItem (the logic is the same for VerifyAddFixedPriceItem):
VerifyAddFixedPriceItem returns Success with no Errors, but AddFixedPriceItem returns Failure with Errors
There may be cases in which VerifyAddFixedPriceItem behaves differently from AddFixedPriceItem and returns a different result.
Note: When you use the VerifyAddFixedPriceItem call within a Merchant Data file, it must be enclosed within BulkDataExchangeRequest tags. After release 637, a namespace is returned in the BulkDataExchangeResponseType, at the top level of the response. The BulkDataExchange tags are not shown in the call input/output descriptions.
See:
Listing an Item
Introduction to Pictures in Item Listings
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History Top Errors for VerifyAddFixedPriceItem User Notes |
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?>
<VerifyAddFixedPriceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Standard Input Fields -->
<ErrorLanguage> string </ErrorLanguage>
<MessageID> string </MessageID>
<Version> string </Version>
<WarningLevel> WarningLevelCodeType </WarningLevel>
<!-- Call-specific Input Fields -->
<Item> ItemType
<ProductListingDetails> ProductListingDetailsType
<IncludePrefilledItemInformation> boolean </IncludePrefilledItemInformation>
<IncludeStockPhotoURL> boolean </IncludeStockPhotoURL>
<ProductID> string </ProductID>
<UseStockPhotoURLAsGallery> boolean </UseStockPhotoURLAsGallery>
</ProductListingDetails>
<ReturnPolicy> ReturnPolicyType
<Description> string </Description>
<EAN> string </EAN>
<RefundOption> token </RefundOption>
<ReturnsAcceptedOption> token </ReturnsAcceptedOption>
<ReturnsWithinOption> token </ReturnsWithinOption>
<ShippingCostPaidByOption> token </ShippingCostPaidByOption>
<WarrantyDurationOption> token </WarrantyDurationOption>
<WarrantyOfferedOption> token </WarrantyOfferedOption>
<WarrantyTypeOption> token </WarrantyTypeOption>
</ReturnPolicy>
<ScheduleTime> dateTime </ScheduleTime>
<SubTitle> string </SubTitle>
<Variations> VariationsType
<Pictures> PicturesType
<VariationSpecificName> string </VariationSpecificName>
<VariationSpecificPictureSet> VariationSpecificPictureSetType
<PictureURL> anyURI </PictureURL>
<!-- ... more PictureURL nodes here ... -->
<VariationSpecificValue> string </VariationSpecificValue>
</VariationSpecificPictureSet>
<!-- ... more VariationSpecificPictureSet nodes here ... -->
</Pictures>
<!-- ... more Pictures nodes here ... -->
<Variation> VariationType
<Quantity> int </Quantity>
<SKU> SKUType (string) </SKU>
<StartPrice> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
</Variation>
<!-- ... more Variation nodes here ... -->
<VariationSpecificsSet> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecificsSet>
</Variations>
</Item>
</VerifyAddFixedPriceItemRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Standard Input Fields [Jump to call-specific fields] |
| ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong |
| MessageID | string | Optional |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
| Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
| WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level. |
| Call-specific Input Fields |
| Item | ItemType | Required | Child fields hold the values that define the new fixed-price listing. |
| Item.ProductListingDetails | ProductListingDetailsType | Optional |
Specifies stock product information to include in a listing. Only applicable when listing items with product details. See the eBay Trading API Guide for information on listing with product details. As ProductID and ProductReferenceID are defined by eBay, they provide the most reliable means to identify a product. If you use ISBN, UPC, EAN, BrandMPN, and/or TicketListingDetails, eBay attempts to find a matching product on your behalf and use it in the listing. If no match is found, you can try using the catalog search calls (such as GetProductSearchResults or GetProducts) to find a ProductID or ProductReferenceID. When you specify ProductListingDetails, you must specify at least one product ID for the listing (ProductID, ProductReferenceID, ISBN, UPC, EAN, BrandMPN, and/or TicketListingDetails). If you specify more than one of these values (such as UPC and BrandMPN), eBay uses the first one that matches a product in eBay's catalog system. (This may be useful if you aren't sure which ID is more likely to result in a match.) If you do not specify a primary category, eBay determines the category based on the product ID (if a matching product is found in the system). If you do specify the category, it takes precedence (and it must be a catalog-enabled category that is valid for the product ID). If you list in two categories and the primary and secondary categories are both catalog-enabled, this product should correspond to the primary category (not the secondary category). If only one category is catalog-enabled, the product listing details should correspond to the catalog-enabled category. (Use GetCategory2CS to determine which categories are catalog-enabled.) Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. (ExternalProductID will be deprecated in a future release.) For ReviseItem and RelistItem only: If a listing includes product details and you change a category, the rules for continuing to include product details depend on whether or not the new category is mapped to a characteristic set associated with the same product ID. When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product ID and you cannot remove existing product data. However, you can change or add preferences such as IncludeStockPhotoURL, UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all catalog data when you revise or relist an item, specify Item.ProductListingDetails in DeletedField and don't pass ProductListingDetails in the request. For GetItemRecommendations only: For GetItemRecommendations, see the eBay Web Services guide for validation rule differences when using the Product Pricing engine. Not applicable to Half.com. See:
|
|
Item.ProductListingDetails .IncludePrefilledItemInformation |
boolean | Optional |
If true, specifies that the listing should include additional information about the product, such as a publisher's description or film credits. Such information is hosted through the eBay site and cannot be edited. If true, Item.Description is optional in item-listing requests. Default: false. |
|
Item.ProductListingDetails .IncludeStockPhotoURL |
boolean | Optional |
If true, indicates that the item listing includes the stock photo. To use an eBay stock photo in an item listing, set IncludeStockPhotoURL to true. If a stock photo is available, it is used at the top of the View Item page and in the Item Specifics section of the listing. If you also include Item.PictureDetails.PictureURL, the stock photo only appears in the Item Specifics section of the listing. Other pictures you specify by using Item.PictureDetails.PictureURL appear in a separate section of the listing. If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL to true (and you cannot set it to false). In GetItem, the URL of the stock photo will be returned in StockPhotoURL. If you set IncludeStockPhotoURL to false, the stock photo does not appear in the listing at all. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). Along with these changes, IncludeStockPhotoURL will be used in the request. In some cases, if IncludeStockPhotoURL is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information. Not applicable to Half.com. Default: false. See:
|
|
Item.ProductListingDetails .ProductID |
string | Conditional |
eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.) If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). In item-listing requests, if you pass in an old product ID, eBay lists the item with the latest version of the product and the latest product ID, and the call returns a warning indicating that the data has changed. Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, replacing, deleting, or merging some products (as a result of migrating from one catalog data provider to another). If you specify one of these products in a request, the call may return the product with a warning, or it may fail with an error if the product has been deleted. Max length: 4000. |
|
Item.ProductListingDetails .UseStockPhotoURLAsGallery |
boolean | Optional |
If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. When listing an item, IncludeStockPhotoURL must also be true and Item.PictureDetails.GalleryType must be passed in with a value of Gallery or Gallery Featured (but not both). Passing in Item.PictureDetails.GalleryURL takes precedence over UseStockPhotoURLAsGallery. See the eBay Trading API guide for additional validation rules for pictures. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). Along with these changes, UseStockPhotoURLAsGallery will be used in the request. In some cases, if UseStockPhotoURLAsGallery is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information. See:
|
| Item.ReturnPolicy | ReturnPolicyType | Conditional |
Describes the seller's return policy. Most categories on most eBay sites require the seller to clearly specify whether or not returns are accepted (see ReturnsAcceptedOption). For the AddItem family of calls: Required for most categories on most sites. Use ReturnPolicyEnabled in GetCategoryFeatures to determine which categories require this field. Also use ReturnPolicyDetails in GeteBayDetails to determine which ReturnPolicy fields can be used on each site. eBay India (IN), Australia (AU), and US eBay Motors Parts and Accessories categories typically support but do not require a return policy. (However, we strongly recommend that you specify a clear return policy whenever possible.) For ReviseItem only: If the listing has bids or sales and it ends within 12 hours, you can't change the return policy details. If the listing is a GTC listing that has sales or ends within 12 hours (one or the other, but not both), you can add a return policy to the GTC listing (but you can't change return policy details if already present). If the listing has no bids or sales and more than 12 hours remain before the listing ends, you can add or change the return policy. When you revise your return policy, you only need to specify the fields you want to add or change. You don't need to specify all the other ReturnPolicy fields again. The other fields will retain their existing settings. For the GetItem family of calls: Only returned if the site you sent the request to supports the seller's return policy. Typically, the return policy details are only returned when the request is sent to the listing site. See:
|
| Item.ReturnPolicy.Description | string | Optional |
A detailed explanation of the seller's return policy. For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but does not specify this field when listing the item, GetItem returns this as an empty node For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. Max length: 5000. See (GeteBayDetails) ReturnPolicyDetails.Description for sites that support this field. |
| Item.ReturnPolicy.EAN | string | Optional |
The European Article Number (EAN) associated with the item, if any. Refer to the ReturnPolicyDetails node in GeteBayDetails to determine which sites support this field. Only returned if the seller has specified this value in their return policy. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See (GeteBayDetails) ReturnPolicyDetails.EAN for sites that support this field. |
| Item.ReturnPolicy.RefundOption | token | Optional |
Indicates how the seller will compensate the buyer for a returned item. Use the ReturnPolicy.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details.). Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (RefundOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem (and corresponding FixedPrice calls): If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this RefundOption field when listing the item, some eBay sites may set a default value (like MoneyBack), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See (GeteBayDetails) RefundOption for sites that support this field, and applicable values. Applicable values: See RefundOptionsCodeType |
|
Item.ReturnPolicy .ReturnsAcceptedOption |
token | Conditional |
Indicates whether the seller allows the buyer to return the item. This field is required when ReturnPolicy is specified. (If you specify ReturnsNotAccepted, the View Item page may initially show the return policy as unspecified. In a future release, the View Item page will be updated to indicate that returns are not accepted instead.) All sites support the ability for a seller to not accept returns. If the seller doesn't accept returns, the item must specifically indicate ReturnsNotAccepted. (The return policy cannot be omitted from the item.) On the eBay UK and Ireland sites, business sellers must accept returns for fixed price items (including auction items with Buy It Now, and any other fixed price formats) when the category requires a return policy. On some European sites (such as eBay Germany (DE)), registered business sellers are required to accept returns. Your application can call GetUser to determine a user's current business seller status. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (ReturnsAcceptedOptionsCodeType defines all the possible values.) For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See:
Applicable values: See ReturnsAcceptedOptionsCodeType |
|
Item.ReturnPolicy .ReturnsWithinOption |
token | Conditional |
The buyer can return the item within this period of time from the day they receive the item. Use the ReturnPolicy.Description field to explain the policy details. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (ReturnsWithinOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this ReturnsWithinOption field when listing the item, some eBay sites may set a default value (like Days_7), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See (GeteBayDetails) ReturnsWithinOption for sites that support this field, and applicable values. Applicable values: See ReturnsWithinOptionsCodeType |
|
Item.ReturnPolicy .ShippingCostPaidByOption |
token | Optional |
The party who pays the shipping cost for a returned item. Use the ReturnPolicy.Description field to explain any additional details. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (ShippingCostPaidByOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this ShippingCostPaidByOption field when listing the item, some eBay sites may set a default value (like Buyer), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See (GeteBayDetails) ShippingCostPaidByOption for sites that support this field, and applicable values. Applicable values: See ShippingCostPaidByOptionsCodeType |
|
Item.ReturnPolicy .WarrantyDurationOption |
token | Optional |
The warranty period. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (Initially, only the eBay India site supports this field.) (WarrantyDurationOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyDurationOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See (GeteBayDetails) WarrantyDurationOption for sites that support this field, and applicable values. Applicable values: See WarrantyDurationOptionsCodeType |
|
Item.ReturnPolicy .WarrantyOfferedOption |
token | Optional |
Indicates whether a warranty is offered for the item. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (Initially, only the eBay India site supports this field.) (WarrantyOfferedCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyOfferedOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. Note: For the US eBay Motors limited warranty (Short-Term Service Agreement) option, use Item.LimitedWarrantyEligible instead. For the US eBay Motors "Is There an Existing Warranty?" option, use Item.AttributeSetArray instead. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See:
Applicable values: See WarrantyOfferedCodeType |
|
Item.ReturnPolicy .WarrantyTypeOption |
token | Optional |
Indicates the source or type of the warranty, if any. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (Initially, only the eBay India site supports this field.) (WarrantyTypeOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyTypeOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See (GeteBayDetails) WarrantyTypeOption for sites that support this field, and applicable values. Applicable values: See WarrantyTypeOptionsCodeType |
| Item.ScheduleTime | dateTime | Optional |
Allows the user to specify the time that the listing becomes active on eBay. To schedule the listing start time, specify a time in the future in GMT format. In GetItem and related calls, the scheduled time is returned in StartTime. For ReviseItem, you can modify this value if the currently scheduled start time is in the future. When you schedule a start time, the start time is randomized within 15-minute intervals. Randomized start times applies to the following sites: AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK Also see the following article in the Knowledge Base: Why scheduled time is sometimes getting reset. Not applicable to Half.com. |
| Item.SubTitle | string | Optional |
Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees). Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle. When you revise a item, you can add, change, or remove the subtitle. Not applicable to Half.com. Max length: 55. See:
|
| Item.Variations | VariationsType | Optional |
Variations are multiple similar (but not identical) items in a single fixed-price (or Store Inventory Format) listing. For example, a single listing could contain multiple items of the same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation can have its own quantity and price. For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no transactions, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0. As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing. For GetItem and related calls Only returned when a listing has variations. For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified. For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.) See:
|
| Item.Variations.Pictures | PicturesType | Optional,
repeatable: [0..1] |
Contains a set of pictures that correspond to one of the variation specifics, such as Color. For example, if a listing has blue and black color variations, you could choose Color for all the pictures, and then include a set of pictures for the blue variations and another set of pictures for the black variations. We strongly recommend that you also include shared pictures in Item.PictureDetails, as this results in a better experience for buyers. For ReviseFixedPriceItem only: To replace or delete individual pictures, pass in the entire Pictures node with the complete set of variation pictures that you want in the listing. If the applicable variations have purchases or the listing ends in less than 12 hours, you can add pictures, but you can't remove existing pictures. Note: Only one Pictures node is allowed for a listing. However, the node has been defined as unbounded (repeatable) in the schema to allow for different use cases for some calls or sites in the future. |
|
Item.Variations.Pictures .VariationSpecificName |
string | Conditional | One aspect of the variations that will be illustrated in the pictures for all variations. For example, if each variation is visually distinguished by color and the pictures show the different colors available, then specify "Color" as the name. The name must match one of the names specified in the variation specifics. Required when variation pictures are present. |
|
Item.Variations.Pictures .VariationSpecificPictureSet |
VariationSpecificPictureSetType | Conditional,
repeatable: [0..*] |
One or more pictures that help buyers distinguish the Variations. Multiple picture sets can be specified. For example, suppose a listing contains blue and black color variations, and VariationSpecificName=Color. In this case, one picture set could contain pictures of the blue shirts (e.g., front view, back view, and close-up of a trim detail), and another picture set could contain pictures of the black shirts. At least one picture set is required if the Pictures node is present in the request. You are not required to provide pictures for all values that correspond to the variation specific name. For example, a listing could have pictures depicting the blue and black color variations, but not the pink variations. |
|
Item.Variations.Pictures .VariationSpecificPictureSet .PictureURL |
anyURI | Conditional,
repeatable: [0..*] |
The URL of a picture that is associated with VariationSpecificValue. Images can be hosted by eBay Picture Services (EPS) or they can be self-hosted, but you can't mix the two. (That is, pictures in PictureDetails and VariationSpecificPictureSet need to either all be hosted by EPS, or all self-hosted.) If specified, this cannot have an empty/null value. To specify multiple pictures, send each URL in a separate, adjacent PictureURL field. The first PictureURL is also used as the gallery picture for applicable variations. For example, if the picture set contains pictures of red shirts (i.e., VariationSpecificName=Color and VariationSpecificValue=Red), the first picture is used as the gallery picture for all the red shirt variations. You can use Item.PictureDetails to specify additional pictures. For example, the item-level pictures could include a model wearing a black shirt, as a typical example of the shirt style. |
|
Item.Variations.Pictures .VariationSpecificPictureSet .VariationSpecificValue |
string | Conditional | A value that is associated with VariationSpecificName. For example, suppose this set of pictures is showing blue shirts, and some of the variations include Color=Blue in their variation specifics. If VariationSpecificName is "Color", then VariationSpecificValue would be "Blue". |
| Item.Variations.Variation | VariationType | Conditional,
repeatable: [1..120] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. |
|
Item.Variations.Variation .Quantity |
int | Required |
For AddFixedPriceItem and related calls: On input, this should be the number of items available for sale that are associated with this variation. If you set Quantity to zero when you create a new listing (or relist), the variation is dropped from the listing. For GetItem and related calls: On output, this is the total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract 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. Min: 1. |
| Item.Variations.Variation.SKU | SKUType (string) | Conditional |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. eBay preserves the SKU on the variation, enabling you to obtain it before and after a transaction is created. 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 specified). If Item.InventoryTrackingMethod is set to true, the SKU values must be specified and they must be unique across all the seller's active listings. Only returned if the seller specified a SKU for the variation. Max length: 70. |
|
Item.Variations.Variation .StartPrice |
AmountType (double) | Conditional |
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. |
|
Item.Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditional |
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't add or change names or values in variation specifics (because the set of variation specifics serves as a unique identifier). However, you can 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 (transactions). 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. See:
|
|
Item.Variations.Variation .VariationSpecifics .NameValueList |
NameValueListType | Conditional,
repeatable: [2..5] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. |
|
Item.Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditional |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations. |
|
Item.Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditional,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations. |
|
Item.Variations .VariationSpecificsSet |
NameValueListArrayType | Conditional |
The set of all variation names and values that can be applicable to the listing (at any time in its life cycle). This must include (but is not limited to) all names and values specified in the VariationSpecifics nodes. This set configures variation selection widgets that appear on eBay's View Item page. For example, if you specify Color and Size names in the set, eBay's View Item page displays Color and Size drop-down lists to enable a buyer to choose a variation of interest. The order in which you specify the names and values also controls the order in which the selection widgets appear on the View Item page. For example, if you specify "Color", then "Size", and then "Sleeve Style" as names, the View Item page shows drop-down lists with those labels in that order. For "Size", if you specify "S", "M", and "L" as values, the View Item page shows the values in that order in the Size drop-down list. Use GetCategorySpecifics to retrieve recommendations for names, values, and order. Required when Variations are specified in a new listing (e.g., in AddFixedPriceItem). See Configuring Variation-Selection Widgets for Buyers (View Item). |
|
Item.Variations .VariationSpecificsSet .NameValueList |
NameValueListType | Conditional,
repeatable: [2..5] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. |
|
Item.Variations .VariationSpecificsSet .NameValueList.Name |
string | Conditional |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations. |
|
Item.Variations .VariationSpecificsSet .NameValueList.Value |
string | Conditional,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations. |
| Input Detail Controls Samples Change History Top Errors for VerifyAddFixedPriceItem User Notes |
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?>
<VerifyAddFixedPriceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Standard Output Fields -->
<Ack> AckCodeType </Ack>
<Build> string </Build>
<CorrelationID> string </CorrelationID>
<Errors> ErrorType
<ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
<ErrorCode> token </ErrorCode>
<ErrorParameters ParamID="string"> ErrorParameterType
<Value> string </Value>
</ErrorParameters>
<!-- ... more ErrorParameters nodes here ... -->
<LongMessage> string </LongMessage>
<SeverityCode> SeverityCodeType </SeverityCode>
<ShortMessage> string </ShortMessage>
</Errors>
<!-- ... more Errors nodes here ... -->
<HardExpirationWarning> string </HardExpirationWarning>
<Message> string </Message>
<Timestamp> dateTime </Timestamp>
<Version> string </Version>
<!-- Call-specific Output Fields -->
<Category2ID> string </Category2ID>
<CategoryID> string </CategoryID>
<DiscountReason> DiscountReasonCodeType </DiscountReason>
<!-- ... more DiscountReason nodes here ... -->
<ExpressItemRequirements> ExpressItemRequirementsType
</ExpressItemRequirements>
<ExpressListing> boolean </ExpressListing>
<Fees> FeesType
<Fee> FeeType
<Fee> AmountType (double) </Fee>
<Name> string </Name>
<PromotionalDiscount> AmountType (double) </PromotionalDiscount>
</Fee>
<!-- ... more Fee nodes here ... -->
</Fees>
<ItemID> ItemIDType (string) </ItemID>
</VerifyAddFixedPriceItemResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Standard Output Fields [Jump to call-specific fields] |
| Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.
Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.) |
| Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
| CorrelationID | string | Conditionally |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
| Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request.
See Error Handling. |
| Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. |
| Errors.ErrorCode | token | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. |
| Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
| Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | The index of the parameter in the list of parameter types returned within the error type. |
| Errors.ErrorParameters.Value | string | Conditionally | The value of the variable (e.g., the attribute set ID) |
| Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
| Errors.SeverityCode | SeverityCodeType | Conditionally |
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error |
| Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
| HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
| Message | string | Conditionally |
Supplemental information from eBay, if applicable. May elaborate on errors (such as how a listing violates eBay policies) or provide useful hints that may help a seller increase sales. This data can accompany the call's normal data result set or a result set that contains only errors. Applications must recognize when the Message field is returned and provide a means to display the listing hints and error message explanations to the user. The string can return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML-based application should be able to include the HTML as-is in the HTML page that displays the results. A non-HTML application would need to parse the HTML and convert the table elements and image references into UI elements particular to the programming language used. As usual for string data types, the HTML markup elements are escaped with character entity references (e.g.,<table><tr>...). See Message. |
| Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
| Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response. |
| Call-specific Output Fields |
| Category2ID | string | Conditionally |
ID of the secondary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. Max length: 10. |
| CategoryID | string | Conditionally |
ID of the primary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. Max length: 10. |
| DiscountReason | DiscountReasonCodeType | Conditionally,
repeatable: [0..*] |
The nature of the discount, if a discount would have applied had this actually been listed at this time.
Applicable values: • CustomCode (out) Reserved for future use • Promotion (out) An offer that applies to an unlimited number of listings during the offering period. Example: "Get subtitle for $0.10 in Tech category when listing between 12/25 and 12/28. No limit to the number of items listed during this period." • SpecialOffer (out) An offer that applies to a limited number of listings during the offering period. Example: "There is no insertion fee for up to 5 auctions when listing between 12/1 and 12/10." |
| ExpressItemRequirements | ExpressItemRequirementsType | Conditionally |
Deprecated as of version 579. No longer functional. Contains details about why an item does or doesn't qualify as an eBay Express listing. Only returned when IncludeExpressRequirements is true the request. The item requirements are assessed in this order: - SellerExpressEligible - ExpressOptOut - ExpressApproved - All other settings Deprecation version: 579. See also Deprecated Objects. |
| ExpressListing | boolean | Conditionally |
Deprecated as of version 579. No longer functional. Indicates whether the item would be listed on eBay Express. See ExpressItemRequirements for hints about why this value is true or false for a given item. Deprecation version: 579. See also Deprecated Objects. |
| Fees | FeesType | Always | Child elements contain the estimated listing fees for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. |
| Fees.Fee | FeeType | Always,
repeatable: [1..*] |
Contains the name, fee, and possible discount amount for an item listing feature. A Fee container is returned for each listing feature, even if the associated cost (Fee value) is 0. |
| Fees.Fee.Fee | AmountType (double) | Always |
Amount of the fee that eBay will charge the member for the associated listing feature. See the eBay.com Web site online help for a current schedule of listing features and their associated fees.
See eBay.com Fees. |
| Fees.Fee.Name | string | Always | Name of the listing feature, for identification purposes. See the Trading API guide for a list of current listing features names and associated fees. |
| Fees.Fee.PromotionalDiscount | AmountType (double) | Always |
This field exists in the response when the user has selected the features that participate in a promotional discount. See the eBay.com Web site online help for a current fee schedule.
See eBay.com Fees. |
| ItemID | ItemIDType (string) | Always |
Represents the item ID for the new fixed-price listing. VerifyAddFixedPriceItem does not actually list an item, so 0 is returned instead of a normal item ID. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). |
| Input Output Samples Change History Top Errors for VerifyAddFixedPriceItem User Notes |
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
| Input Output Detail Controls Change History Top Errors for VerifyAddFixedPriceItem User Notes |
New to making API calls? Please see Routing the Request.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Tests the creation of a listing with variations that will require inventory management over a long period.
Description
A salesperson from megaonlinemerchant is listing multiple, similar women's tops that vary in size and color. To save fees and improve best match scores, he is listing all the items in a single listing.
See the description of this sample in AddFixedPriceItem for details.
Input
The salesperson specifies shared details (like Brand) for all the tops in Item.ItemSpecifics.
He specifies the details that differ for each set of tops in Item.Variations.
In addition to defining the variation details, the salesperson configures the way buyers will browse the variations. He expects buyers to first choose their size, and then choose a color that is available in their size. He uses Variations.VariationSpecificSet to configure these details.
The salesman includes pictures for each color in Variations.Pictures. He also includes some shared pictures (such as a model wearing a representative example of the shirt style) in Item.PictureDetails.
See the description of this sample in AddFixedPriceItem for details.
XML format (HTTP POST). Also available is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <VerifyAddFixedPriceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <ErrorLanguage>en_US</ErrorLanguage> <WarningLevel>High</WarningLevel> <Item> <Country>US</Country> <Currency>USD</Currency> <Description><![CDATA[New Ralph Lauren Polo womens tops shirts! Black, Pink, Yellow, Blue. NWT]]></Description> <DispatchTimeMax>3</DispatchTimeMax> <ListingDuration>GTC</ListingDuration> <ListingType>FixedPriceItem</ListingType> <PaymentMethods>PayPal</PaymentMethods> <PayPalEmailAddress>megaonlinemerchant@gmail.com</PayPalEmailAddress> <PostalCode>95125</PostalCode> <PrimaryCategory> <CategoryID>37565</CategoryID> </PrimaryCategory> <Title>New Ralph Lauren Polo shirt Pink Black Blue Yellow</Title> <PictureDetails> <PictureURL>http://i12.ebayimg.com/03/i/04/8a/5f/a1_1_sbl.JPG</PictureURL> <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sbl.JPG</PictureURL> <PictureURL>http://i4.ebayimg.ebay.com/01/i/000/77/3c/d88f_1_sbl.JPG</PictureURL> </PictureDetails> <ReturnPolicy> <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption> <RefundOption>MoneyBack</RefundOption> <ReturnsWithinOption>Days_30</ReturnsWithinOption> <Description>Text description of return policy details</Description> <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption> </ReturnPolicy> <ShippingDetails> <CalculatedShippingRate> <OriginatingPostalCode>95125</OriginatingPostalCode> <PackageDepth>6</PackageDepth> <PackageLength>7</PackageLength> <PackageWidth>7</PackageWidth> <ShippingPackage>PackageThickEnvelope</ShippingPackage> <WeightMajor>2</WeightMajor> <WeightMinor>0</WeightMinor> </CalculatedShippingRate> <PaymentInstructions>Payment must be received within 7 business days of purchase.</PaymentInstructions> <SalesTax> <SalesTaxPercent>8.75</SalesTaxPercent> <SalesTaxState>CA</SalesTaxState> </SalesTax> <ShippingServiceOptions> <FreeShipping>true</FreeShipping> <ShippingService>USPSPriority</ShippingService> <ShippingServicePriority>1</ShippingServicePriority> </ShippingServiceOptions> <ShippingServiceOptions> <ShippingService>UPSGround</ShippingService> <ShippingServicePriority>2</ShippingServicePriority> </ShippingServiceOptions> <ShippingServiceOptions> <ShippingService>UPSNextDay</ShippingService> <ShippingServicePriority>3</ShippingServicePriority> </ShippingServiceOptions> <ShippingType>Calculated</ShippingType> </ShippingDetails> <ItemSpecifics> <NameValueList> <Name>Condition</Name> <Value>New</Value> </NameValueList> <NameValueList> <Name>Occasion</Name> <Value>Casual</Value> </NameValueList> <NameValueList> <Name>Brand</Name> <Value>Ralph Lauren</Value> </NameValueList> <NameValueList> <Name>Style</Name> <Value>Polo Shirt</Value> </NameValueList> <NameValueList> <Name>Sleeve Style</Name> <Value>Short Sleeve</Value> </NameValueList> </ItemSpecifics> <Variations> <VariationSpecificsSet> <NameValueList> <Name>Size</Name> <Value>XS</Value> <Value>S</Value> <Value>M</Value> <Value>L</Value> <Value>XL</Value> </NameValueList> <NameValueList> <Name>Color</Name> <Value>Black</Value> <Value>Pink</Value> <Value>Yellow</Value> <Value>Blue</Value> </NameValueList> </VariationSpecificsSet> <Variation> <SKU>RLauren_Wom_TShirt_Pnk_S</SKU> <StartPrice>17.99</StartPrice> <Quantity>4</Quantity> <VariationSpecifics> <NameValueList> <Name>Color</Name> <Value>Pink</Value> </NameValueList> <NameValueList> <Name>Size</Name> <Value>S</Value> </NameValueList> </VariationSpecifics> </Variation> <Variation> <SKU>RLauren_Wom_TShirt_Pnk_M</SKU> <StartPrice>17.99</StartPrice> <Quantity>8</Quantity> <VariationSpecifics> <NameValueList> <Name>Color</Name> <Value>Pink</Value> </NameValueList> <NameValueList> <Name>Size</Name> <Value>M</Value> </NameValueList> </VariationSpecifics> </Variation> <Variation> <SKU>RLauren_Wom_TShirt_Blk_S</SKU> <StartPrice>20.00</StartPrice> <Quantity>10</Quantity> <VariationSpecifics> <NameValueList> <Name>Color</Name> <Value>Black</Value> </NameValueList> <NameValueList> <Name>Size</Name> <Value>S</Value> </NameValueList> </VariationSpecifics> </Variation> <Variation> <SKU>RLauren_Wom_TShirt_Blk_M</SKU> <StartPrice>20.00</StartPrice> <Quantity>10</Quantity> <VariationSpecifics> <NameValueList> <Name>Color</Name> <Value>Black</Value> </NameValueList> <NameValueList> <Name>Size</Name> <Value>M</Value> </NameValueList> </VariationSpecifics> </Variation> <Variation> <SKU>RLauren_Wom_TShirt_Blu_S</SKU> <StartPrice>20.00</StartPrice> <Quantity>10</Quantity> <VariationSpecifics> <NameValueList> <Name>Color</Name> <Value>Blue</Value> </NameValueList> <NameValueList> <Name>Size</Name> <Value>S</Value> </NameValueList> </VariationSpecifics> </Variation> <Variation> <SKU>RLauren_Wom_TShirt_Blu_M</SKU> <StartPrice>20.00</StartPrice> <Quantity>10</Quantity> <VariationSpecifics> <NameValueList> <Name>Color</Name> <Value>Blue</Value> </NameValueList> <NameValueList> <Name>Size</Name> <Value>M</Value> </NameValueList> </VariationSpecifics> </Variation> <Pictures> <VariationSpecificName>Color</VariationSpecificName> <VariationSpecificPictureSet> <VariationSpecificValue>Pink</VariationSpecificValue> <PictureURL>http://i12.ebayimg.com/03/i/04/8a/5f/a1_1_sbl.JPG</PictureURL> <PictureURL>http://i12.ebayimg.com/03/i/04/8a/5f/a1_1_sb2.JPG</PictureURL> </VariationSpecificPictureSet> <VariationSpecificPictureSet> <VariationSpecificValue>Blue</VariationSpecificValue> <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sbl.JPG</PictureURL> <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sb2.JPG</PictureURL> <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sb3.JPG</PictureURL> </VariationSpecificPictureSet> <VariationSpecificPictureSet> <VariationSpecificValue>Black</VariationSpecificValue> <PictureURL>http://i4.ebayimg.ebay.com/01/i/000/77/3c/d88f_1_sbl.JPG</PictureURL> </VariationSpecificPictureSet> <VariationSpecificPictureSet> <VariationSpecificValue>Yellow</VariationSpecificValue> <PictureURL>http://i4.ebayimg.ebay.com/01/i/000/77/3c/d89f_1_sbl.JPG</PictureURL> </VariationSpecificPictureSet> </Pictures> </Variations> </Item> <RequesterCredentials> <eBayAuthToken>YOURTOKENHERE</eBayAuthToken> </RequesterCredentials> </VerifyAddFixedPriceItemRequest>
Output
The response includes the list of estimated fees associated with listing megaonlinemerchant's items. For this particular VerifyAddFixedPriceItem call with variations, the fees are the insertion fee and picture fees.
XML format. Also available is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <VerifyAddFixedPriceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <Timestamp>2009-03-01T21:22:04.602Z</Timestamp> <Ack>Success</Ack> <Version>615</Version> <Build>e615_core_API_8047594_R1</Build> <ItemID>0</ItemID> <Fees> <Fee> <Name>AuctionLengthFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>BoldFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>BuyItNowFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>CategoryFeaturedFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>FeaturedFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>GalleryPlusFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>FeaturedGalleryFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>FixedPriceDurationFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>GalleryFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>GiftIconFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>HighLightFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>InsertionFee</Name> <Fee currencyID="USD">0.35</Fee> </Fee> <Fee> <Name>InternationalInsertionFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>ListingDesignerFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>ListingFee</Name> <Fee currencyID="USD">0.35</Fee> </Fee> <Fee> <Name>PhotoDisplayFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>PhotoFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>ReserveFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>SchedulingFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>SubtitleFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>BorderFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>ProPackBundleFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>BasicUpgradePackBundleFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>ValuePackBundleFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>PrivateListingFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>ExtendedDurationFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>ProPackPlusBundleFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> <Fee> <Name>MotorsGermanySearchFee</Name> <Fee currencyID="USD">0.0</Fee> </Fee> </Fees> </VerifyAddFixedPriceItemResponse>
| Input Output Detail Controls Samples Top Errors for VerifyAddFixedPriceItem User Notes |
| Version | Description |
|---|---|
| 635 2009-09-16 |
|
| 627 2009-07-22 |
|
| 619 2009-05-27 |
|
| 615 2008-04-29 |
|
| Input Output Detail Controls Samples Change History Top Errors for VerifyAddFixedPriceItem User Notes |
This document was generated with a customized version of the apireferencedocs tool.
© 2005–2010 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.