GetItem
Use this call to retrieve the data for a single item listed on an eBay site. GetItem returns the data in an Item object.
This call is conceptually similar to eBay's View item page. Data returned includes the item's title, description, price information, seller information, shipping details, high bidder information (if there currently is a high bidder), and so on.
Usage Details
GetItem returns item data for only a single item per call. Make multiple calls to GetItem to review details for more than a single item.
GetItem returns different sets of item information depending on how you set the DetailLevel input field. See GetItem Detail Controls for more information on how to control the fields returned.
Note that if a listing's end time is more than 90 days old, its title, price, and other item information are not returned by the call.
Note: For listings that return Item.DiscountPriceInfo.PricingTreatment set to MAP (Minimum Advertised Price), you are legally required to follow the rules for displaying the price of the item to potential buyers. You are bound by the terms of the API License Agreement to follow these rules. Refer to the API License Agreement for consequences of non-compliance. |
Optimizing Your Calls
Rather than repeating calls to GetItem to retrieve data for multiple items listed by the same seller, use GetSellerList instead.
Automatic polling frequency can be increased during the last four hours of an auction. Only increase the frequency if the user is logged in and active in the system. During the last four hours of an auction, the maximum polling frequency is every 15 minutes. During the last 30 minutes of an auction, the maximum frequency is every five minutes.
Testing GetItem
You can test GetItem in the Sandbox. However, you must have existing items in the Sandbox before you can call GetItem. If necessary, add a new item using AddItem. Below are some test case scenarios to consider:
- Some data values are only returned if the call requestor is the same as the one who listed the item. To test the call from the perspective of another user, execute the call using a Sandbox test user other than the one used to list the item.
- For applications that list different types of items (such as Chinese auctions and fixed price items), use AddItem to create all different item types, then use GetItem to retrieve the data for each different item type.
- If applicable to the application's run-time use cases, list test items with flat and calculated shipping rates, and retrieve them with GetItem.
- For applications that create competitive-bid item listings (Chinese auctions), bid on the item using the Sandbox user interface before retrieving the item with GetItem. This will populate the high bidder data in the result set.
- For applications that list items with Item Specifics, create listings in several different categories and view the GetItem responses to see that they match the items you listed. Set IncludeItemSpecifics to
true
to retrieve this data. Book categories have a relatively simple set of Item Specifics. US Tickets and US eBay Real Estate categories have more complex Item Specifics. - For applications that list items with catalog product details, create listings in several different categories and review the product data and Item Specifics that are returned. Set DetailLevel to
ReturnAll
to retrieve this data.
Related Information
See:
Retrieve items
Add pictures
Output Detail Controls Samples Change History |
Input
See also Samples.
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 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"?> <GetItemRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <IncludeItemCompatibilityList> boolean </IncludeItemCompatibilityList> <IncludeItemSpecifics> boolean </IncludeItemSpecifics> <IncludeTaxTable> boolean </IncludeTaxTable> <IncludeWatchCount> boolean </IncludeWatchCount> <ItemID> ItemIDType (string) </ItemID> <SKU> SKUType (string) </SKU> <TransactionID> string </TransactionID> <VariationSKU> SKUType (string) </VariationSKU> <VariationSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </VariationSpecifics> <!-- Standard Input Fields --> <DetailLevel> DetailLevelCodeType </DetailLevel> <!-- ... more DetailLevel values allowed here ... --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <OutputSelector> string </OutputSelector> <!-- ... more OutputSelector values allowed here ... --> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </GetItemRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
IncludeItemCompatibilityList | boolean | Optional |
This field is used to specify whether or not to retrieve Parts Compatiblity information for a motor part or accessory listing. If this field is included and set to true , the Item.ItemCompatibilityList container will be returned if a Parts Compatibility list exists for the listing. A Parts Compatibility list is a list of motor vehicles that are compatible with the listed motor part or accesory item. If a Parts Compatibility list does not exist for the listing, this field will have no effect if it is included, regardless of its value (true or false ). If this field is included and set to false or omitted, but a Parts Compatibility list does exist for the listing, the Item.ItemCompatibilityList container will not be returned, but the Item.ItemCompatibilityCount field will be returned, and this field will simply indicate the quantity of motor vehicles that are compatible with the the listed motor part or accesory item. Parts Compatibility lists are only applicable to motor parts and accessory categories on the sites that support eBay Motors - US, CA, UK, and DE. Default: false. See:
|
IncludeItemSpecifics | boolean | Optional |
If this field is included and set to true , the call response includes the ItemSpecifics container if Item Specifics are defined for the listing.An Item Specific is any aspect that helps define/classify the item. Many eBay categories mandate including specific Item Specifics, so it is always a good idea to make a call to the getItemAspectsForCategory method of the Taxonomy API to see what Item Specifics are required and which ones are recommended. Including this field and setting it to true will also return the UnitInfo container if applicable. The UnitInfo container will provide information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the UnitType and UnitQuantity values and the item's listed price to calculate and display the per-unit price on eBay EU sites.Default: false. See Item specifics. |
IncludeTaxTable | boolean | Optional |
The seller will include this field and set its value to true if the seller wishes to view the defined sales tax rates for the various jurisdictions in the country (generally, states and provinces). Information for each defined sales tax rate will be returned in the TaxTable container in the response. Even if this field is included and set to true , no TaxTable container will be returned If no sales tax rates are defined for any tax jurisdiction in the seller's sales tax table. Sales tax tables are only available for eBay US and Canada marketplaces. Sales tax rates can be added/modified in My eBay, through the SetTaxTable and GetTaxTable calls of the Trading API, or through the Sales Tax calls of the Account API. Default: false. |
IncludeWatchCount | boolean | Optional |
The seller can include this field and set its value to true if that seller wants to see how many prospective bidders/buyers currently have the item added to their Watch Lists. The Watch count is returned in the WatchCount field in the response. This field will only be returnd to the seller of the item. Default: false. |
ItemID | ItemIDType (string) | Conditional |
This field is used to identify the eBay listing by Item ID value. ItemID is a required input in most cases. SKU can be used instead in certain cases (see the description of SKU). If both ItemID and SKU are specified for items where the inventory tracking method is ItemID, ItemID takes precedence. |
SKU | SKUType (string) | Conditional |
Retrieves an item that was listed by the user identified in AuthToken and that is being tracked by this SKU. 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 item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.) In GetItem, SKU can only be used to retrieve one of your own items, where you listed the item by using AddFixedPriceItem or RelistFixedPriceItem, and you set Item.InventoryTrackingMethod to SKU at the time the item was listed. (These criteria are necessary to uniquely identify the listing by a SKU.) Either ItemID or SKU is required in the request. If both are passed, they must refer to the same item, and that item must have InventoryTrackingMethod set to SKU. Max length: 50. |
TransactionID | string | Conditional |
A unique identifier for an order line item. An order line item is created when a buyer commits to purchasing an item. Since you can change active multiple-quantity fixed-price listings even after one of the items has been purchased, the TransactionID is associated with a snapshot of the item data at the time of the purchase. After one item in a multi-quantity listing has been sold, sellers can not change the values in the Title, Primary Category, Secondary Category, Listing Duration, and Listing Type fields. However, all other fields are editable. Specifying a TransactionID in the GetItem request allows you to retrieve a snapshot of the listing as it was when the order line item was created. The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing. Note: Beginning in July 2024, non-zero transaction IDs will start being returned for auction listings. If necessary, update code to handle non-zero transaction IDs for auction transactions before this time. |
VariationSKU | SKUType (string) | Conditional | Variation-level SKU that uniquely identifes a Variation within the listing identified by ItemID. Only applicable when the seller listed the item with Variation-level SKU (Variation.SKU) values. Retrieves all the usual Item fields, but limits the Variations content to the specified Variation. If not specified, the response includes all Variations. |
VariationSpecifics | NameValueListArrayType | Conditional |
Name-value pairs that identify one or more Variations within the listing identified by ItemID. Only applicable when the seller listed the item with Variations. Retrieves all the usual Item fields, but limits the Variations content to the specified Variation(s). If the specified pairs do not match any Variation, eBay returns all Variations. To retrieve only one variation, specify the full set of name/value pairs that match all the name-value pairs of one Variation. To retrieve multiple variations (using a wildcard), specify one or more name/value pairs that partially match the desired variations. For example, if the listing contains Variations for shirts in different colors and sizes, specify Color as Red (and no other name/value pairs) to retrieve all the red shirts in all sizes (but no other colors). |
VariationSpecifics .NameValueList |
NameValueListType | Optional,
repeatable: [0..*] |
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 variations, 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:
For PlaceOffer: Required if the item being purchased includes Item Variations. For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required. Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
|
VariationSpecifics .NameValueList.Name |
string | Optional |
Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name. For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing. Max length: 65. |
VariationSpecifics .NameValueList.Value |
string | Optional,
repeatable: [0..*] |
Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI . If an item specific only supports a single value, only the first item specific value specified in the request will be used. For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description. Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning'). |
Standard Input Fields |
DetailLevel | DetailLevelCodeType | Optional,
repeatable: [0..*] |
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it and processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use GranularityLevel instead, or use GetSellerEvents. If you do use 'ReturnAll' with GetSellerList, use a small Pagination.EntriesPerPage value and a narrow EndTimeFrom/EndTimeTo date range for better performance. Applicable values: (Not all values in DetailLevelCodeType apply to this field.) |
||||||||||||||||||||||||||||||||||||||||
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. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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. |
||||||||||||||||||||||||||||||||||||||||
OutputSelector | string | Optional,
repeatable: [0..*] |
You can use the OutputSelector field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload. For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as ViewItemURL and BuyItNowPrice as in the following example: If the following output selectors are used: See OutputSelector. |
||||||||||||||||||||||||||||||||||||||||
Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
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 performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
Input Detail Controls Samples Change History |
Output
See also Samples.
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 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).
<?xml version="1.0" encoding="utf-8"?> <GetItemResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <Item> ItemType <ApplicationData> string </ApplicationData> <ApplyBuyerProtection> BuyerProtectionDetailsType <BuyerProtectionSource> BuyerProtectionSourceCodeType </BuyerProtectionSource> <BuyerProtectionStatus> BuyerProtectionCodeType </BuyerProtectionStatus> </ApplyBuyerProtection> <AutoPay> boolean </AutoPay> <AvailableForPickupDropOff> boolean </AvailableForPickupDropOff> <BestOfferDetails> BestOfferDetailsType <BestOfferCount> int </BestOfferCount> <BestOfferEnabled> boolean </BestOfferEnabled> </BestOfferDetails> <BusinessSellerDetails> BusinessSellerDetailsType <AdditionalContactInformation> string </AdditionalContactInformation> <Address> AddressType <FirstName> string </FirstName> <LastName> string </LastName> </Address> <Email> string </Email> <Fax> string </Fax> <LegalInvoice> boolean </LegalInvoice> <TermsAndConditions> string </TermsAndConditions> <TradeRegistrationNumber> string </TradeRegistrationNumber> <VATDetails> VATDetailsType <BusinessSeller> boolean </BusinessSeller> <RestrictedToBusiness> boolean </RestrictedToBusiness> <VATID> string </VATID> <VATPercent> float </VATPercent> <VATSite> string </VATSite> </VATDetails> </BusinessSellerDetails> <BuyerGuaranteePrice currencyID="CurrencyCodeType"> AmountType (double) </BuyerGuaranteePrice> <BuyerProtection> BuyerProtectionCodeType </BuyerProtection> <BuyerRequirementDetails> BuyerRequirementDetailsType <MaximumItemRequirements> MaximumItemRequirementsType <MaximumItemCount> int </MaximumItemCount> <MinimumFeedbackScore> int </MinimumFeedbackScore> </MaximumItemRequirements> <MaximumUnpaidItemStrikesInfo> MaximumUnpaidItemStrikesInfoType <Count> int </Count> <Period> PeriodCodeType </Period> </MaximumUnpaidItemStrikesInfo> <ShipToRegistrationCountry> boolean </ShipToRegistrationCountry> <ZeroFeedbackScore> boolean </ZeroFeedbackScore> </BuyerRequirementDetails> <BuyerResponsibleForShipping> boolean </BuyerResponsibleForShipping> <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice> <Charity> CharityType <CharityID> string </CharityID> <CharityName> string </CharityName> <DonationPercent> float </DonationPercent> <LogoURL> string </LogoURL> <Mission> string </Mission> <Status> CharityStatusCodeType </Status> </Charity> <ConditionDefinition> string </ConditionDefinition> <ConditionDescriptors> ConditionDescriptorsType <ConditionDescriptor> ConditionDescriptorType <AdditionalInfo> string </AdditionalInfo> <Name> string </Name> <Value> string </Value> <!-- ... more Value values allowed here ... --> </ConditionDescriptor> <!-- ... more ConditionDescriptor nodes allowed here ... --> </ConditionDescriptors> <ConditionDisplayName> string </ConditionDisplayName> <ConditionID> int </ConditionID> <Country> CountryCodeType </Country> <CrossBorderTrade> string </CrossBorderTrade> <!-- ... more CrossBorderTrade values allowed here ... --> <Currency> CurrencyCodeType </Currency> <Description> string </Description> <DigitalGoodInfo> DigitalGoodInfoType <DigitalDelivery> boolean </DigitalDelivery> </DigitalGoodInfo> <DisableBuyerRequirements> boolean </DisableBuyerRequirements> <DiscountPriceInfo> DiscountPriceInfoType <MadeForOutletComparisonPrice currencyID="CurrencyCodeType"> AmountType (double) </MadeForOutletComparisonPrice> <MinimumAdvertisedPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumAdvertisedPrice> <MinimumAdvertisedPriceExposure> MinimumAdvertisedPriceExposureCodeType </MinimumAdvertisedPriceExposure> <OriginalRetailPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalRetailPrice> <PricingTreatment> PricingTreatmentCodeType </PricingTreatment> <SoldOffeBay> boolean </SoldOffeBay> <SoldOneBay> boolean </SoldOneBay> </DiscountPriceInfo> <DispatchTimeMax> int </DispatchTimeMax> <eBayPlus> boolean </eBayPlus> <eBayPlusEligible> boolean </eBayPlusEligible> <EligibleForPickupDropOff> boolean </EligibleForPickupDropOff> <eMailDeliveryAvailable> boolean </eMailDeliveryAvailable> <ExtendedProducerResponsibility> ExtendedProducerResponsibilityType <EcoParticipationFee currencyID="CurrencyCodeType"> AmountType (double) </EcoParticipationFee> </ExtendedProducerResponsibility> <ExtendedSellerContactDetails> ExtendedContactDetailsType <ClassifiedAdContactByEmailEnabled> boolean </ClassifiedAdContactByEmailEnabled> <ContactHoursDetails> ContactHoursDetailsType <Hours1AnyTime> boolean </Hours1AnyTime> <Hours1Days> DaysCodeType </Hours1Days> <Hours1From> time </Hours1From> <Hours1To> time </Hours1To> <Hours2AnyTime> boolean </Hours2AnyTime> <Hours2Days> DaysCodeType </Hours2Days> <Hours2From> time </Hours2From> <Hours2To> time </Hours2To> <TimeZoneID> string </TimeZoneID> </ContactHoursDetails> </ExtendedSellerContactDetails> <FreeAddedCategory> CategoryType <CategoryID> string </CategoryID> <CategoryName> string </CategoryName> </FreeAddedCategory> <HideFromSearch> boolean </HideFromSearch> <IgnoreQuantity> boolean </IgnoreQuantity> <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled> <InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod> <IsIntermediatedShippingEligible> boolean </IsIntermediatedShippingEligible> <IsItemEMSEligible> boolean </IsItemEMSEligible> <IsSecureDescription> boolean </IsSecureDescription> <ItemCompatibilityCount> int </ItemCompatibilityCount> <ItemCompatibilityList> ItemCompatibilityListType <Compatibility> ItemCompatibilityType <CompatibilityNotes> string </CompatibilityNotes> <NameValueList> NameValueListType <Name> string </Name> <Source> ItemSpecificSourceCodeType </Source> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </Compatibility> <!-- ... more Compatibility nodes allowed here ... --> </ItemCompatibilityList> <ItemID> ItemIDType (string) </ItemID> <ItemPolicyViolation> ItemPolicyViolationType <PolicyID> long </PolicyID> <PolicyText> string </PolicyText> </ItemPolicyViolation> <ItemSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Source> ItemSpecificSourceCodeType </Source> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </ItemSpecifics> <ListingDetails> ListingDetailsType <Adult> boolean </Adult> <BestOfferAutoAcceptPrice currencyID="CurrencyCodeType"> AmountType (double) </BestOfferAutoAcceptPrice> <BindingAuction> boolean </BindingAuction> <BuyItNowAvailable> boolean </BuyItNowAvailable> <CheckoutEnabled> boolean </CheckoutEnabled> <ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice> <ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice> <ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice> <EndingReason> EndReasonCodeType </EndingReason> <EndTime> dateTime </EndTime> <HasPublicMessages> boolean </HasPublicMessages> <HasReservePrice> boolean </HasReservePrice> <HasUnansweredQuestions> boolean </HasUnansweredQuestions> <MinimumBestOfferPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumBestOfferPrice> <RelistedItemID> ItemIDType (string) </RelistedItemID> <SecondChanceOriginalItemID> ItemIDType (string) </SecondChanceOriginalItemID> <StartTime> dateTime </StartTime> <ViewItemURL> anyURI </ViewItemURL> <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch> </ListingDetails> <ListingDuration> token </ListingDuration> <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement> <!-- ... more ListingEnhancement values allowed here ... --> <ListingSubtype2> ListingSubtypeCodeType </ListingSubtype2> <ListingType> ListingTypeCodeType </ListingType> <Location> string </Location> <LocationDefaulted> boolean </LocationDefaulted> <LotSize> int </LotSize> <MechanicalCheckAccepted> boolean </MechanicalCheckAccepted> <PaymentAllowedSite> SiteCodeType </PaymentAllowedSite> <!-- ... more PaymentAllowedSite values allowed here ... --> <PaymentDetails> PaymentDetailsType <DaysToFullPayment> int </DaysToFullPayment> <DepositAmount currencyID="CurrencyCodeType"> AmountType (double) </DepositAmount> <DepositType> DepositTypeCodeType </DepositType> <HoursToDeposit> int </HoursToDeposit> </PaymentDetails> <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods> <!-- ... more PaymentMethods values allowed here ... --> <PayPalEmailAddress> string </PayPalEmailAddress> <PickupInStoreDetails> PickupInStoreDetailsType <EligibleForPickupDropOff> boolean </EligibleForPickupDropOff> <EligibleForPickupInStore> boolean </EligibleForPickupInStore> </PickupInStoreDetails> <PictureDetails> PictureDetailsType <ExtendedPictureDetails> ExtendedPictureDetailsType <PictureURLs> PictureURLsType <eBayPictureURL> anyURI </eBayPictureURL> <!-- ... more eBayPictureURL values allowed here ... --> <ExternalPictureURL> anyURI </ExternalPictureURL> </PictureURLs> <!-- ... more PictureURLs nodes allowed here ... --> </ExtendedPictureDetails> <ExternalPictureURL> anyURI </ExternalPictureURL> <GalleryErrorInfo> string </GalleryErrorInfo> <GalleryStatus> GalleryStatusCodeType </GalleryStatus> <GalleryType> GalleryTypeCodeType </GalleryType> <PictureSource> PictureSourceCodeType </PictureSource> <PictureURL> anyURI </PictureURL> <!-- ... more PictureURL values allowed here ... --> </PictureDetails> <PostalCode> string </PostalCode> <PrimaryCategory> CategoryType <CategoryID> string </CategoryID> <CategoryName> string </CategoryName> </PrimaryCategory> <PrivateListing> boolean </PrivateListing> <ProductListingDetails> ProductListingDetailsType <BrandMPN> BrandMPNType <Brand> string </Brand> <MPN> string </MPN> </BrandMPN> <Copyright> string </Copyright> <!-- ... more Copyright values allowed here ... --> <EAN> string </EAN> <IncludeeBayProductDetails> boolean </IncludeeBayProductDetails> <IncludeStockPhotoURL> boolean </IncludeStockPhotoURL> <ISBN> string </ISBN> <ProductReferenceID> string </ProductReferenceID> <StockPhotoURL> anyURI </StockPhotoURL> <UPC> string </UPC> <UseStockPhotoURLAsGallery> boolean </UseStockPhotoURLAsGallery> </ProductListingDetails> <ProxyItem> boolean </ProxyItem> <Quantity> int </Quantity> <QuantityAvailableHint> QuantityAvailableHintCodeType </QuantityAvailableHint> <QuantityThreshold> int </QuantityThreshold> <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch> <Regulatory> RegulatoryType <Documents> DocumentsType <Document> DocumentType <DocumentID> string </DocumentID> </Document> <!-- ... more Document nodes allowed here ... --> </Documents> <EconomicOperator> EconomicOperatorType <CityName> string </CityName> <CompanyName> string </CompanyName> <Country> CountryCodeType </Country> <Email> string </Email> <Phone> string </Phone> <PostalCode> string </PostalCode> <StateOrProvince> string </StateOrProvince> <Street1> string </Street1> <Street2> string </Street2> </EconomicOperator> <EnergyEfficiencyLabel> EnergyEfficiencyType <ImageDescription> string </ImageDescription> <ImageURL> anyURI </ImageURL> <ProductInformationsheet> anyURI </ProductInformationsheet> </EnergyEfficiencyLabel> <Hazmat> HazmatType <Component> string </Component> <Pictograms> PictogramsType <Pictogram> string </Pictogram> <!-- ... more Pictogram values allowed here ... --> </Pictograms> <SignalWord> string </SignalWord> <Statements> StatementsType </Statements> </Hazmat> <Manufacturer> ManufacturerType <CityName> string </CityName> <CompanyName> string </CompanyName> <Country> CountryCodeType </Country> <Email> string </Email> <Phone> string </Phone> <PostalCode> string </PostalCode> <StateOrProvince> string </StateOrProvince> <Street1> string </Street1> <Street2> string </Street2> </Manufacturer> <ProductSafety> ProductSafetyType <Component> string </Component> <Pictograms> PictogramsType <Pictogram> string </Pictogram> <!-- ... more Pictogram values allowed here ... --> </Pictograms> <Statements> StatementsType </Statements> </ProductSafety> <RepairScore> double </RepairScore> <ResponsiblePersons> ResponsiblePersonsType <ResponsiblePerson> ResponsiblePersonType <CityName> string </CityName> <CompanyName> string </CompanyName> <Country> CountryCodeType </Country> <Email> string </Email> <Phone> string </Phone> <PostalCode> string </PostalCode> <StateOrProvince> string </StateOrProvince> <Street1> string </Street1> <Street2> string </Street2> <Types> ResponsiblePersonCodeTypes <Type> ResponsiblePersonCodeType </Type> <!-- ... more Type values allowed here ... --> </Types> </ResponsiblePerson> <!-- ... more ResponsiblePerson nodes allowed here ... --> </ResponsiblePersons> </Regulatory> <RelistParentID> long </RelistParentID> <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice> <ReturnPolicy> ReturnPolicyType <Description> string </Description> <InternationalRefundOption> token </InternationalRefundOption> <InternationalReturnsAcceptedOption> token </InternationalReturnsAcceptedOption> <InternationalReturnsWithinOption> token </InternationalReturnsWithinOption> <InternationalShippingCostPaidByOption> token </InternationalShippingCostPaidByOption> <Refund> string </Refund> <RefundOption> token </RefundOption> <ReturnsAccepted> string </ReturnsAccepted> <ReturnsAcceptedOption> token </ReturnsAcceptedOption> <ReturnsWithin> string </ReturnsWithin> <ReturnsWithinOption> token </ReturnsWithinOption> <ShippingCostPaidBy> string </ShippingCostPaidBy> <ShippingCostPaidByOption> token </ShippingCostPaidByOption> </ReturnPolicy> <ReviseStatus> ReviseStatusType <BuyItNowAdded> boolean </BuyItNowAdded> <BuyItNowLowered> boolean </BuyItNowLowered> <ItemRevised> boolean </ItemRevised> <ReserveLowered> boolean </ReserveLowered> <ReserveRemoved> boolean </ReserveRemoved> </ReviseStatus> <SecondaryCategory> CategoryType <CategoryID> string </CategoryID> <CategoryName> string </CategoryName> </SecondaryCategory> <Seller> UserType <AboutMePage> boolean </AboutMePage> <eBayGoodStanding> boolean </eBayGoodStanding> <Email> string </Email> <FeedbackPrivate> boolean </FeedbackPrivate> <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar> <FeedbackScore> int </FeedbackScore> <IDVerified> boolean </IDVerified> <NewUser> boolean </NewUser> <PositiveFeedbackPercent> float </PositiveFeedbackPercent> <RegistrationAddress> AddressType <CityName> string </CityName> <Country> CountryCodeType </Country> <CountryName> string </CountryName> <FirstName> string </FirstName> <LastName> string </LastName> <Name> string </Name> <Phone> string </Phone> <PostalCode> string </PostalCode> <Street> string </Street> <Street1> string </Street1> <Street2> string </Street2> </RegistrationAddress> <RegistrationDate> dateTime </RegistrationDate> <SellerInfo> SellerType <AllowPaymentEdit> boolean </AllowPaymentEdit> <BillingCurrency> CurrencyCodeType </BillingCurrency> <CheckoutEnabled> boolean </CheckoutEnabled> <CIPBankAccountStored> boolean </CIPBankAccountStored> <GoodStanding> boolean </GoodStanding> <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT> <SafePaymentExempt> boolean </SafePaymentExempt> <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType> <SellerLevel> SellerLevelCodeType </SellerLevel> <StoreOwner> boolean </StoreOwner> <StoreURL> anyURI </StoreURL> <TopRatedSeller> boolean </TopRatedSeller> </SellerInfo> <Site> SiteCodeType </Site> <Status> UserStatusCodeType </Status> <UserID> UserIDType (string) </UserID> <UserIDChanged> boolean </UserIDChanged> <UserIDLastChanged> dateTime </UserIDLastChanged> <VATStatus> VATStatusCodeType </VATStatus> </Seller> <SellerContactDetails> AddressType <CompanyName> string </CompanyName> <County> string </County> <FirstName> string </FirstName> <LastName> string </LastName> <PhoneAreaOrCityCode> string </PhoneAreaOrCityCode> <PhoneCountryCode> CountryCodeType </PhoneCountryCode> <PhoneCountryPrefix> string </PhoneCountryPrefix> <PhoneLocalNumber> string </PhoneLocalNumber> <Street1> string </Street1> <Street2> string </Street2> </SellerContactDetails> <SellerProfiles> SellerProfilesType <SellerPaymentProfile> SellerPaymentProfileType <PaymentProfileID> long </PaymentProfileID> <PaymentProfileName> string </PaymentProfileName> </SellerPaymentProfile> <SellerReturnProfile> SellerReturnProfileType <ReturnProfileID> long </ReturnProfileID> <ReturnProfileName> string </ReturnProfileName> </SellerReturnProfile> <SellerShippingProfile> SellerShippingProfileType <ShippingProfileID> long </ShippingProfileID> <ShippingProfileName> string </ShippingProfileName> </SellerShippingProfile> </SellerProfiles> <SellerVacationNote> string </SellerVacationNote> <SellingStatus> SellingStatusType <AdminEnded> boolean </AdminEnded> <BidCount> int </BidCount> <BidIncrement currencyID="CurrencyCodeType"> AmountType (double) </BidIncrement> <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice> <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice> <HighBidder> UserType <AboutMePage> boolean </AboutMePage> <BuyerInfo> BuyerType <ShippingAddress> AddressType <Country> CountryCodeType </Country> <FirstName> string </FirstName> <LastName> string </LastName> <PostalCode> string </PostalCode> </ShippingAddress> </BuyerInfo> <eBayGoodStanding> boolean </eBayGoodStanding> <Email> string </Email> <FeedbackPrivate> boolean </FeedbackPrivate> <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar> <FeedbackScore> int </FeedbackScore> <IDVerified> boolean </IDVerified> <NewUser> boolean </NewUser> <PositiveFeedbackPercent> float </PositiveFeedbackPercent> <RegistrationAddress> AddressType <CityName> string </CityName> <Country> CountryCodeType </Country> <CountryName> string </CountryName> <FirstName> string </FirstName> <LastName> string </LastName> <Name> string </Name> <Phone> string </Phone> <PostalCode> string </PostalCode> <Street> string </Street> <Street1> string </Street1> <Street2> string </Street2> </RegistrationAddress> <RegistrationDate> dateTime </RegistrationDate> <Site> SiteCodeType </Site> <Status> UserStatusCodeType </Status> <UserAnonymized> boolean </UserAnonymized> <UserID> UserIDType (string) </UserID> <UserIDChanged> boolean </UserIDChanged> <UserIDLastChanged> dateTime </UserIDLastChanged> <VATStatus> VATStatusCodeType </VATStatus> </HighBidder> <LeadCount> int </LeadCount> <ListingOnHold> boolean </ListingOnHold> <ListingStatus> ListingStatusCodeType </ListingStatus> <MinimumToBid currencyID="CurrencyCodeType"> AmountType (double) </MinimumToBid> <PromotionalSaleDetails> PromotionalSaleDetailsType <EndTime> dateTime </EndTime> <OriginalPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalPrice> <StartTime> dateTime </StartTime> </PromotionalSaleDetails> <QuantitySold> int </QuantitySold> <QuantitySoldByPickupInStore> int </QuantitySoldByPickupInStore> <ReserveMet> boolean </ReserveMet> <SecondChanceEligible> boolean </SecondChanceEligible> <SoldAsBin> boolean </SoldAsBin> </SellingStatus> <ShippingDetails> ShippingDetailsType <CalculatedShippingDiscount> CalculatedShippingDiscountType <DiscountName> DiscountNameCodeType </DiscountName> <DiscountProfile> DiscountProfileType <DiscountProfileID> string </DiscountProfileID> <DiscountProfileName> string </DiscountProfileName> <MappedDiscountProfileID> string </MappedDiscountProfileID> <WeightOff unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightOff> </DiscountProfile> <!-- ... more DiscountProfile nodes allowed here ... --> </CalculatedShippingDiscount> <CalculatedShippingRate> CalculatedShippingRateType <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts> <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts> </CalculatedShippingRate> <ExcludeShipToLocation> string </ExcludeShipToLocation> <!-- ... more ExcludeShipToLocation values allowed here ... --> <FlatShippingDiscount> FlatShippingDiscountType <DiscountName> DiscountNameCodeType </DiscountName> <DiscountProfile> DiscountProfileType <DiscountProfileID> string </DiscountProfileID> <DiscountProfileName> string </DiscountProfileName> <EachAdditionalAmount currencyID="CurrencyCodeType"> AmountType (double) </EachAdditionalAmount> <EachAdditionalAmountOff currencyID="CurrencyCodeType"> AmountType (double) </EachAdditionalAmountOff> <EachAdditionalPercentOff> float </EachAdditionalPercentOff> </DiscountProfile> <!-- ... more DiscountProfile nodes allowed here ... --> </FlatShippingDiscount> <GetItFast> boolean </GetItFast> <GlobalShipping> boolean </GlobalShipping> <InternationalCalculatedShippingDiscount> CalculatedShippingDiscountType <DiscountName> DiscountNameCodeType </DiscountName> <DiscountProfile> DiscountProfileType <DiscountProfileID> string </DiscountProfileID> <DiscountProfileName> string </DiscountProfileName> <MappedDiscountProfileID> string </MappedDiscountProfileID> <WeightOff unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightOff> </DiscountProfile> <!-- ... more DiscountProfile nodes allowed here ... --> </InternationalCalculatedShippingDiscount> <InternationalFlatShippingDiscount> FlatShippingDiscountType <DiscountName> DiscountNameCodeType </DiscountName> <DiscountProfile> DiscountProfileType <DiscountProfileID> string </DiscountProfileID> <DiscountProfileName> string </DiscountProfileName> <EachAdditionalAmount currencyID="CurrencyCodeType"> AmountType (double) </EachAdditionalAmount> <EachAdditionalAmountOff currencyID="CurrencyCodeType"> AmountType (double) </EachAdditionalAmountOff> <EachAdditionalPercentOff> float </EachAdditionalPercentOff> </DiscountProfile> <!-- ... more DiscountProfile nodes allowed here ... --> </InternationalFlatShippingDiscount> <InternationalPromotionalShippingDiscount> boolean </InternationalPromotionalShippingDiscount> <InternationalShippingDiscountProfileID> string </InternationalShippingDiscountProfileID> <InternationalShippingServiceOption> InternationalShippingServiceOptionsType <ShippingService> token </ShippingService> <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> <ShippingServicePriority> int </ShippingServicePriority> <ShipToLocation> string </ShipToLocation> <!-- ... more ShipToLocation values allowed here ... --> </InternationalShippingServiceOption> <!-- ... more InternationalShippingServiceOption nodes allowed here ... --> <PromotionalShippingDiscount> boolean </PromotionalShippingDiscount> <PromotionalShippingDiscountDetails> PromotionalShippingDiscountDetailsType <DiscountName> DiscountNameCodeType </DiscountName> <ItemCount> int </ItemCount> <OrderAmount currencyID="CurrencyCodeType"> AmountType (double) </OrderAmount> <ShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingCost> </PromotionalShippingDiscountDetails> <RateTableDetails> RateTableDetailsType <DomesticRateTable> string </DomesticRateTable> <DomesticRateTableId> string </DomesticRateTableId> <InternationalRateTable> string </InternationalRateTable> <InternationalRateTableId> string </InternationalRateTableId> </RateTableDetails> <SalesTax> SalesTaxType <SalesTaxPercent> float </SalesTaxPercent> <SalesTaxState> string </SalesTaxState> <ShippingIncludedInTax> boolean </ShippingIncludedInTax> </SalesTax> <SellerExcludeShipToLocationsPreference> boolean </SellerExcludeShipToLocationsPreference> <ShippingDiscountProfileID> string </ShippingDiscountProfileID> <ShippingServiceOptions> ShippingServiceOptionsType <ExpeditedService> boolean </ExpeditedService> <FreeShipping> boolean </FreeShipping> <ShippingService> token </ShippingService> <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> <ShippingServicePriority> int </ShippingServicePriority> <ShippingTimeMax> int </ShippingTimeMax> <ShippingTimeMin> int </ShippingTimeMin> </ShippingServiceOptions> <!-- ... more ShippingServiceOptions nodes allowed here ... --> <ShippingType> ShippingTypeCodeType </ShippingType> <TaxTable> TaxTableType <TaxJurisdiction> TaxJurisdictionType <JurisdictionID> string </JurisdictionID> <SalesTaxPercent> float </SalesTaxPercent> <ShippingIncludedInTax> boolean </ShippingIncludedInTax> </TaxJurisdiction> <!-- ... more TaxJurisdiction nodes allowed here ... --> </TaxTable> <ThirdPartyCheckout> boolean </ThirdPartyCheckout> </ShippingDetails> <ShippingPackageDetails> ShipPackageDetailsType <PackageDepth unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageDepth> <PackageLength unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageLength> <PackageWidth unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageWidth> <ShippingIrregular> boolean </ShippingIrregular> <ShippingPackage> ShippingPackageCodeType </ShippingPackage> <WeightMajor unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightMajor> <WeightMinor unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightMinor> </ShippingPackageDetails> <ShippingServiceCostOverrideList> ShippingServiceCostOverrideListType <ShippingServiceCostOverride> ShippingServiceCostOverrideType <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> <ShippingServicePriority> int </ShippingServicePriority> <ShippingServiceType> ShippingServiceType </ShippingServiceType> </ShippingServiceCostOverride> <!-- ... more ShippingServiceCostOverride nodes allowed here ... --> </ShippingServiceCostOverrideList> <ShipToLocations> string </ShipToLocations> <!-- ... more ShipToLocations values allowed here ... --> <Site> SiteCodeType </Site> <SKU> SKUType (string) </SKU> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> <Storefront> StorefrontType <StoreCategory2ID> long </StoreCategory2ID> <StoreCategoryID> long </StoreCategoryID> <StoreURL> anyURI </StoreURL> </Storefront> <SubTitle> string </SubTitle> <TaxCategory> string </TaxCategory> <TimeLeft> duration </TimeLeft> <Title> string </Title> <TopRatedListing> boolean </TopRatedListing> <UnitInfo> UnitInfoType <UnitQuantity> double </UnitQuantity> <UnitType> string </UnitType> </UnitInfo> <UUID> UUIDType (string) </UUID> <Variations> VariationsType <Pictures> PicturesType <VariationSpecificName> string </VariationSpecificName> <VariationSpecificPictureSet> VariationSpecificPictureSetType <ExtendedPictureDetails> ExtendedPictureDetailsType <PictureURLs> PictureURLsType <eBayPictureURL> anyURI </eBayPictureURL> <!-- ... more eBayPictureURL values allowed here ... --> <ExternalPictureURL> anyURI </ExternalPictureURL> </PictureURLs> <!-- ... more PictureURLs nodes allowed here ... --> </ExtendedPictureDetails> <ExternalPictureURL> anyURI </ExternalPictureURL> <!-- ... more ExternalPictureURL values allowed here ... --> <PictureURL> anyURI </PictureURL> <!-- ... more PictureURL values allowed here ... --> <VariationSpecificValue> string </VariationSpecificValue> </VariationSpecificPictureSet> <!-- ... more VariationSpecificPictureSet nodes allowed here ... --> </Pictures> <Variation> VariationType <DiscountPriceInfo> DiscountPriceInfoType <MadeForOutletComparisonPrice currencyID="CurrencyCodeType"> AmountType (double) </MadeForOutletComparisonPrice> <MinimumAdvertisedPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumAdvertisedPrice> <MinimumAdvertisedPriceExposure> MinimumAdvertisedPriceExposureCodeType </MinimumAdvertisedPriceExposure> <OriginalRetailPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalRetailPrice> <PricingTreatment> PricingTreatmentCodeType </PricingTreatment> <SoldOffeBay> boolean </SoldOffeBay> <SoldOneBay> boolean </SoldOneBay> </DiscountPriceInfo> <Quantity> int </Quantity> <SellingStatus> SellingStatusType <AdminEnded> boolean </AdminEnded> <BidCount> int </BidCount> <BidIncrement currencyID="CurrencyCodeType"> AmountType (double) </BidIncrement> <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice> <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice> <HighBidder> UserType <AboutMePage> boolean </AboutMePage> <BuyerInfo> BuyerType <ShippingAddress> AddressType <Country> CountryCodeType </Country> <FirstName> string </FirstName> <LastName> string </LastName> <PostalCode> string </PostalCode> </ShippingAddress> </BuyerInfo> <eBayGoodStanding> boolean </eBayGoodStanding> <Email> string </Email> <FeedbackPrivate> boolean </FeedbackPrivate> <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar> <FeedbackScore> int </FeedbackScore> <IDVerified> boolean </IDVerified> <NewUser> boolean </NewUser> <PositiveFeedbackPercent> float </PositiveFeedbackPercent> <RegistrationAddress> AddressType <CityName> string </CityName> <Country> CountryCodeType </Country> <CountryName> string </CountryName> <FirstName> string </FirstName> <LastName> string </LastName> <Name> string </Name> <Phone> string </Phone> <PostalCode> string </PostalCode> <Street> string </Street> <Street1> string </Street1> <Street2> string </Street2> </RegistrationAddress> <RegistrationDate> dateTime </RegistrationDate> <Site> SiteCodeType </Site> <Status> UserStatusCodeType </Status> <UserAnonymized> boolean </UserAnonymized> <UserID> UserIDType (string) </UserID> <UserIDChanged> boolean </UserIDChanged> <UserIDLastChanged> dateTime </UserIDLastChanged> <VATStatus> VATStatusCodeType </VATStatus> </HighBidder> <LeadCount> int </LeadCount> <ListingOnHold> boolean </ListingOnHold> <ListingStatus> ListingStatusCodeType </ListingStatus> <MinimumToBid currencyID="CurrencyCodeType"> AmountType (double) </MinimumToBid> <PromotionalSaleDetails> PromotionalSaleDetailsType <EndTime> dateTime </EndTime> <OriginalPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalPrice> <StartTime> dateTime </StartTime> </PromotionalSaleDetails> <QuantitySold> int </QuantitySold> <QuantitySoldByPickupInStore> int </QuantitySoldByPickupInStore> <ReserveMet> boolean </ReserveMet> <SecondChanceEligible> boolean </SecondChanceEligible> <SoldAsBin> boolean </SoldAsBin> </SellingStatus> <SKU> SKUType (string) </SKU> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> <VariationExtendedProducerResponsibility> VariationExtendedProducerResponsibilityType <EcoParticipationFee currencyID="CurrencyCodeType"> AmountType (double) </EcoParticipationFee> </VariationExtendedProducerResponsibility> <VariationProductListingDetails> VariationProductListingDetailsType <EAN> string </EAN> <ISBN> string </ISBN> <ProductReferenceID> string </ProductReferenceID> <UPC> string </UPC> </VariationProductListingDetails> <VariationSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Source> ItemSpecificSourceCodeType </Source> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </VariationSpecifics> <!-- ... more VariationSpecifics nodes allowed here ... --> </Variation> <!-- ... more Variation nodes allowed here ... --> <VariationSpecificsSet> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Source> ItemSpecificSourceCodeType </Source> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </VariationSpecificsSet> </Variations> <VATDetails> VATDetailsType <VATPercent> float </VATPercent> </VATDetails> <VideoDetails> VideoDetailsType <VideoID> string </VideoID> <!-- ... more VideoID values allowed here ... --> </VideoDetails> <VIN> string </VIN> <VINLink> string </VINLink> <VRM> string </VRM> <VRMLink> string </VRMLink> <WatchCount> long </WatchCount> </Item> <!-- 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 allowed here ... --> <LongMessage> string </LongMessage> <SeverityCode> SeverityCodeType </SeverityCode> <ShortMessage> string </ShortMessage> </Errors> <!-- ... more Errors nodes allowed here ... --> <HardExpirationWarning> string </HardExpirationWarning> <Timestamp> dateTime </Timestamp> <Version> string </Version> </GetItemResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
Item | ItemType | Always |
This container consists of detailed information about the retrieved listing. The amount of information that is returned is partially controlled by the filters that are set in the call request.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ApplicationData | string | Conditionally |
Return custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField. Max length: 32. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ApplyBuyerProtection | BuyerProtectionDetailsType | Conditionally | Different Buyer protection schemes and the various status associated with each one of them. |
Item.ApplyBuyerProtection .BuyerProtectionSource |
BuyerProtectionSourceCodeType | Conditionally |
This value indicates the type of buyer protection program applicable for the item. This field is always returned with the ApplyBuyerProtection container.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Item.ApplyBuyerProtection .BuyerProtectionStatus |
BuyerProtectionCodeType | Conditionally |
This value indicates the item's eligibility for the buyer protection program listed in the ApplyBuyerProtection.BuyerProtectionSource field. This field is always returned with the ApplyBuyerProtection container.
Applicable values: See BuyerProtectionStatus. Code so that your app gracefully handles any future changes to this list. |
Item.AutoPay | boolean | Always |
This field is included and set to if true in an Add/Revise/Relist call if the seller wants to require immediate payment from the buyer. If this field is set to false or not included, the seller is not requesting immediate payment. Note that this field may be set to true , but that does not necessarily mean that the buyer will be required to pay right away. For example, immediate payment is not currently applicable to auctions items won in a competitive bidding process or to items where the buyer and seller negotiated the price through the Best Offer feature. Immediate payment is also not applicable to listings where the payment happens offline between the buyer and seller.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.AvailableForPickupDropOff | boolean | Conditionally |
This field is only returned if true , and indicates that the 'Click and Collect' feature is available for this item. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK, Australia, and Germany sites, and then pick up their order from the nearest 'eBay Collection Point'. Note that an item may be eligible for Click and Collect, but this logistics option will only surface if the prospective buyer is within the vicinity of an 'eBay Collection Point'. The Click and Collect feature is only available on the eBay UK, Australia, and Germany sites. For more information about Click and Collect, see the Click and Collect home page on the eBay UK site, the Click and Collect home page on the eBay Australia site, or the Click and Collect home page on the eBay Germany site. Not all categories on the UK, Australia, and Germany sites support Click and Collect listings. To verify if a specific category on these eBay sites support Click and Collect listings, use the GetCategoryFeatures call, passing in one or more CategoryID values and a PickupDropOffEnabled value in the FeatureID field. Look for a true value in the PickupDropOffEnabled field of the corresponding Category node (match up the CategoryID values if more than one Category IDs were passed in the request). Note: For Click and Collect eligible sellers, the Click and Collect feature can only be enabled at the account level, and then each of the seller's listings will be automatically evaluated for Click and Collect eligibility. |
Item.BestOfferDetails | BestOfferDetailsType | Conditionally |
For Add/Revise/Relist/Verify calls: This container is used to enable the Best Offer feature on a listing. Note that the Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but a seller can only use Best Offer or Buy It Now, but not both. Once an auction listing receives a qualifying bid, the Best Offer feature will be turned off and any pending Best Offers or Counteroffers will no longer be valid. For GetItem and other calls that retrieve item data, this container will include the status (GetMyeBayBuying only) and dollar amount of the latest Best Offer on a fixed-price listing, and the number of Best Offers received for the fixed-price listing. Note: Best Offer is not available for multi-variation listings. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BestOfferDetails .BestOfferCount |
int | Conditionally |
The number of Best Offers made for this item, if any. In other words, if there are no Best Offers made, this field will not appear in the response. This field is not applicable to the Add/Revise/Relist calls.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BestOfferDetails .BestOfferEnabled |
boolean | Conditionally |
This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a listing as long as the category supports the Best Offer feature. To see if an eBay category supports the Best Offer feature, run a GetCategoryFeatures call, including BestOfferEnabled as a FeatureID value in the call request payload. A listing enabled with the Best Offer feature allows a buyer to bargain with the seller and make a lower-priced offer than the fixed price or the starting bid price for an auction listing. The seller can then decide whether to accept the buyer's Best Offer price or propose a counter offer higher than the Best Offer price, but lower than the fixed price or starting bid price. Note: The Best Offer feature is now available for auction listings on the following sites: US, Canada, UK, Germany, Australia, France, Italy, and Spain. However, sellers must choose between offering Best Offer or Buy It Now on an auction listing, as both features cannot be enabled on the same auction listing. If an auction listing is enabled with Best Offer, this feature will no longer be applicable once the listing receives its first qualifying bid. Note: Best Offer is not available for multi-variation listings. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails | BusinessSellerDetailsType | Conditionally |
Returns the seller's information (in a business card format) if the seller's SellerBusinessCodeType is set to Commercial . This is only applicable for sites where Business Seller options are supported.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .AdditionalContactInformation |
string | Conditionally |
This field shows any additional contact for the Business Seller in free-form text. This field is only returned if known and available.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .Address |
AddressType | Conditionally |
This field shows the address on file for the Business Seller.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .Address.FirstName |
string | Conditionally |
Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType value is Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .Address.LastName |
string | Conditionally |
Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails |
string | Conditionally |
This field shows the email address on file for the Business Seller.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails.Fax | string | Conditionally |
This field shows the Fax number on file for the Business Seller. This field is only returned if known and available.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .LegalInvoice |
boolean | Conditionally |
This boolean field is returned as true if the Business Seller provides legal invoices to buyers.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .TermsAndConditions |
string | Conditionally |
This free-form text field provides the Business Seller's terms and conditions for doing business.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .TradeRegistrationNumber |
string | Conditionally |
This field shows the Trade Registration Number for the Business Seller.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .VATDetails |
VATDetailsType | Conditionally |
This container provides Value-Added Tax (VAT) details for the Business Seller, including the seller's VAT ID and the VAT percentage rate applicable to the item. VAT is similar to a sales and/or consumption tax, and it is only applicable to sellers selling on European sites.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .VATDetails.BusinessSeller |
boolean | Conditionally |
This field should be included in an Add/Revise/Relist call and set to true if the seller is registered on the selling site as a Business Seller. This field must be included and set to true if the RestrictedToBusiness field is also included and set to true . The RestrictedToBusiness field is used by German (Site ID 77), Austrian (Site ID 16), and Swiss (Site ID 193) sellers who wish to restrict sales of their item to other users registered as business users. This field is returned in 'Get' calls only if set on the listing, and the person making the call owns the listing. However, other Business Seller-related information will be returned to all users in 'Get' calls under the SellerInfo and BusinessSellerDetails containers. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .VATDetails .RestrictedToBusiness |
boolean | Conditionally |
This field must be included in an Add/Revise/Relist call and set to true if a German (Site ID 77), Austrian (Site ID 16), or Swiss (Site ID 193) seller wishes to restrict sales of their item to other users registered on eBay as business users. If this field is set as true , the BusinessSeller field must also be included and set to true . This feature is not available on any other eBay marketplaces. This field can be included and set to true only by Business Sellers registered on one of the three sites above, and only if the listing category supports Business-to-Business listings. The GetCategories call can be used by the seller (using one of the Site IDs above) to see which categories support Business-to-Business listings. A B2BVATEnabled boolean field will be returned as true if a listing category supports Business-to-Business listings. This field is returned in 'Get' calls only if set on the listing, and the person making the call owns the listing. However, other Business Seller-related information will be returned to all users in 'Get' calls under the SellerInfo and BusinessSellerDetails containers. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .VATDetails.VATID |
string | Conditionally |
This is the unique VAT identifier associated with the Business Seller's account. This field will only be returned to Business Sellers who own the specified listing. Non-Business Sellers will not have a VAT identifier associated with their account, so this field will never be returned for those users. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .VATDetails.VATPercent |
float | Conditionally |
This container is used in an Add/Revise/Relist call to set the VAT (Value-added Tax) percentage rate that will be charged to buyers when an item is purchased from the listing. VAT is not applicable to all countries, including the US. Allowed VAT percentage rates can vary by region/country, so sellers should be aware of the rates they are legally required/allowed to charge, and they are responsible for charging the correct VAT rate. If VAT is charged on a listing, the seller can choose to print an invoice for the buyer that shows the item's net price, the VAT percentage rate, the VAT amount, and the total price. This field is returned in 'Get' calls only if the listing is subject to VAT. Note: Previously, up to three digits beyond the decimal point were allowed for this float value, but now a seller can include only one digit beyond the decimal point (e.g. 12.3) when using an Add/Revise/Relist call to set this value. An error will occur if more digits beyond the decimal point are specified. Min: 0.0. Max: 27.0. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BusinessSellerDetails .VATDetails.VATSite |
string | Conditionally |
This string value is the Site ID value of the eBay Marketplace where the VAT is applicable and where the seller is registered as a Business Seller. The eBay sites that support VAT (and their corresponding Site IDs) can be found in the Value-added tax (VAT) topic. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerGuaranteePrice | AmountType (double) | Conditionally |
The eBay Best Price Guarantee price. The Best Price Guarantee program is only available on the eBay Australia marketplace.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerGuaranteePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The eBay Best Price Guarantee price. The Best Price Guarantee program is only available on the eBay Australia marketplace. For a list of possible enumeration values, see CurrencyCodeType. |
Item.BuyerProtection | BuyerProtectionCodeType | Conditionally |
The enumeration value returned in this field indicates whether an item is eligible for the buyer protection.
Applicable values: See BuyerProtection. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerRequirementDetails | BuyerRequirementDetailsType | Conditionally |
This container is returned if the seller has applied one or more buyer requirement criteria to the listing. Buyer requirement settings are managed in the Selling Preferences section of the seller's account in My eBay.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerRequirementDetails .MaximumItemRequirements |
MaximumItemRequirementsType | Conditionally |
This container is returned if the seller has set a maximum quantity threshold buyer requirement. With this buyer requirement, a buyer is limited in regards to the quantity of a line item that may be purchased. This buyer requirement is only applicable to fixed-price listings where multiple quantity is available for purchase. In addition to setting a maximum quantity threshold buyer requirement, the seller can also choose to apply this threshold to only those prospective buyers who don't meet or exceed the minimum Feedback score threshold. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerRequirementDetails .MaximumItemRequirements .MaximumItemCount |
int | Conditionally |
This field indicates the maximum quantity of a line item that one prospective buyer may purchase from the listing. This buyer requirement is only applicable to fixed-price listings where multiple quantity is available for purchase. If the MinimumFeedbackScore field is also set/returned, the maximum quantity threshold value will only apply to those prospective buyers who don't meet or exceed the minimum Feedback score threshold returned in that field. If the MinimumFeedbackScore field not set/returned, the maximum quantity threshold value will apply to all prospective buyers. This field is always returned along with the MaximumItemRequirements container. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerRequirementDetails .MaximumItemRequirements .MinimumFeedbackScore |
int | Conditionally |
If this field is returned, it indicates that the seller has set a maximum quantity threshold value, but this maximum quantity threshold value (returned in MaximumItemCount will only apply to those prospective buyers who don't meet or exceed the minimum Feedback score threshold returned in this field. If this field is not returned, the maximum quantity threshold value will apply to all prospective buyers.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerRequirementDetails .MaximumUnpaidItemStrikesInfo |
MaximumUnpaidItemStrikesInfoType | Conditionally |
This container is returned if the seller has enabled a setting to block prospective buyers who have one or more unpaid items and/or buyer-initiated cancellations on their account during a specified time period.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerRequirementDetails .MaximumUnpaidItemStrikesInfo .Count |
int | Conditionally |
This integer value indicates the maximum number of unpaid items and/or buyer-initiated cancellations that a prospective buyer is allowed to have during a specified time period (MaximumUnpaidItemStrikesInfo.Period) before being blocked from buying or bidding on the item.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerRequirementDetails .MaximumUnpaidItemStrikesInfo .Period |
PeriodCodeType | Conditionally |
This enumerated value defines the length of time over which a prospective buyer's unpaid items and/or buyer-initiated cancellations will be counted. If the prospective buyer's number of unpaid items and/or buyer-initiated cancellations during this defined period exceeds the value set in the MaximumUnpaidItemStrikesInfo.Count field, that prospective buyer is blocked from buying/bidding on the item. If the Count value is 2, and the specified Period is Days_30 (counting back 30 days from the present day), any prospective buyer that has had three or more unpaid items and/or buyer-initiated cancellations is blocked from buying/bidding on the item.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerRequirementDetails .ShipToRegistrationCountry |
boolean | Conditionally |
This field is returned as true if the seller has enabled the setting to block buyers/bidders who reside (according to their eBay primary shipping address) in countries that are on the seller's ship-to exclusion list. Default: false. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyerRequirementDetails .ZeroFeedbackScore |
boolean | Conditionally |
This field is returned as true if the seller has enabled the setting to block buyers/bidders with a feedback score of 0 from buying items. Default: false. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .BuyerResponsibleForShipping |
boolean | Conditionally |
Applicable for listings in vehicle categories on the US eBay Motors site and eBay Canada site. (No business effect if specified for other categories or sites, as the Web site will not display the information to buyers.)
If true and the listing is on the US eBay Motors site, and you want the listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA. If true and the listing is on the eBay Canada site, and you want your listing to be visible on the US eBay Motors site, set Item.ShipToLocations to US. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyItNowPrice | AmountType (double) | Always |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. For a list of possible enumeration values, see CurrencyCodeType. |
Item.Charity | CharityType | Conditionally |
This container identifies the nonprofit organization that will benefit with a percentage of the proceeds from each sale of an item through an auction or fixed-price listing. Charity names and IDs can be found by going to eBay for Charity page and doing a search. The donation percentage can be set in 5 percent increments from 10 percent to 100 percent. When it comes to revising an auction or fixed-price listing, you can add a benefitting charity (as long as there is at least 12 hours left before end of listing/close of auction), but you cannot remove or change a nonprofit company once one is already established in the original listing. For Revise calls: The non-profit organization and donation percentage can now be modified in a Revise call as long as there are no active bids on an auction listing, or no pending Best Offers/Counter Offers on a listing. This container will only be returned in Get calls for charitable listings. Charitable listings are only supported in the US and UK marketplaces. DetailLevel: ItemReturnDescription, ReturnAll. See:
|
Item.Charity.CharityID | string | Conditionally |
The unique identifier that eBay creates and assigns to each nonprofit organization. The field is conditionally required in an Add/Revise/Relist call if the seller will be donating a percentage of the sale proceeds to this organization for each sale generated by the listing. DetailLevel: ItemReturnDescription, ReturnAll. |
Item.Charity.CharityName | string | Conditionally |
The full name of the nonprofit organization. Max length: 150. DetailLevel: ItemReturnDescription, ReturnAll. |
Item.Charity.DonationPercent | float | Conditionally |
The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the eBay for Charity listing. Possible values: 10.0 to 100.0.
DetailLevel: ItemReturnDescription, ReturnAll. |
Item.Charity.LogoURL | string | Conditionally |
The full URL to the nonprofit organization's logo image file. This logo image file is the image that is displayed in all eBay listings that benefit that charity. This field is returned as long as it is defined for the nonprofit organization.
DetailLevel: ItemReturnDescription, ReturnAll. |
Item.Charity.Mission | string | Conditionally |
The stated mission of the nonprofit charity organization. This mission statement is displayed in the eBay for Charity section of the View Item page. Max length: 511. DetailLevel: ItemReturnDescription, ReturnAll. |
Item.Charity.Status | CharityStatusCodeType | Conditionally |
This enumeration value indicates whether or not the nonprofit organization is a valid eBay for Charity organization, and is able to receive proceeds from eBay sales.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. |
Item.ConditionDefinition | string | Conditionally |
This string value provides more details about the item's condition.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ConditionDescriptors | ConditionDescriptorsType | Conditionally |
This container is used in Add/Revise/Relist/Verify listing calls to designate the condition descriptors for the listing. It is also returned in GetItem to indicate the condition descriptors applied to the listing. Important: For trading card listings in Non-Sport Trading Card Singles ( 183050 ), CCG Individual Cards (183454 ), and Sports Trading Card Singles (261328 ) categories, Condition ID 2750 can be used to specify the card as a Graded card and Condition ID 4000 can be used to specify the card as an Ungraded card. If either of these condition IDs are used, the seller is required to use the ConditionDescriptors container to provide one or more applicable Condition Descriptor name-value pairs. Beginning on October 23rd, 2023, trading card listings in the affected categories must either use Condition ID 2750 or Condition ID 4000, and no other item conditions will be accepted. These Condition IDs and the ConditionDescriptors container will be required for all new listings. If not provided after this date, the following calls will fail: AddItem, AddFixedPriceItem, AddItems, VerifyAddItem, and VerifyAddFixedPriceItem. By January 22, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable ConditionDescriptors name-value pairs. This adds ReviseItem, ReviseFixedPriceItem, RelistItem, RelistFixedPriceItem, and VerifyRelistItem calls to the requirement. |
Item.ConditionDescriptors .ConditionDescriptor |
ConditionDescriptorType | Conditionally,
repeatable: [0..*] |
This container is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that can be either closed set or open text inputs. To retrieve all condition descriptor numeric IDs for a category, use the getItemConditionPolicies method of the Metadata API. Note: The use of Condition Descriptors is currently only available for the following trading card categories (CategoryID):
|
Item.ConditionDescriptors .ConditionDescriptor .AdditionalInfo |
string | Conditionally |
Open text is passed in this field. This text provides additional information about a condition descriptor. In the case of trading cards, this field houses the optional Certification Number condition descriptor for graded cards. Max length: 30. |
Item.ConditionDescriptors .ConditionDescriptor.Name |
string | Conditionally |
A numeric ID is passed in this field. This numeric ID maps to the name of a condition descriptor. Condition descriptor name-value pairs provide more information about an item's condition in a structured way. To retrieve all condition descriptor numeric IDs for a category, use the getItemConditionPolicies method of the Metadata API. In the case of trading cards, this field is used to provide condition descriptors for a card. For graded cards, the condition descriptors for Grader and Grade are required, while the condition descriptor for Certification Number is optional. For ungraded cards, only the Card Condition condition descriptor is required. |
Item.ConditionDescriptors .ConditionDescriptor.Value |
string | Conditionally,
repeatable: [0..*] |
A numeric ID is passed in this field. This numeric ID maps to the value associated with a condition descriptor name. Condition descriptor name-value pairs provide more information about an item's condition in a structured way. To retrieve all condition descriptor numeric IDs for a category, use the getItemConditionPolicies method of the Metadata API. In the case of trading cards, this field houses the information on the Grader and Grade descriptors of graded cards and the Card Condition descriptor for ungraded cards. |
Item.ConditionDisplayName | string | Conditionally |
The human-readable label for the item condition. Display names are localized for the site on which they're listed (not necessarily the site on which they're viewed). Most categories use the same display name for the same condition ID. Some categories may override the display name based on buyer expectations for items in the category. For example, condition ID 1000 could be called "New" in one category and "New with tags" in another. Behind the scenes, eBay's search engine uses the ID (not the display name) to determine whether items are new, used, or refurbished. Only returned when the seller specified ConditionID in their listing. Note: This field will stop being returned in order management calls on January 31, 2024. Max length: 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ConditionID | int | Conditionally |
This is a numeric identifier for an item's condition. All numeric Condition ID values map to an item condition string value. For example, numeric identifier 1000 maps to New condition. Important: For trading card listings in Non-Sport Trading Card Singles ( 183050 ), CCG Individual Cards (183454 ), and Sports Trading Card Singles (261328 ) categories, Condition ID 2750 can be used to specify the card as a Graded card and Condition ID 4000 can be used to specify the card as an Ungraded card. If either of these condition IDs are used, the seller is required to use the ConditionDescriptors container to provide one or more applicable Condition Descriptor name-value pairs. See the ConditionDescriptors field description for more information. Beginning on October 23rd, 2023, trading card listings in the affected categories must either use Condition ID 2750 or Condition ID 4000, and no other item conditions will be accepted. These Condition IDs and the ConditionDescriptors container will be required for all new listings. If not provided after this date, the following calls will fail: AddItem, AddFixedPriceItem, AddItems, VerifyAddItem, and VerifyAddFixedPriceItem. By January 22, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable ConditionDescriptors name-value pairs. This adds ReviseItem, ReviseFixedPriceItem, RelistItem, RelistFixedPriceItem, and VerifyRelistItem calls to the requirement. Most eBay listing categories require an item condition, but a few eBay categories do not (such as Digital Gift Cards or Antiques categories). To verify if the listing category requires an item condition, and if so, what are the supported item condition and ConditionID values, you can call GetCategoryFeatures. In this GetCategoryFeatures call, you'd pass in the listing CategoryID value and two FeatureID fields - one of these fields set to ConditionEnabled , and the other field set to ConditionValues . In the GetCategoryFeatures response, look at the Category.ConditionEnabled to see if item condition is required for the category. Then look at the Category.ConditionValues container in the response for the full list of Condition IDs that you can pass in through the ConditionID field of an Add/Revise/Relist/Verify call. Note that the Condition.DisplayName value in the response is the actual condition value that will appear in the actual eBay listing. If you pass in a ConditionID value that is not valid for the category, or if you don't pass in a ConditionID value at all for a category that requires it, the listing request fails. If you are listing in two categories (using a secondary category), it is the primary listing category that determines which ConditionID values are supported. For Revise/Relist calls: In most cases, you can change the ConditionID value (if applicable/warranted), with the exception being an auction listing that has one or more bids, or any listing that is scheduled to end in 12 hours or less. For GetItem: The ConditionID value is always returned if set for the listing. GetItem also returns the item condition string value in the ConditionDisplayName field. Note: On the US, Canada, UK, Germany, France, Italy, and Australia marketplaces, condition ID 2500 ('Seller Refurbished') can no longer be used in numerous categories. See Category and marketplace support for the eBay Refurbished Program for the full list. In these categories, the 'Seller Refurbished' item condition has been replaced by one of three new refurbished values, which include condition ID 2010 ('Excellent - Refurbished'), condition ID 2020 ('Very Good - Refurbished'), and condition ID 2030 ('Good - Refurbished'). To use any of these new refurbished item conditions, sellers must go through an application and qualification process. Any seller who is not eligible to use these new refurbished item conditions in these three categories will be blocked if they try to create a new listing or revise an existing listing with any of these three new item conditions. Sellers who are not eligible to list with the new refurbished item conditions, will need to use another item condition supported in these categories, such as condition ID 3000 ('Used'). Any seller that is interested in eligibility requirements to list with any refurbished item condition, including condition ID 2000 ('Certified - Refurbished'), should see the eBay Refurbished Program page in Seller Center. Note: This field will stop being returned in order management calls on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
Item.Country | CountryCodeType | Always |
This two-digit enumeration value indicates the country where the item is located. CountryCodeType defines the supported values. The GeteBayDetails call can also be used (include the DetailName field and set its value to CountryDetails) to see the full list of supported country codes. In an Add/Revise/Relist/Verify call, this field is required. Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.CrossBorderTrade | string | Always,
repeatable: [1..*] |
This field is used by sellers who want their listing to be returned in the search results for other eBay sites. This feature is currently only supported by the US, UK, eBay Canada, and eBay Ireland sites. See Getting exposure on international sites for full requirements on using this feature. There is a small listing fee for each country specified as a Cross Border Trade country. US listings that offer shipping to Canada, North America, or worldwide are automatically returned on eBay.ca at no extra charge, so US listings that offer shipping to these locations do not need to specify Canada as a Cross Border Trade country. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Cross-border trading. |
Item.Currency | CurrencyCodeType | Always |
In an Add/Revise/Relist/Verify call, this required three-digit enumeration value defines the currency associated with the listing site. The item price and all costs passed in the call request will be using this currency. Similarly, the listing fees and other cost-related data will be using this currency. Since the Trading API can only be used for a select number of eBay sites, only a subset of values are supporting when adding/revising/relisting an item. These supported values are discussed in the top section of CurrencyCodeType. In 'Get' calls, it is possible that any of the values in CurrencyCodeType may appear, as some cost-related fields will show the buyer's currency type. Applicable values: See Currency. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Description | string | Always |
The seller's description of the item. In listing requests, you can submit your description using CDATA if you want to use HTML or XML-reserved characters in the description. However, a seller can not use any active content in their listing description. Active content includes animation or video via JavaScript, Flash, plug-ins, or form actions. All active content will be blocked/removed from a listing. Removing/blocking active content will lead to faster load times of listings, make listings more mobile-friendly, improve SEO performance, and lead to a more secure eBay Marketplace. Note: To ensure that their listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay's View Item description summary feature when listing their item. Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the listing description that is displayed for prospective buyers when viewing the item on a mobile device. The listing description on mobile devices is limited to 800 characters, and whenever the listing description exceeds this limit, eBay uses a special algorithm to derive the best possible description within the 800-character limit. However, due to some description content being removed, it is definitely not ideal for the seller, and could possibly lead to a bad buyer experience and a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item. See the eBay help page for more details on using the HTML div and span tags, and for more tips on creating listings that are mobile-friendly, see this Best practices document. In the listing description, sellers are only allowed to provide links to product videos, freight shipping services, or other legally required information, and when providing these links in the listing description, the secure 'https' protocol must be used instead of 'http'. In addition, any valid links to sites outside of eBay should use the target="_blank" attribute in the a href tag so a new browser window will be loaded when the link is clicked instead of buyers being redirected off of eBay. For more information on using links in the listing description, see eBay's Links policy. For more information about the stronger security standards that eBay is using, see the Use secure HTTPS for enhanced browser security topic in the 2018 Fall Seller Update. The getListingViolations method of the Compliance API can be used to see if any of the seller's active listings are not 'HTTPS' compliant. If you embed pictures in the description (by using IMG tags) instead of using PictureURL, but you want a camera icon to appear in search and listing pages, specify the following null-image URL in the PictureURL field: https://pics.ebay.com/aw/pics/dot_clear.gif. See Add pictures in the Trading API User Guide. This field is conditionally required for all listings. The exception is when the seller specifies a product identifier, such as a GTIN or ePID, through the ProductListingDetails container and a product match is found in the eBay product catalog. If a matching product is found in the eBay product catalog, the item description will be created automatically (as long as the ProductListingDetails.IncludeeBayProductDetails value is true ). Max length: 500000 (some sites may allow more, but the exact number may vary). DetailLevel: ItemReturnDescription, ReturnAll. |
Item.DigitalGoodInfo | DigitalGoodInfoType | Conditionally | This container is used in Add/Revise/Relist/Verify listing calls to designate the listing as a digital gift card listing. It is also returned in GetItem to indicate that the listing contains a digital gift card. |
Item.DigitalGoodInfo .DigitalDelivery |
boolean | Conditionally |
This field must be included in the request and set to true if the seller plans to list a digital gift card in a category that supports digital gift cards. To verify if a specific category on a specific eBay site supports digital gift card listings, use the GetCategoryFeatures call, passing in a CategoryID value and a DigitalGoodDeliveryEnabled value in the FeatureID field. Look for a true value in the DigitalGoodDeliveryEnabled field of the corresponding Category node (match up the CategoryID values if more than one Category IDs were passed in the request).
|
Item.DisableBuyerRequirements | boolean | Conditionally |
This field can be included and set to true in an Add or Revise call if the seller wishes to disable all buyer requirements (that are set in the seller's account) for the listing. (from Item.BuyerRequirementDetails or Buyer requirements preferences in My eBay) are ignored. This field will only be returned in 'Get' calls if true .Default: false. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.DiscountPriceInfo | DiscountPriceInfoType | Conditionally |
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. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, Spain, and Ireland sites, while MAP is available only on the US site. Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a 'special account flag' (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. STP is intended for eBay partners and their sellers only. As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing. For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem: If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.DiscountPriceInfo .MadeForOutletComparisonPrice |
AmountType (double) | Conditionally |
Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet). The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet. In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.) DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.DiscountPriceInfo .MadeForOutletComparisonPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet). The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet. In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.) For a list of possible enumeration values, see CurrencyCodeType. |
Item.DiscountPriceInfo .MinimumAdvertisedPrice |
AmountType (double) | Conditionally |
Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can offer prices below MAP by means of other discounts. This only applies to fixed-price listings and auction listings with the Buy It Now option.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.DiscountPriceInfo .MinimumAdvertisedPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can offer prices below MAP by means of other discounts. This only applies to fixed-price listings and auction listings with the Buy It Now option. For a list of possible enumeration values, see CurrencyCodeType. |
Item.DiscountPriceInfo .MinimumAdvertisedPriceExposure |
MinimumAdvertisedPriceExposureCodeType | Conditionally |
For MinimumAdvertisedPrice (MAP) listings only. A seller cannot show the actual discounted price on eBay's View Item page. Instead, the buyer can either click on a pop-up on eBay's View Item page, or the discount price will be shown during checkout.
Applicable values: DuringCheckout .PreCheckout .PreCheckout .Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.DiscountPriceInfo .OriginalRetailPrice |
AmountType (double) | Conditionally |
The actual retail price set by the manufacturer (OEM). eBay does not maintain or validate the OriginalRetailPrice supplied by the seller. OriginalRetailPrice should always be more than StartPrice. Compare the StartPrice/BuyItNowPrice to OriginalRetailPrice to determine the amount of savings to the buyer.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.DiscountPriceInfo .OriginalRetailPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The actual retail price set by the manufacturer (OEM). eBay does not maintain or validate the OriginalRetailPrice supplied by the seller. OriginalRetailPrice should always be more than StartPrice. Compare the StartPrice/BuyItNowPrice to OriginalRetailPrice to determine the amount of savings to the buyer. For a list of possible enumeration values, see CurrencyCodeType. |
Item.DiscountPriceInfo .PricingTreatment |
PricingTreatmentCodeType | Conditionally |
Based on OriginalRetailPrice, MinimumAdvertisedPrice, and StartPrice values, eBay identifies whether the listing falls under MAP or STP (aka OriginalRetailPrice). GetItem returns this for items listed with one of these discount pricing treatments. GetSellerList returns the DiscountPriceInfo container. This field is not applicable for Add/Revise/Relist calls. Default: false. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.DiscountPriceInfo .SoldOffeBay |
boolean | Conditionally |
Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on a Web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the seller's own price for the item. If this field is set to true , eBay displays 'Was*' in the UK and 'Ursprunglich*' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set to true , SoldOneBay takes precedence. Default: false. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.DiscountPriceInfo .SoldOneBay |
boolean | Conditionally |
Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on eBay within the previous 30 days. The discount price is always in reference to the seller's own price for the item. If this field is set to true , eBay displays 'Was' in the UK and 'Ursprunglich' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set to true , SoldOneBay takes precedence. Default: false. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.DispatchTimeMax | int | Conditionally |
Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. This time does not include the shipping time (the carrier's transit time). Note: If the seller opts into the eBay Guaranteed Delivery feature and wants to make a listing eligible for eBay Guaranteed Delivery, the DispatchTimeMax value must be set to 0 or 1 (days) and the cumulative value of DispatchTimeMax plus the transit time of the shipping service (returned in ShippingServiceDetails.ShippingTimeMax field of GeteBayDetails) must be 4 business days or less to be eligible for this feature. See the eBay Guaranteed Delivery page in Seller Center for more information on this program. The eBay Guaranteed Delivery feature is only available on the US and Australia marketplaces. For Add/Revise/Relist calls: Required for listings in certain categories when certain shipping services (with delivery) are offered. See HandlingTimeEnabled in GetCategoryFeatures. The seller sets this to a positive integer value corresponding to the number of 'handling' days. For a list of allowed values on each eBay site, use DispatchTimeMaxDetails in GeteBayDetails. Supported handling times for most sites in most categories range from 0 (same-day handling) to 3 business days, but this can vary by site. Some categories on some sites support longer handling times, and this generally comes into play with extremely large items where freight shipping may be required. This field is required whenever flat-rate or calculated shipping is used, but does not apply when there is no shipping involved, which is the case for digital gift card listings, or any orders where local pickup is available and this option is selected by the buyer. For ReviseItem only: If the listing has bids or sales and it ends within 12 hours, you can't change this value. 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 or change this value. If the listing has no bids or sales and more than 12 hours remain before the listing ends, you can add or change the dispatch (handling) time. For GetItem: GetItem returns DispatchTimeMax only when shipping service options are specified for the item and the seller specified a dispatch time. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
Item.eBayPlus | boolean | Conditionally |
eBay Plus is a premium account option for buyers, which provides benefits such as fast and free domestic shipping, and free returns on selected items. To offer this feature to buyers, sellers must opt in to eBay Plus, and their selling status must be 'Above Standard' or above. Note: Currently, eBay Plus is only available to buyers on the Germany and Australia marketplaces, and this field should only be used by sellers selling eligible items in Germany. In Australia, the seller has no control/responsibility over setting the eBay Plus feature for a listing. Instead, eBay will evaluate/determine whether a listing is eligible for eBay Plus. Due to this fact, an Australian seller will also get the 21919431: This listing isn't eligible for eBay Plus. warning message in an add/revise/relist call, even though eBay may ultimately set the eBay Plus feature on the listing if the item is eligible. In an add/revise/relist call, a seller on the Germany site must include this field and set its value to true . If the seller is not eligible for/opted in to eBay Plus and/or the listing category or item does not qualify for eBay Plus, a warning message will be returned to the seller in the response indicating this. In addition to the seller, listing category, and item being eligible for eBay Plus, the seller must also set/commit to the following for the listing:
true in a 'Get' call, it indicates that the item is eligible for eBay Plus treatment, but eBay Plus will only come into play if the buyer is subscribed to eBay Plus.
See:
|
Item.eBayPlusEligible | boolean | Conditionally |
If this field is returned as true , this item is eligible to be listed under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast and free domestic shipping and free returns on selected items. eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Among other requirements, sellers must commit to next-day delivery of those items. Note: Currently, eBay Plus is available only to buyers in Germany and Australia marketplaces. See eBay Plus for more details. |
Item.EligibleForPickupDropOff | boolean | Conditionally |
For 'Click and Collect' eligible sellers, this field was once used to set 'Click and Collect' eligibility at the listing level. However, now the seller can only opt in to 'Click and Collect' at the account level, and then each of their listings will be automatically evaluated for 'Click and Collect' eligibility. Note: Until this field is fully deprecated in the Trading WSDL (and in Add/Revise/Relist/Verify calls), it can still be used, but it will have no functional affect. However, if set in an Add/Revise/Relist/Verify call, it will get returned in GetItem, but it won't be a true indicator if the item is available for the 'Click and Collect' logistics type. Instead, the Item.AvailableForPickupDropOff field should be referenced to see if the item is available for 'Click and Collect'. |
Item.eMailDeliveryAvailable | boolean | Conditionally | The boolean value that is returned in this field will indicate whether or not a digital gift card can be delivered by email to the buyer or recipient of the gift card. This field is only applicable to digital gift card listings. |
Item .ExtendedProducerResponsibility |
ExtendedProducerResponsibilityType | Conditionally |
This container is used to provide the eco-participation fee for a product. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metadata API to retrieve categories that support eco-participation fee for a specified marketplace." For GetItem calls, this container is only returned to the listing owner, if the container is available. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedProducerResponsibility .EcoParticipationFee |
AmountType (double) | Conditionally |
This is the fee paid for new items to the eco-organization (for example, "eco-organisme" in France). It is a contribution to the financing of the elimination of the item responsibly. For multiple-variation listings, the EcoParticipationFee in the VariationExtendedProducerResponsibility container is used for each variation in the listing, and not the EcoParticipationFee in the ExtendedProducerResponsibility container. Min: 0.0. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedProducerResponsibility .EcoParticipationFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This is the fee paid for new items to the eco-organization (for example, "eco-organisme" in France). It is a contribution to the financing of the elimination of the item responsibly. For multiple-variation listings, the EcoParticipationFee in the VariationExtendedProducerResponsibility container is used for each variation in the listing, and not the EcoParticipationFee in the ExtendedProducerResponsibility container. For a list of possible enumeration values, see CurrencyCodeType. |
Item .ExtendedSellerContactDetails |
ExtendedContactDetailsType | Conditionally |
Extended contact information for sellers using the Classified Ad format. Specifies the days and hours when the seller can be contacted. To remove seller contact information when revising or relisting an item, use DeletedField.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ClassifiedAdContactByEmailEnabled |
boolean | Conditionally |
A value of true in this field indicates that potential buyers can contact the seller of the Classified Ad listing by email.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails |
ContactHoursDetailsType | Conditionally |
This containers consists of fields that allows the seller of a Classified Ad listing to tell potential buyers what days and times they may be contacted to inquire about the listing.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours1AnyTime |
boolean | Conditionally |
Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours1Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours1From and Hours1To will be ignored. In the case of this field being false, the values provided Hours1From and Hours1To will be considered.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours1Days |
DaysCodeType | Conditionally |
Indicates the range of days for which the primary contact hours specified by Hours1AnyTime or Hours1From and Hours1To apply. If a value of None is provided for this field, the values provided for Hours1AnyTime, Hours1From, Hours1To are ignored.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours1From |
time | Conditionally |
Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails.Hours1To |
time | Conditionally |
Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours2AnyTime |
boolean | Conditionally |
Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours2Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours2From and Hours2To will be ignored. In the case of this field being false, the values provided Hours2From and Hours2To will be considered.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours2Days |
DaysCodeType | Conditionally |
Indicates the range of days for which the secondary contact hours specified by Hours2AnyTime or Hours2From and Hours2To apply. If a value of None is provided for this field, the values provided for Hours2AnyTime, Hours2From, Hours2To are ignored. Note: You cannot set Hours2Days to EveryDay. If Hours1Days is set to EveryDay, secondary contact hours do not apply. Hours2Days cannot be set to the same value as Hours1Days. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours2From |
time | Conditionally |
Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours2Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails.Hours2To |
time | Conditionally |
Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item .ExtendedSellerContactDetails .ContactHoursDetails .TimeZoneID |
string | Conditionally |
Indicates the local time zone of the values provided for Hours1From/Hours1To and Hours2From/Hours2To. If you specify a contact hours time range with Hours1From and Hours1To, you must provide a local time zone. To retrieve a complete list of the TimeZoneID values supported by eBay, call GeteBayDetails with DetailName set to TimeZoneDetails.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.FreeAddedCategory | CategoryType | Conditionally |
The unique identifier for a secondary category that eBay has added as a free promotion. You cannot add this yourself. This container is only returned if the item was listed in a single category and eBay added a free secondary category.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.FreeAddedCategory .CategoryID |
string | Conditionally |
This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories. Note: When listing in categoryID 173651 (Auto Performance Tuning Devices & Software), use of catalog products is required. For more information, see Tuning devices and software. In an Add call, the PrimaryCategory.CategoryID is conditionally required unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing. In an Add/Revise/Relist call, the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used. Using a Secondary Category can incur a listing fee. For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field. Max length: 10. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.FreeAddedCategory .CategoryName |
string | Conditionally |
This string value is the display name of the eBay primary category, as it would appear on the eBay site. In GetItem, this will be a fully-qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.HideFromSearch | boolean | Conditionally |
This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
|
Item.IgnoreQuantity | boolean | Conditionally |
This boolean field is returned as true if the actual quantity of a multiple-quantity, fixed-price listing (indicated in the Item.Quantity field) can not be accurately determined by eBay.
|
Item .IntegratedMerchantCreditCardEnabled |
boolean | Conditionally |
This field is no longer applicable as eBay sellers can no longer use iMCC gateway accounts to handle buyer payments. Note: This field will stop being returned in order management calls on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.InventoryTrackingMethod | InventoryTrackingMethodCodeType | Conditionally |
Indicates whether you prefer to track your eBay listings by eBay Item ID or by your own SKU. If a seller will be converting an existing eBay listing into the new Inventory model using the bulkMigrateListings call of the Inventory API, the InventoryTrackingMethod value must be set to ItemID (default value), but the item must also have a SKU value (Item.SKU or Variation.SKU) associated with it. For GetItem and related calls: Only returned when the value is SKU ; not returned when the value is ItemID . Applicable values: When you track by SKU, it means you can pass in your SKU instead of the eBay item ID in other calls that support SKU as an input field. If you choose SKU as your tracking preference for a listing, the value in Item.SKU must be unique across your active listings. You cannot create new listings with the same Item.SKU value while the listing is active (that is, until the existing listing with that SKU has ended). However, you can use ReviseInventoryStatus to update the quantity and/or price for the existing SKU as needed. When revising a listing where the InventoryTrackingMethod was set to SKU, you must pass in both the InventoryTrackingMethod tag (with the value set to SKU) and the SKU tag with the SKU value from your original listing. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
Item .IsIntermediatedShippingEligible |
boolean | Conditionally |
This boolean field is returned as true if the item is eligible is to be shipped internationally via eBay's Global Shipping Program. With the Global Shipping Program, the buyer pays a single shipping fee for the order, which includes the domestic shipping leg, the international shipping leg, and handling charges, and import charges. eBay uses a shipping partner that allows the seller to ship the package to a domestic location and then the shipping partner takes care of the rest, including the international shipping leg. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.IsItemEMSEligible | boolean | Always |
If true , the item is eligible for shipping managed by eBay; false , the item is not eligible for shipping managed by eBay.
DetailLevel: ItemReturnAttributes, ItemReturnCategories, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.IsSecureDescription | boolean | Conditionally |
This boolean field indicates whether or not the listing description is HTTPS secure/compliant. To be HTTPS secure/compliant, the Item.Description field may not contain any links to site pages that use the HTTP (and not HTTPS) protocol. This field will be returned with each listing that is found unless one or more OutputSelector fields are used and Item.IsSecureDescription is not one of the values passed in to one of these fields. If this field is returned as true , the listing is HTTPs secure/compliant, and the whole listing description will appear on the View Item page for the listing. If this field is returned as false , the listing is not HTTPs secure/compliant, and only a partial/brief listing description will appear on the View Item page for the listing, with a link to the full listing description that will load in another tab. If the listing description is not HTTPS compliant, the fix is to call ReviseItem or ReviseFixedPriceItem and update the Item.Description field, removing all links to HTTP pages. For more information about why eBay made this change, please see the Policy Updates page of the Fall 2017 Seller Updates page. |
Item.ItemCompatibilityCount | int | Conditionally |
Indicates the number of compatible applications specified for the given item. Applies to items listed with fitment by application only (either manually or with a catalog product that supports compatibility). Not returned if the item has no specified compatible applications. Not returned if IncludeItemCompatibilityList is specified in the request. To retrieve the list of compatibility information, set IncludeItemCompatibilityList to true in the request. Parts Compatibility is supported in limited Parts & Accessories categories for the eBay Motors (US) site (site ID 100) only. |
Item.ItemCompatibilityList | ItemCompatibilityListType | Conditionally |
A list of parts compatibility information specified as name and value pairs. Describes an assembly with which a part is compatible (i.e., compatibility by application). For example, to specify a part's compatibility with a vehicle, the name (search name) would map to standard vehicle characteristics (e.g., Year, Make, Model, Trim, and Engine). The values would describe the specific vehicle, such as a 2006 Honda Accord. Use the Product Metadata API to retrieve valid search names and corresponding values. For the AddItem family of calls: Use this for specifying parts compatibility by application manually. This can only be used in categories that support parts compatibility by application. Use GetCategoryFeatures with the CompatibilityEnabled feature ID to determine which categories support parts compatibility by application. For ReviseFixedPriceItem and ReviseItem: When you revise a listing, if the listing has bids and/or ends within 12 hours, item compatibilities cannot be deleted. You may add item compatibilities at any time. For GetItem: ItemCompatibilityList is only returned if the seller included item compatibility in the listing and IncludeItemCompatibilityList is set to true in the GetItem request. |
Item.ItemCompatibilityList .Compatibility |
ItemCompatibilityType | Conditionally,
repeatable: [0..*] |
Details for an individual compatible application, consisting of the name-value pair and related parts compatibility notes. When revising or relisting, the Delete field can be used to delete individual parts compatibility nodes. Note: For the GetItem call, Compatibility includes only parts compatibility details that were specified manually; that is, they do not correspond to an eBay catalog product. To retrieve parts compatibility details that do correspond to eBay catalog products, use the eBay Product API's getProductCompatibilities call. See Product API ProductCompatibilities call reference for information about retrieving parts compatibility details that correspond to eBay catalog products.. |
Item.ItemCompatibilityList .Compatibility .CompatibilityNotes |
string | Conditionally | The seller may optionally enter any notes pertaining to the parts compatibility being specified. Use this field to specify the placement of the part on a vehicle or the type of vehicle a part fits. |
Item.ItemCompatibilityList .Compatibility.NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
A name-value pair describing a single compatible application. The allowed names and values are specific to the primary category in which the item is listed. For example, when listing in a Parts & Accessories category, where the applications are vehicles, the allowed names might include Year, Make, and Model, and the values would correspond to specific vehicles in eBay's catalog. For details and examples, see Specify parts compatibility manually. The eBay Germany, UK, France, Italy, Spain, and Australia sites support the use of K type vehicle numbers to specify vehicle parts compatibility. To use a K type number, set the Name field to " KType " and set the corresponding Value field to the appropriate K type number. The DE and UK eBay sites also support the use of an eBay Product ID (or ePID) number/value pair to specify motorcycle and scooter parts compatibility (currently, only DE supports scooter parts compatibily). To use an ePID number to specify part compatibilities, set the Name field to " ePID " and the corresponding Value field to the ePID number that matches the motorcycle for the part(s) you are listing. Motorcycle ePID numbers are provided by the Master Motorcycle List (MML) file, which contains the ePID numbers and their associated vehicle mappings). For motorcycles, an ePID number contains the vehicle make, model, CCM, year, and submodel data. Please use the following links to obtain the DE and UK MML data files: - DE seller help page: http://verkaeuferportal.ebay.de/fahrzeugteile-und-zubehoer-optimal-einstellen - UK seller help page: http://pages.ebay.co.uk/help/sell/contextual/master-motorcycle-list-manually.html |
Item.ItemCompatibilityList .Compatibility.NameValueList .Name |
string | Conditionally |
Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name. For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing. Max length: 65. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ItemCompatibilityList .Compatibility.NameValueList .Source |
ItemSpecificSourceCodeType | Conditionally |
This enumerated value indicates whether the Item Specific was manually input or selected during listing/revision/re-listing time, or if the Item Specific name-value pair came from an eBay catalog product that the listing is associated with.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ItemCompatibilityList .Compatibility.NameValueList .Value |
string | Conditionally,
repeatable: [0..*] |
Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI . If an item specific only supports a single value, only the first item specific value specified in the request will be used. For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description. Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning'). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ItemID | ItemIDType (string) | Always |
The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. Your code should be prepared to handle IDs of up to 19 digits. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ItemPolicyViolation | ItemPolicyViolationType | Conditionally | Specifies the details of policy violations if the item was administratively canceled. |
Item.ItemPolicyViolation .PolicyID |
long | Conditionally |
Policy ID of the violated policy which resulted in item being administratively canceled.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ItemPolicyViolation .PolicyText |
string | Conditionally |
Brief information of the violated policy which resulted in item being administratively canceled.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ItemSpecifics | NameValueListArrayType | Conditionally |
This container is a list of Item Specific Name/Value pairs used by the seller to provide desciptive details of an item in a structured manner. If creating, revising, or relisting an item with an Add, Revise, or Relist call, it is recommended that you use the getItemAspectsForCategory method of the Taxonomy API to retrieve mandatory and recommended Item Specifics for a category. For ReviseItem only: When you revise a listing, if an auction listing has one or more bids and ends within 12 hours, you cannot change or add Item Ppecifics. If the auction listing has bids but ends in more than 12 hours, you cannot change existing Item Specifics, but you can add Item Specifics that were not previously included. If your listing is in a eBay product catalog-enabled category, certain Name/Value pairs will be accepted as product identifying information. The Name can be Brand , MPN , or a Global Trade Item Number (GTIN). GTINs are a set of globally recognized identifiers, including EAN , ISBN , and UPC . However, the Values provided for these Names must comply with eBay's constraints or they will not be recognized as product identifiers. The Value for Brand must be an actual brand name (except that if the item is not branded, Value can be Unbranded .) The Value for Brand or MPN cannot contain only special characters (e.g. %$*#@ ). All GTINs must comply with international formatting standards. For more details, see Item Specifics. If the ProductListingDetails container in an Add/Revise/Relist call is successfully used to find and use an eBay catalog product to create/revise listing, the seller should not remove or change the value of any Item Specific name or value that is defined as part of the eBay catalog product definition. Note: If a listing is associated with an eBay catalog product, the seller does not need to pass in any Item Specifics that are already defined in the eBay catalog product. Sellers can make a call to the getItemAspectsForCategory method of the Taxonomy API to see if the category supports any 'instance aspects', which can be thought of as Item Specifics that are unique to the specific item that is being listed. Instance aspects are indicated if the corresponding aspectApplicableTo field of the getItemAspectsForCategory response shows a value of ITEM (and not PRODUCT ). Many categories support the following instance aspects: Custom Bundle, Bundle Description, Modified Item, Modification Description, and California Prop 65 Warning. These instance aspects allow the seller to provide more information about product bundles or modified products in a structured way. Depending on the category, there are other instance aspects as well. Note: To specify an item's condition, use the ConditionID field instead of a condition Item Specific. Use GetCategoryFeatures to see which categories support ConditionID and to get a list of valid condition IDs. (If you specify ConditionID and you also specify Condition as a Item Specific, eBay drops the condition Item Specific.) For GetItem: This list is returned only when you specify IncludeItemSpecifics in the request (and the seller included Item Specifics in their listing). To delete all Item Specifics when you revise or relist, specify Item.ItemSpecifics in DeletedField, and don't pass ItemSpecifics in the request. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Item Specifics. |
Item.ItemSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
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 variations, 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:
For PlaceOffer: Required if the item being purchased includes Item Variations. For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required. Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ItemSpecifics .NameValueList.Name |
string | Conditionally |
Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name. For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing. Max length: 65. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ItemSpecifics .NameValueList.Source |
ItemSpecificSourceCodeType | Conditionally |
This enumerated value indicates whether the Item Specific was manually input or selected during listing/revision/re-listing time, or if the Item Specific name-value pair came from an eBay catalog product that the listing is associated with.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ItemSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI . If an item specific only supports a single value, only the first item specific value specified in the request will be used. For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description. Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning'). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails | ListingDetailsType | Always |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails.Adult | boolean | Always |
If true , the item is listed in a Mature category. Users must accept the Mature Category agreement on the eBay site to retrieve items listed in Mature categories. (Users do not need to sign this agreement to be able to list items in Mature Categories.) Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .BestOfferAutoAcceptPrice |
AmountType (double) | Conditionally |
The price at which Best Offers are automatically accepted. Similar in use to MinimumBestOfferPrice. If a buyer submits a Best Offer that is at or above this value, the offer is automatically accepted by the seller. This applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature. For this setting to have an effect, the Best Offer feature must be enabled for the listing, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response. For Revise and Relist calls: If a seller wanted to disable the Best Offer Auto-Accept and/or Best Offer Auto-Reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a DeletedField tag, like the following:
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .BestOfferAutoAcceptPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The price at which Best Offers are automatically accepted. Similar in use to MinimumBestOfferPrice. If a buyer submits a Best Offer that is at or above this value, the offer is automatically accepted by the seller. This applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature. For this setting to have an effect, the Best Offer feature must be enabled for the listing, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response. For Revise and Relist calls: If a seller wanted to disable the Best Offer Auto-Accept and/or Best Offer Auto-Reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a DeletedField tag, like the following:
For a list of possible enumeration values, see CurrencyCodeType. |
Item.ListingDetails .BindingAuction |
boolean | Always |
Applicable for Real Estate auctions only. If true , buyers and sellers are expected to follow through on the sale. If false, bids for the Real Estate auction are only expressions of interest. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .BuyItNowAvailable |
boolean | Conditionally |
Indicates whether the Buy It Now feature is available for an auction listing. As a general rule, once an auction listing has bids (and the high bid exceeds the reserve price, if any), the Buy It Now feature becomes disabled for the listing.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .CheckoutEnabled |
boolean | Always |
Indicates whether or not the seller's Checkout Enabled preference is turned on. Note: A 'Checkout Enabled' setting is no longer available to sellers, and this field is always returned as true . Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Always |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. Note: The ListingDetails.ConvertedBuyItNowPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. Note: The ListingDetails.ConvertedBuyItNowPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to fixed-price listings. Note: The ListingDetails.ConvertedReservePrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to fixed-price listings. Note: The ListingDetails.ConvertedReservePrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ListingDetails .ConvertedStartPrice |
AmountType (double) | Always |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. Note: The ListingDetails.ConvertedStartPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. Note: The ListingDetails.ConvertedStartPrice field will stop being returned in GetItemTransactions, GetSellerTransactions, and GetMyeBaySelling (SoldList and DeletedFromSoldList) on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ListingDetails .EndingReason |
EndReasonCodeType | Conditionally |
This field is only returned if the item was ended early (before listing duration expired) by the seller (through an API call or on the Web site) or ended administratively by eBay. The value in this field indicates the seller's reason for ending the listing early.
Applicable values: See EndingReason. Code so that your app gracefully handles any future changes to this list. |
Item.ListingDetails.EndTime | dateTime | Always |
Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration ) or the actual end time if the item has ended.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .HasPublicMessages |
boolean | Always |
Indicates whether the item has any publicly displayed messages. Use GetMemberMessages to retrieve public messages for the item if this flag indicates that there are any. Note: The HasPublicMessages field will stop being returned in GetItemTransactions and GetSellerTransactions, on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .HasReservePrice |
boolean | Always |
If true , the seller specified a value in ReservePrice. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .HasUnansweredQuestions |
boolean | Always |
Indicates whether the item has any unanswered questions. Use GetMemberMessages to retrieve unanswered questions for the item if this flag indicates that there are any.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .MinimumBestOfferPrice |
AmountType (double) | Conditionally |
Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined. This applies only to items listed in categories that support the Best Offer auto-decline feature. In order for this setting to have an effect, Best Offer must be enabled for the listing, and this value will only be exposed to the seller who listed the item. For Revise and Relist calls: If a seller wanted to disable the Best Offer auto-accept and/or Best Offer auto-reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a DeletedField tag, like the following: Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .MinimumBestOfferPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined. This applies only to items listed in categories that support the Best Offer auto-decline feature. In order for this setting to have an effect, Best Offer must be enabled for the listing, and this value will only be exposed to the seller who listed the item. For Revise and Relist calls: If a seller wanted to disable the Best Offer auto-accept and/or Best Offer auto-reject feature when revising or relisting an item, the full path to one or both of these two corresponding fields would be provided in a DeletedField tag, like the following: Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ListingDetails .RelistedItemID |
ItemIDType (string) | Conditionally |
Indicates the new item ID for a re-listed item. When an item is re-listed, the item ID for the new item is added to the old listing, so buyers can navigate to the new listing. This value only appears when the old listing is retrieved. The RelistedItemID of the original item will reflect the last relist. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .SecondChanceOriginalItemID |
ItemIDType (string) | Conditionally |
The item ID for the original listing from which a second chance offer is made. This value is only returned when the data for the second chance offer listing is retrieved. Output only.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails.StartTime | dateTime | Always | The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. |
Item.ListingDetails .ViewItemURL |
anyURI | Always |
The URL of the Web page where a user can view the listing. On the US site, this is called the View Item page. If you enabled affiliate tracking in a search-related call (for example, if you used the AffiliateTrackingDetails container in an applicable call), ViewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network). Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDetails .ViewItemURLForNaturalSearch |
anyURI | Conditionally |
This URL takes you to the same View Item page as ViewItemURL, but this URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines. The URL includes the item title along with other optimizations. To note, "?" (question mark) optimizes to "_W0QQ", "&" (ampersand) optimizes to "QQ", and "=" (equals sign) optimizes to "Z". If you are an eBay affiliate, use this URL to promote your affiliate information. Note: This URL may include additional query parameters that don't appear in ViewItemURL and vice versa. You should not modify the query syntax. For example, eBay won't recognize the URL if you change QQ to ?. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingDuration | token | Conditionally |
Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time. The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable). The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information. When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours. Note: As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
GTC is specified in this field, it will be ignored, and GTC will be used instead.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ListingDurationCodeType |
Item.ListingEnhancement | ListingEnhancementsCodeType | Conditionally,
repeatable: [0..*] |
Describes listing upgrades that sellers can select for a fee, such as the BoldTitle upgrade. You can add a listing upgrade when you revise a listing, but you cannot remove a listing upgrade. When you relist an item, use DeletedField to remove a listing upgrade. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ListingSubtype2 | ListingSubtypeCodeType | Conditionally |
Indicates a specific type of lead generation format listing, such as classified ad or local market best offer listing. Only applicable when ListingType = LeadGeneration. Note: ListingSubtype2 replaces the deprecated ListingSubtype field. If both are specified in a request, ListingSubtype2 takes precedence. Applicable values: AdFormatEnabled ) to see which categories support classified ad listings.100 and the FeatureID value set to LocalMarketAdFormatEnabled ) to see which eBay Motors categories support Motors Local Market listings.Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
Item.ListingType | ListingTypeCodeType | Always |
The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value). If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem , since these calls only work with fixed-price listings. This field is not applicable to Revise calls because the selling format of active listings cannot be changed. Applicable values: See ListingType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Listing types. |
Item.Location | string | Always |
Indicates the geographical location of the item (along with the value in the Country field). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. If you do not specify Location, you must specify Item.PostalCode. If you specify a postal code, but do not specify a location, then the location is given a default value derived from the postal code. For the Classified Ad format for motors vehicle listings, the value provided in the Location field is used as item location only if the SellerContactDetails.Street and the SellerContactDetails.Street2 are empty. Else, the SellerContactDetails.Street and the SellerContactDetails.Street2 will be used for item location. Max length: 45. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.LocationDefaulted | boolean | Conditionally |
If true , eBay provided a central location as a result of the user not specifying a location. This typically occurs when the seller specifies PostalCode without Location.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.LotSize | int | Conditionally |
A lot is a set of two or more similar items included in a single listing that must be purchased together in a single order line item. The Item.LotSize value is the number of items in the lot. This field is required if two or more items are including in one listing. Lots can be used for auction and fixed-price listings. Lot items can be listed only in lot-enabled categories. Call GetCategories to determine if a category supports lots. If the returned CategoryArray.Category.LSD (LotSize Disabled) value is true , the category does not support lots. Max: 450,000. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.MechanicalCheckAccepted | boolean | Conditionally |
Indicates whether the seller allows the bidder to request mechanical inspection services from RAC. For the Car category listings on the UK site. Default: false. |
Item.PaymentAllowedSite | SiteCodeType | Always,
repeatable: [1..*] |
Enables you to view the sites on which an item can be purchased, based on the payment methods offered for the item.
Applicable values: See PaymentAllowedSite. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PaymentDetails | PaymentDetailsType | Conditionally |
This container is used in an Add/Revise/Relist/Verify call if the seller is selling a motor vehicle. It is used by the seller to specify the amount of the initial deposit, and the due dates for the deposit and the full payment for a motor vehicle listing. Note: If you are using business policies with your listing, the details set up in this container will instead be set up via the payment business policy. Payment business policies are associated with the listing via the SellerProfiles.SellerPaymentProfile container. This container will only be returned in 'Get' calls for motor vehicle listings where an initial deposit is required for that vehicle. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PaymentDetails .DaysToFullPayment |
int | Conditionally |
This field is used to set the due date (in days) for the buyer to pay off the full balance of the motor vehicle. The "clock starts" on the full payment due date as soon as the buyer commits to buying the vehicle by clicking the Buy It Now button, by winning the auction, or by the seller accepting that buyer's Best Offer/counteroffer. The three supported values here are 3 , 7 (default), 10 , and 14 days. The seller must specify one or more of the following offline payment methods in the listing. The buyer will be expected to use one of these payment method options to pay the full balance of the motor vehicle.
Min: 3. Max: 14. Default: 7. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PaymentDetails .DepositAmount |
AmountType (double) | Conditionally |
This dollar value indicates the amount of the initial deposit on the vehicle required from the buyer. If the immediate payment requirement is set for the listing (see Item.AutoPay description), and the listing qualifies for immediate payment (e.g. the Buy It Now button is used), the deposit will be required immediately, and the HoursToDeposit field (if set) will not be applicable. If immediate payment is required for a motor vehicle deposit, the value input into this field cannot exceed '500.0', or an error will occur. If there is no immediate payment requirement set for the listing the deposit will be required in 24, 48, or 72 hours after commitment to purchase (see the HoursToDeposit field). If immediate payment is not required for a motor vehicle deposit, the value input into this field cannot exceed '2000.0', or an error will occur. If this field is not included in an Add/Revise call, its value defaults to '0.0', which would technically mean that a deposit is not required, even if the DepositType and HoursToDeposit fields were included. Motor vehicle deposit details will be shown to prospective buyers in the listing. The available payment methods for the deposit will be shown on the checkout page once the buyer clicks the the Buy It Now button. For ReviseItem and related calls: If the listing has no bids, the seller can add or lower a deposit; and they can increase the deposit if the listing doesn't require immediate payment. The seller can also remove the immediate payment option (if any). If the listing has bids, the seller can only lower an existing deposit; but not add or increase a deposit. The seller can't remove immediate payment when a listing with a deposit has bids. Max: 500.0 (if immediate payment required); 2000.0 (if immediate payment not required). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PaymentDetails .DepositAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This dollar value indicates the amount of the initial deposit on the vehicle required from the buyer. If the immediate payment requirement is set for the listing (see Item.AutoPay description), and the listing qualifies for immediate payment (e.g. the Buy It Now button is used), the deposit will be required immediately, and the HoursToDeposit field (if set) will not be applicable. If immediate payment is required for a motor vehicle deposit, the value input into this field cannot exceed '500.0', or an error will occur. If there is no immediate payment requirement set for the listing the deposit will be required in 24, 48, or 72 hours after commitment to purchase (see the HoursToDeposit field). If immediate payment is not required for a motor vehicle deposit, the value input into this field cannot exceed '2000.0', or an error will occur. If this field is not included in an Add/Revise call, its value defaults to '0.0', which would technically mean that a deposit is not required, even if the DepositType and HoursToDeposit fields were included. Motor vehicle deposit details will be shown to prospective buyers in the listing. The available payment methods for the deposit will be shown on the checkout page once the buyer clicks the the Buy It Now button. For ReviseItem and related calls: If the listing has no bids, the seller can add or lower a deposit; and they can increase the deposit if the listing doesn't require immediate payment. The seller can also remove the immediate payment option (if any). If the listing has bids, the seller can only lower an existing deposit; but not add or increase a deposit. The seller can't remove immediate payment when a listing with a deposit has bids. For a list of possible enumeration values, see CurrencyCodeType. |
Item.PaymentDetails .DepositType |
DepositTypeCodeType | Conditionally |
In order for a seller to require a motor vehicle deposit from a buyer, this field must be included and set to OtherMethod . Otherwise, the field will default to None and a deposit will not be required.Default: None. Applicable values: This value should be used in an Add/Revise call if the seller is requiring a deposit for a motor vehicle listing. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PaymentDetails .HoursToDeposit |
int | Conditionally |
This field is used to set the due date (in hours) for the motor vehicle deposit. The deposit amount is specified in the DepositAmount field. The "clock starts" on the deposit due date as soon as the buyer commits to buying the vehicle by clicking the Buy It Now button, by winning the auction, or by the seller accepting that buyer's Best Offer/counteroffer. The three supported values here are 24 , 48 (default), and 72 hours. Note: If the immediate payment requirement is set for the listing (see Item.AutoPay description), and the listing qualifies for immediate payment (e.g. the Buy It Now button is used), the HoursToDeposit field will not be applicable, since the buyer will be required to pay any deposit amount immediately (and not within 1, 2 or 3 days). Min: 24 (hours). Max: 72 (hours). Default: 48 (hours). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PaymentMethods | BuyerPaymentMethodCodeType | Conditionally,
repeatable: [0..*] |
For Add/Revise/Relist calls: A PaymentMethods field is required for each offline payment method supported by the seller for the listing. Note: Sellers no longer have to specify any electronic payment methods for listings, so one or more PaymentMethods fields will only be needed for listings that require/support payments off of eBay's platform. If an electronic payment is supplied in a PaymentMethods field, a warning will be triggered and the payment method will be dropped. Note: If you are already referencing a payments business policy in an Add/Revise/Relist call with the SellerProfiles.SellerPaymentProfile container, no PaymentMethods fields will be needed, as these settings will already be set in the payments business policy. Payment methods are not applicable to any classified ad listings, as any agreement and payment is handled off of the eBay platform. For Get calls that return PaymentMethods fields : One or more PaymentMethods fields will only be returned if the seller set one or more offline payment methods for the listing. Note: This field will stop being returned in order management calls on January 31, 2024. Applicable values: (Not all values in BuyerPaymentMethodCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PayPalEmailAddress | string | Conditionally |
This field is no longer applicable, and should not be used.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PickupInStoreDetails | PickupInStoreDetailsType | Conditionally |
This container is used in Add/Revise/Relist/Verify listing calls by the seller to enable a listing with the 'In-Store Pickup' feature. The 'In-Store Pickup' feature is only available to a limited number of large retail merchants in the US, Canada, UK, Germany, and Australia marketplaces. This container is returned in the 'Get' calls if the listing is enabled with the In-Store Pickup feature. |
Item.PickupInStoreDetails .EligibleForPickupDropOff |
boolean | Conditionally |
For sellers opted in to Click and Collect, this field was once used to set Click and Collect eligibility at the listing level. However, now the seller can only opt in to Click and Collect at the account level, and then each of their listings will be automatically evaluated by eBay for Click and Collect eligibility. Note: Until this field is fully deprecated in the Trading WSDL (and in Add/Revise/Relist/Verify calls), it can still be used, but it will have no functional affect. However, if set in an Add/Revise/Relist/Verify call, it will get returned in GetItem, but it won't be a true indicator if the item is actually available for the Click and Collect fulfillment method. Instead, the Item.AvailableForPickupDropOff field should be referenced to see if the listing actually has inventory that is available for pickup via the Click and Collect fulfillment method. |
Item.PickupInStoreDetails .EligibleForPickupInStore |
boolean | Conditionally |
For Add/Revise/Relist/Verify calls: this field is included to enable the listing for In-Store Pickup. To enable the listing for In-Store Pickup, the seller includes this boolean field and sets its value to true . In-Store Pickup as a fulfillment method is only available to a limited number of large retail merchants in the US, Canada, UK, Germany, and Australia marketplaces. The In-Store Pickup feature can only be applied to multiple-quantity, fixed-price listings. In addition to setting the EligibleForPickupInStore boolean field to true , the merchant must also perform the following actions in an Add/Revise/Relist/Verify call to enable the In-Store Pickup option on a multiple-quantity, fixed-price listing:
This field is returned in the 'Get' calls if the listing is enabled with the In-Store Pickup feature. |
Item.PictureDetails | PictureDetailsType | Conditionally |
This container consists of the data associated with photos within the listing. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. It is required that all listings have at least one picture. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PictureDetails .ExtendedPictureDetails |
ExtendedPictureDetailsType | Conditionally |
Deprecated as of version 1375. No longer returned. Use PictureDetails.ExternalPictureURL instead. The ExtendedPictureDetails container and its child fields are no longer returned under any circumstances, including when self-hosted pictures are used for the item. When self-hosted pictures are used by the seller, only the external URL of the gallery image is shown in the PictureDetails.ExternalPictureURL field, and only the equivalent eBay Picture Server (EPS) URLs are shown for the rest of the item's images in separate PictureDetails.PictureURL fields. Deprecation version: 1375. See also Deprecated Objects. |
Item.PictureDetails .ExtendedPictureDetails .PictureURLs |
PictureURLsType | Conditionally,
repeatable: [0..*] |
Deprecated as of version 1375. No longer returned. Use PictureDetails.ExternalPictureURL instead. The ExtendedPictureDetails container and its child fields are no longer returned under any circumstances, including when self-hosted pictures are used for the item. When self-hosted pictures are used by the seller, only the external URL of the gallery image is shown in the PictureDetails.ExternalPictureURL field, and only the equivalent eBay Picture Server (EPS) URLs are shown for the rest of the item's images in separate PictureDetails.PictureURL fields. Deprecation version: 1375. See also Deprecated Objects. |
Item.PictureDetails .ExtendedPictureDetails .PictureURLs.eBayPictureURL |
anyURI | Conditionally,
repeatable: [0..24] |
Deprecated as of version 1375. The ExtendedPictureDetails container and its child fields are no longer returned under any circumstances, including when self-hosted pictures are used for the item. When self-hosted pictures are used by the seller, only the external URL of the gallery image is shown in the PictureDetails.ExternalPictureURL field, and only the equivalent eBay Picture Server (EPS) URLs are shown for the rest of the item's images in separate PictureDetails.PictureURL fields. Max length: 150. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1375. See also Deprecated Objects. |
Item.PictureDetails .ExtendedPictureDetails .PictureURLs .ExternalPictureURL |
anyURI | Conditionally |
Deprecated as of version 1375. The ExtendedPictureDetails container and its child fields are no longer returned under any circumstances, including when self-hosted pictures are used for the item. When self-hosted pictures are used by the seller, only the external URL of the gallery image is shown in the PictureDetails.ExternalPictureURL field, and only the equivalent eBay Picture Server (EPS) URLs are shown for the rest of the item's images in separate PictureDetails.PictureURL fields. Max length: 150. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1375. See also Deprecated Objects. |
Item.PictureDetails .ExternalPictureURL |
anyURI | Conditionally |
When returned this contains the original URL of a self-hosted pictures, associated with the item when the item was listed. Max length: 500. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Picture hosting. |
Item.PictureDetails .GalleryErrorInfo |
string | Conditionally |
Indicates the reason the gallery generation failed, such as, URL for the image is not valid. This field is returned when GalleryStatus field is returned and does not appear when the gallery generation is successful. Max length: 1024. |
Item.PictureDetails .GalleryStatus |
GalleryStatusCodeType | Conditionally |
Indicates if the gallery image upload failed and gives a reason for the failure, such as 'InvalidUrl' or 'ServerDown'. It is not returned if the gallery image is uploaded successfully.
Applicable values: See GalleryStatus. Code so that your app gracefully handles any future changes to this list. |
Item.PictureDetails .GalleryType |
GalleryTypeCodeType | Conditionally |
This field is used to specify the type of picture gallery to use for the listing. If this field is omitted, a standard picture gallery is used for the listing. There is no listing fee for a standard picture gallery. To use the Gallery Plus feature, you must include this field and set its value to Plus . The Gallery image will be the first URL passed into the first PictureURL field, so if you want a specific picture to be the Gallery image, you should make sure you pass the URL for this picture in the first PictureURL field. When revising a listing, if you disable the Gallery Plus feature by including the GalleryType field and setting its value to Gallery , the original feature fee for this feature will not be credited to the seller. Applicable values: All images must comply to the Picture Requirements. When Plus is selected in a request that specifies at least two images (using ItemType.PictureDetailsType.PictureURL), the Gallery Plus feature automatically includes a Gallery Showcase of all the listing's images. The Gallery Showcase displays when hovering over or clicking on the listing's Gallery Plus icon in the search results. The Showcase window displays a large (400px x 400px) preview image which is first image specified PictureURL, as well as up to 11 (64 px x 64 px) selectable thumbnails for the remaining EPS images. Clicking on the preview image displays the item's listing page. If Plus is selected and the request includes only one EPS image or any self-hosted images, the listing includes a Gallery Plus icon that, when hovered over or clicked, displays a large (400px x 400px) preview image of the item. Clicking the image displays the View Item page for that listing. When using RelistItem or ReviseItem (item has no bids and more than 12 hours before the listing's end), Plus can be unselected in the request. However, the Plus fee will still apply if a previous request selected Plus. There is at most one Plus fee per listing. When "Plus" is included in an item listing, the listing also automatically gets the Gallery functionality at no extra cost. "Gallery" does not need to be specified separately in the listing. Listing images that are originally smaller than 400px x 400px are centered in the preview frame. Images that are originally larger than 400px x 400px are scaled down to 400px on their longest side (maintaining their original aspect ratio). Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PictureDetails .PictureSource |
PictureSourceCodeType | Conditionally |
The value in this field indicates if the listing contains image files uploaded to the eBay Picture Server (EPS), or externally-hosted images for which eBay created EPS equivalents. This value defaults to EPS , so if a seller is going to upload externally-hosted image URLs, this field must be included and set to Vendor . Note: Original EPS and externally-hosted images cannot be mixed, so this value cannot be changed if a listing already has one or more images. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.PictureDetails.PictureURL | anyURI | Conditionally,
repeatable: [0..24] |
Contains the URL for a picture of the item. The URL can be from the eBay Picture Services (images previously uploaded) or from a server outside of eBay (self-hosted). You can pass in up to 24 picture URLs for each listing, but you cannot mix self-hosted and EPS-hosted URLs in the same listing. The UploadSiteHostedPictures call can be used to upload pictures to EPS. Note that if pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. URLs using the 'http' protocol will not be allowed. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). Note: If a URL contains spaces, those spaces can be replaced with %20 . For example, https://example.com/my image.jpg must be submitted as https://example.com/my%20image.jpg to replace the space in the image file name. However, a semicolon character (;) cannot be replaced with %20 , so a semicolon cannot be a part of the URL, as an error will occur. The Gallery image will be the first PictureURL in the array of PictureURL fields. Note: All images, whether they are hosted by EPS or self-hosted, must comply with eBay picture requirements, including the requirement that all images must be at least 500 pixels on its longest side. If the image does not satisfy the 500 pixels requirement, the listing may be blocked. For more information about other requirements and tips for adding pictures to listings, see the Adding pictures to your listings help page. To specify multiple pictures, send each URL in a separate, PictureDetails.PictureURL element. The first URL passed in defaults to be the 'gallery image', and will be the first picture that is shown when a user lands on the View Item page. If a listing uses a single, self-hosted picture (except in the case of a multiple-variation listing), the picture will be copied to eBay Picture Services (EPS) and the PictureDetails.PictureURL value returned by GetItem will be an EPS URL. For VerifyAddItem only: You must include a picture even when using VerifyAddItem. If you don't have a image file, you can use the following fake eBay Picture Services URL (https://i2.ebayimg.com/abc/M28/dummy.jpg) with this call. For ReviseItem and RelistItem only: To remove a picture when revising or relisting an item, specify PictureDetails with all the pictures that you want the listing to include. That is, you need to completely replace the original set of URLs with the revised set. You cannot remove all the PictureURL fields from a listing because each listing requires at least one picture. Remember: The 'gallery image' will be the first PictureURL in the array of PictureURL fields. So, if the first image passed in when relisting/revising is different from when the listing was created, the 'gallery image' will be changed. Note: For some large merchants, there are no limitations on when pictures can be added or removed from a fixed-price listing, even when the listing has had transactions or is set to end within 12 hours. Max length: 500. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Add pictures. |
Item.PostalCode | string | Always |
Postal code of the place where the item is located. This value is used for proximity searches. To remove this value when revising or relisting an item, use DeletedField. If you do not specify PostalCode, you must specify Item.Location. If you specify PostalCode, but do not specify Item.Location, then Item.Location is given a default value derived from the postal code. Note: As of late January 2020, the displayed postal code returned in GetItem is now masked to all users except for the seller of the item. Different countries will mask postal/zip codes in slightly different ways, but an example would be 951** .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PrimaryCategory | CategoryType | Always |
This container is used in an Add/Revise/Relist call to set the primary listing category. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, listing category, and stock photo defined in the catalog product is used to create the listing. Once you determine the appropriate eBay category for your product, and want to know which listing features it supports, you can use the GetCategoryFeatures call. To discover required, recommended, and optional Item Specifics for a category, use the getItemAspectsForCategory method of the Taxonomy API. If you do use an eBay catalog product, it is advised that you do not include this field, as any primary category ID you specify in this field may get dropped if this category is different than the primary category defined in the eBay catalog product. For ReviseItem only: When revising a listing, you can change the primary category only if an auction listing has no bids or a multiple-quantity, fixed-price listing has no sales, and the listing does not end within 12 hours. If you change the listing category, any Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the new category. When you list an event ticket on the US site, you must specify one of the leaf categories under the Tickets & Experiences meta category. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PrimaryCategory .CategoryID |
string | Always |
This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories. Note: When listing in categoryID 173651 (Auto Performance Tuning Devices & Software), use of catalog products is required. For more information, see Tuning devices and software. In an Add call, the PrimaryCategory.CategoryID is conditionally required unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing. In an Add/Revise/Relist call, the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used. Using a Secondary Category can incur a listing fee. For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field. Max length: 10. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PrimaryCategory .CategoryName |
string | Always |
This string value is the display name of the eBay primary category, as it would appear on the eBay site. In GetItem, this will be a fully-qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.PrivateListing | boolean | Always |
A true value in this field indicates that the listing is private. Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users. For ReviseItem/ReviseFixedPriceItem: The seller will not be able change this setting if the listing has any pending bids, any pending best offers, previous sales (for multiple-quantity, fixed-price listing), or if the listing will end within 12 hours. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ProductListingDetails | ProductListingDetailsType | Conditionally |
This container is used to provide one or more product identifiers for a product, and if desired by the seller, eBay will use the identifier(s) of the product to try to match it to a defined product in the eBay catalog. If a seller's product is matched to an eBay catalog product, the product details associated with that catalog product will be prefilled for the listing. Product details defined for a catalog product include the product title, product description, product aspects, and stock image(s) of the product (if available). In some eBay categories, one or more product identifier types (e.g. UPC or ISBN) may be required, but the category may not have any eBay catalog products defined, or the category does not allow listings to be created using a catalog product. Note that the GetCategoryFeatures call can be used to retrieve supported/required product identifier types. Note: If a product identifier type is required, the corresponding field must be used, even if the seller is not interested in finding an eBay catalog product match. A large percentage of eBay US categories require one or more product identifier types when listing an item. See the Structured Data - Product Identifiers help page for more information on which eBay US categories require which product identifier types. If known, an ePID (specified through the ProductReferenceID field) is always the best bet to find an eBay catalog product match, although an EAN, ISBN, UPC, or Brand/MPN pair can also be used in an attempt to find a catalog product match. If a Brand/MPN pair is required for the product, these values must be input through the BrandMPN container. When you use ProductListingDetails, in an Add/Revise/Relist call, you must specify at least one GTIN, a ProductReferenceID (also known as an ePID), or a Brand/MPN pair. If you specify more than one GTIN value, eBay uses the first one that matches a product in eBay's catalog. For ReviseItem and RelistItem only: When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product identifier and you cannot remove existing product listing details 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. DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProductListingDetails .BrandMPN |
BrandMPNType | Conditionally |
This container is used if the seller wants to, or is required to identify a product using an Brand/Manufacturer Part Number (MPN) pair. The seller can use the GetCategoryFeatures call to see if a Brand/MPN pair is supported/required for a category. Both the Brand and MPN fields are required if the category/product requires an MPN value. If the IncludeeBayProductDetails field is omitted or included and set to true , eBay will use the Brand/MPN pair to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the ProductReferenceID field, this field is not needed, as all product identifiers associated with the catalog product will get picked up automatically by the listing if a matching catalog product is found. This container is only applicable for single-variation listings. For multiple-variation listings, if the category requires Brand/MPN pairs, the product brand (shared by all variations in this listing) is passed in through the item-level item specifics (Item.ItemSpecifics.NameValueList), and the MPN value for each variation in the listing is passed in through the variation-level item specifics (Variation.VariationSpecifics.NameValueList). Note: If the listing is being posted to a category that requires or recommends a Brand and MPN value, the Brand and MPN values for the product should always be passed in through separate ItemSpecifics.NameValueList containers since the Brand and MPN values passed in through the ProductListingDetails.BrandMPN will not get picked up by the generated/revised listing unless the the Brand/MPN pair is successfully matched to an eBay catalog product. If an MPN doesn't exist for a product, or the seller does not have it available, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request. DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProductListingDetails .BrandMPN.Brand |
string | Conditionally |
The brand of the product. Both Brand and MPN should be specified if the BrandMPN container is used, or an error may occur. If Brand is a required or recommended item specific for a category, but an MPN is not applicable to the category/product, the Brand value should be specified in an Item.ItemSpecifics.NameValueList container instead. Note: The BrandMPN container is not applicable for multiple-variation listings. For multiple-variation listings that use MPNs, the Brand value should be specified through an ItemSpecifics.NameValueList container, and the Manufacturer Part Numbers (MPNs) for each product variation should be specified through a VariationSpecifics.NameValueList container. Max length: 65. |
Item.ProductListingDetails .BrandMPN.MPN |
string | Conditionally |
The manufacturer part number of the product. Use the value specified by the manufacturer. Both Brand and MPN must be specified if the BrandMPN container is used or an error may occur. If the listing is being posted to a category that expects an MPN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request. Note: The BrandMPN container is not applicable for multiple-variation listings. For multiple-variation listings that use MPNs, the Brand value should be specified through an ItemSpecifics.NameValueList container, and the Manufacturer Part Numbers (MPNs) for each product variation should be specified through a VariationSpecifics.NameValueList container. Max length: 65. |
Item.ProductListingDetails .Copyright |
string | Conditionally,
repeatable: [0..*] |
Copyright statement indicating the source of the product information. This information will be included in the listing if the seller used an eBay catalog product to list the item.
DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProductListingDetails.EAN | string | Conditionally |
This field is used if the seller wants to, or is required to identify a product using an EAN (European Article Number) value. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products. The seller can use the GetCategoryFeatures call to see if an EAN is supported/required for a category. Note: The EAN (and EAN values) are typically only applicable to European products listed on European eBay marketplaces. If a US seller is selling a US-based product (with a UPC value) on a European site (such as eBay UK), instead of using the UPC field, the seller will use the EAN field to pass in the UPC value. If the IncludeeBayProductDetails field is omitted or included and set to true , eBay will use the EAN value passed into this field to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the ProductReferenceID field, this field is not needed, as all product identifiers will get picked up automatically by the listing if a matching catalog product is found. This field is only applicable for single-variation listings. For multiple-variation listings, if the category/product requires an EAN value, this value should be passed into the Variation.VariationProductListingDetails.EAN field instead. Note: If the listing is being posted to a category that expects an EAN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request.
DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProductListingDetails .IncludeeBayProductDetails |
boolean | Conditionally |
This boolean field controls whether or not an eBay catalog product is used to create or revise a listing. If an ePID or GTIN value is provided through the ProductListingDetails container when adding, revising, or relisting an item, the default behavior is for eBay to try and find a match for the product in the eBay catalog, and then automatically create/revise the listing using the product title, product description, item specifics, and stock photo defined for the catalog product. If the seller wants to use an eBay catalog product to create/revise a listing, the seller can include this field and set its value to true , or just omit this field, as its default value is true . If a seller doesn't want use an eBay catalog product to create/revise their listing, this field should be included and set to false . If the seller declines to use an eBay catalog product, they will be required to pass in their own listing title, listing description, item specifics, a listing category, and at least one picture. DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProductListingDetails .IncludeStockPhotoURL |
boolean | Conditionally |
If this value is true , the listing will use the eBay catalog product's stock photo. In an Add/Revise/Relist call, this field is set to true by default. If you will be using an eBay catalog product to list your item, it is always advised to include the stock photo. Sellers can also add their own pictures using one or more Item.PictureDetails.PictureURL fields. Seller photos are particularly recommended for used and modified products to give prospective buyers a clear sense of exactly what they are purchasing. In GetItem and other 'Get' calls, the URL of the stock photo will be returned in the StockPhotoURL field. DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProductListingDetails .ISBN |
string | Conditionally |
This field is used if the seller wants to, or is required to identify a product using an ISBN (International Standard Book Number) value. An ISBN is a unique identifer for books. Both 10 and 13-character ISBNs are supported. When specifying a 13-character ISBN, the value must begin with either '978' or '979'. The seller can use the GetCategoryFeatures call to see if an ISBN is supported/required for a category. If the IncludeeBayProductDetails field is omitted or included and set to true , eBay will use the ISBN value passed into this field to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the ProductReferenceID field, this field is not needed, as all product identifiers will get picked up automatically by the listing if a matching catalog product is found. This field is only applicable for single-variation listings. For multiple-variation listings, if the category/product requires an ISBN value, this value should be passed into the Variation.VariationProductListingDetails.ISBN field instead. Note: If the listing is being posted to a category that expects an ISBN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request.
DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProductListingDetails .ProductReferenceID |
string | Conditionally |
In an Add/Revise/Relist call, this field is used to pass in the eBay Product ID (e.g. ePID), which is the unique identifier of an eBay catalog product. Although an eBay catalog product match can be found using one or more GTIN values, passing in an ePID value is the best way to try and discover the appropriate eBay catalog product. This field is also returned in GetItem if the listing is associated with a eBay catalog product. Max length: 38 (42 with "EPID"). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ProductListingDetails .StockPhotoURL |
anyURI | Conditionally |
The full URL for the eBay catalog product's stock photo. This field is only returned if the seller used an eBay catalog product to list the item, and the IncludeStockPhotoURL field was set to true .
DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProductListingDetails.UPC | string | Conditionally |
This field is used if the seller wants to, or is required to identify a product using a UPC (Universal Product Code) value. A UPC is a commonly used identifer for many different products. The seller can use the GetCategoryFeatures call to see if a UPC is supported/required for a category. Note: The UPC (and UPC values) are typically only applicable to US products listed on US eBay marketplace. If a European seller is selling a European-based product (with an EAN value) on the US site, instead of using the EAN field, the seller will use the UPC field to pass in the EAN value. If the IncludeeBayProductDetails field is omitted or included and set to true , eBay will use the UPC value passed into this field to try and find a matching eBay catalog product. If a match is found, the listing will pick up the product details of the catalog product, including the product title, product description, item specifics, and stock photo. If the seller is passing in an ePID through the ProductReferenceID field, this field is not needed, as all product identifiers will get picked up automatically by the listing if a matching catalog product is found. This field is only applicable for single-variation listings. For multiple-variation listings, if the category/product requires a UPC value, this value should be passed into the Variation.VariationProductListingDetails.UPC field instead. Note: If the listing is being posted to a category that expects a UPC value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request.
DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProductListingDetails .UseStockPhotoURLAsGallery |
boolean | Conditionally |
If this value is true , the listing will use the eBay catalog product's stock photo as the Gallery thumbnail photo. In an Add/Revise/Relist call, this field is set to true by default. If this field is set to true , the IncludeStockPhotoURL field must also be set to true or this field will have no effect. Sellers can also add their own pictures using one or more Item.PictureDetails.PictureURL fields, but none of these photos will be the Gallery thumbnail photo. DetailLevel: ItemReturnAttributes, ReturnAll. |
Item.ProxyItem | boolean | Conditionally |
Some listings on the eBay platform originate from eBay affiliates. Depending on the relationship the affiliate has with eBay, there are times when the affiliate retains ownership of the listing. When this occurs the representation of the listing on eBay is considered a proxy item. Proxy items can only be edited using API requests from the applications that originally listed them.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Quantity | int | Always |
For AddItem family of calls: The Quantity value for auction listings must always be 1 . For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations. For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1 . For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10 , and three items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7 . So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.When eBay auto-renews a GTC listing (ListingDuration = GTC) on your behalf, eBay relists with correct quantity available. For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. For order line item calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.QuantityAvailableHint | QuantityAvailableHintCodeType | Conditionally |
Indicates the type of message that will be returned describing the quantity available for the item.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.QuantityThreshold | int | Conditionally |
The quantity threshold above which the seller prefers not to show the actual quantity available. Returned when the quantity available is greater than the value of quantity threshold. Currently, 10 is the only available value for this threshold.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReasonHideFromSearch | ReasonHideFromSearchCodeType | Conditionally |
This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.
Applicable values: This enumeration value is associated with eBay Duplicate Listings Policy, which is applicable on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page. Code so that your app gracefully handles any future changes to this list. |
Item.Regulatory | RegulatoryType | Conditionally | This container is used by the seller to provide Energy Efficiency Label information, hazardous material related information, product safety related information, manufacturer information, and the repair score for the listing. |
Item.Regulatory.Documents | DocumentsType | Conditionally |
This container provides a collection of regulatory documents associated with the listing. For Revise and Relist calls: For information on removing one or more files using a Revise/Relist call, see Remove documents from listings. Note: As a part of General Product Safety Regulation (GPSR) requirements effective on December 13th, 2024, sellers operating in, or shipping to, EU-based countries or Northern Ireland are conditionally required to provide regulatory document information in their eBay listings. For more information on GPSR, see General Product Safety Regulation (GPSR). |
Item.Regulatory.Documents .Document |
DocumentType | Conditionally,
repeatable: [0..*] |
A regulatory document associated with the listing. Regulatory documents can be created and uploaded using the createDocument method of the Media API. A variety of document types can be provided for regulatory compliance. For a list of supported document types, see DocumentTypeEnum. |
Item.Regulatory.Documents .Document.DocumentID |
string | Conditionally |
The unique identifier of a regulatory document associated with the listing. This value can be found in the response of the createDocument method of the Media API. |
Item.Regulatory .EconomicOperator |
EconomicOperatorType | Conditionally |
Deprecated as of version 1371. No longer recommended. Note: Economic Operator and its associated fields have been deprecated for the Add/Revise/Relist/Verify and GetItem family of calls and will be decommissioned on October 21, 2024. It has been replaced by the Manufacturer and ResponsiblePersons containers. Economic Operator related fields should no longer be used for the Add/Revise/Relist and VerifyItem family of calls. As it is currently still supported, Economic Operator-related fields will be returned if applicable for the GetItem call. This container provides Economic Operator (EO) information about the manufacturer and/or supplier of the item. The EO is a corporate entity that is related to, has some responsibility for, the product being listed for sale. For additional information, see What is an economic operator?. Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EconomicOperator.CityName |
string | Conditionally |
Deprecated as of version 1371. No longer recommended. The city of the registered Economic Operator's street address. Max length: 50 characters. Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EconomicOperator.CompanyName |
string | Conditionally |
Deprecated as of version 1371. No longer recommended. The company name of the registered Economic Operator. Max length: 50 characters.. Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EconomicOperator.Country |
CountryCodeType | Conditionally |
Deprecated as of version 1371. No longer recommended. This defines the list of valid country codes, adapted from http://www.iso.org/iso/country_codes, ISO 3166-1 country code. List elements take the following form to identify a two-letter code with a short name in English, a three-digit code, and a three-letter code: For example, the entry for Japan includes Japan, 392, JPN. Short codes provide uniform recognition, avoiding language-dependent country names. The number code is helpful where Latin script may be problematic. Not all listed codes are universally recognized as countries, for example: code AQ is Antarctica, 010, ATA Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EconomicOperator.Email |
string | Conditionally |
Deprecated as of version 1371. No longer recommended. The registered Economic Operator's business email address. Max length: 128 characters for this field . Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EconomicOperator.Phone |
string | Conditionally |
Deprecated as of version 1371. No longer recommended. The registered Economic Operator's business phone number. Max length: 50 characters. Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EconomicOperator.PostalCode |
string | Conditionally |
Deprecated as of version 1371. No longer recommended. The postal code of the registered Economic Operator's street address. Max length: 50 characters. Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EconomicOperator .StateOrProvince |
string | Conditionally |
Deprecated as of version 1371. No longer recommended. The state or province of the registered Economic Operator's street address. Max length: 50 characters. Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EconomicOperator.Street1 |
string | Conditionally |
Deprecated as of version 1371. No longer recommended. The first line of the registered Economic Operator's street address. Max length: 50 characters. Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EconomicOperator.Street2 |
string | Conditionally |
Deprecated as of version 1371. No longer recommended. The second line, if any, of the registered Economic Operator's street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'. Max length: 50 characters.. Deprecation version: 1371. See also Deprecated Objects. |
Item.Regulatory .EnergyEfficiencyLabel |
EnergyEfficiencyType | Conditionally |
This container provides information about the energy efficiency for certain durable goods. Note: As a part of Digital Services Act (DSA) requirements, all sellers who list products in Germany (DE) must provide Energy Efficiency Label information and Product Information Sheets for listings for certain durable goods. Note: Energy efficiency information is not required for all categories. Use the getRegulatoryPolicies method of the Metadata API to return metadata on the eBay categories that recommend or require energy efficiency-related fields. |
Item.Regulatory .EnergyEfficiencyLabel .ImageDescription |
string | Conditionally |
A brief verbal summary of the information included on the Energy Efficiency Label for an item. For example, On a scale of A to G the rating is E. As with all strings, you need to escape reserved characters such as ampersand. This field is required if an Energy Efficiency Label is provided. Max length: 280. |
Item.Regulatory .EnergyEfficiencyLabel .ImageURL |
anyURI | Conditionally | The URL to the Energy Efficiency Label image that is applicable to an item. This field is required if an Energy Efficiency Label is provided. The URL provided must be an eBay Picture Services (EPS) URL only. You can upload pictures to eBay Picture Services via the UploadSiteHostedPictures call. |
Item.Regulatory .EnergyEfficiencyLabel .ProductInformationsheet |
anyURI | Conditionally | The URL to the Product Information Sheet that provides complete manufacturer-provided efficiency information about an item. This field is required if an Energy Efficiency Label is provided. The URL provided must be an eBay Picture Services (EPS) URL only. You can upload pictures to eBay Picture Services via the UploadSiteHostedPictures call. |
Item.Regulatory.Hazmat | HazmatType | Conditionally |
This container is used by the seller to provide hazardous material information for the listing. Three elements are required to complete the Hazmat section of a listing: Pictograms, SignalWord, and Statements. The fourth element, Component, is optional. For more information, see Specifying hazardous material related information. Note: Hazmat information is not required for all categories. Use the getRegulatoryPolicies method of the Metadata API to return metadata on the eBay categories that recommend or require Hazmat-related fields. |
Item.Regulatory.Hazmat .Component |
string | Conditionally |
This field is used by the seller to provide component information for the listing. For example, component information can provide the specific material of Hazmat concern. Max length: 120. |
Item.Regulatory.Hazmat .Pictograms |
PictogramsType | Conditionally | This container is used by the seller to provide pictograms for the listing. This field is required if hazmat information is supplied. |
Item.Regulatory.Hazmat .Pictograms.Pictogram |
string | Conditionally,
repeatable: [0..4] |
This field sets the pictogram code(s) for Hazard and product safety Pictogram(s) for the listing. If your product contains hazardous substances or mixtures, please select the values corresponding to the hazard pictograms that are stated on your product's Safety Data Sheet. The selected hazard information will be displayed on your listing. If your product shows universal product safety or compliance symbols, please select the values corresponding to the product safety pictograms for display in the product safety section of the listing. The seller specifies the identifier of each pictogram in this field. A separate Pictogram field is required for each Hazard or product safety pictogram. Note: For Hazard pictograms, use the getHazardousMaterialsLabels method in the Metadata API to find supported values for a specific marketplace/site. For sample values, see Pictogram sample values. For product safety pictograms, use the getProductSafetyLabels method in the Metadata API to find supported values for a specific marketplace/site. |
Item.Regulatory.Hazmat .SignalWord |
string | Conditionally |
This field sets the signal word for hazardous materials in the listing. If your product contains hazardous substances or mixtures, please select a value corresponding to the signal word that is stated on your product's Safety Data Sheet. The selected hazard information will be displayed on your listing. This field is required if hazmat information is supplied. Example values include:
|
Item.Regulatory.Hazmat .Statements |
StatementsType | Conditionally | This container is used by the seller to provide hazard statements for the listing. This field is required if hazmat information is supplied. |
Item.Regulatory.Manufacturer | ManufacturerType | Conditionally |
This container provides information about the manufacturer of the item. For Revise and Relist calls: To delete all manufacturer information when you revise or relist, specify Item.Regulatory.Manufacturer in DeletedField, and don't pass Manufacturer in the request. Note: As a part of General Product Safety Regulation (GPSR) requirements effective on December 13th, 2024, sellers operating in, or shipping to, EU-based countries or Northern Ireland are conditionally required to provide product manufacturer information in their eBay listings. Manufacturer information is not required for all categories. Use the getRegulatoryPolicies method of the Metadata API to return metadata on the eBay categories that recommend or require manufacturer-related fields. For more information on GPSR, see General Product Safety Regulation (GPSR). |
Item.Regulatory.Manufacturer .CityName |
string | Conditionally |
The city of the product manufacturer's street address. Max length: 64 characters for this field. |
Item.Regulatory.Manufacturer .CompanyName |
string | Conditionally |
The company name of the product manufacturer. Max length: 100 characters for this field. |
Item.Regulatory.Manufacturer .Country |
CountryCodeType | Conditionally |
The two letter ISO 3166-1 standard abbreviation of the country of the product manufacturer's address.
Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. |
Item.Regulatory.Manufacturer |
string | Conditionally |
The product manufacturer's business email address. Max length: 180 characters for this field. |
Item.Regulatory.Manufacturer .Phone |
string | Conditionally |
The product manufacturer's business phone number. Max length: 64 characters for this field. |
Item.Regulatory.Manufacturer .PostalCode |
string | Conditionally |
The postal code of the product manufacturer's street address. Max length: 9 characters for this field. |
Item.Regulatory.Manufacturer .StateOrProvince |
string | Conditionally |
The state or province of the product manufacturer's street address. Max length: 64 characters for this field. |
Item.Regulatory.Manufacturer .Street1 |
string | Conditionally |
The first line of the product manufacturer's street address. Max length: 180 characters for this field. |
Item.Regulatory.Manufacturer .Street2 |
string | Conditionally |
The second line of the product manufacturer's street address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'. Max length: 180 characters for this field. |
Item.Regulatory.ProductSafety | ProductSafetyType | Conditionally |
This container is used to provide product safety information for the listing. One of the following elements is required to complete the product safety section for a listing: Pictograms or Statements. The Component element is optional. For Revise and Relist calls: To delete all product safety information when you revise or relist, specify Item.Regulatory.ProductSafety in DeletedField, and don't pass ProductSafety in the request. Note: As a part of General Product Safety Regulation (GPSR) requirements effective on December 13th, 2024, sellers operating in, or shipping to, EU-based countries or Northern Ireland are conditionally required to provide product manufacturer information in their eBay listings. Product safety information is not required for all categories. Use the getRegulatoryPolicies method of the Metadata API to return metadata on the eBay categories that recommend or require product safety-related fields. For more information on GPSR, see General Product Safety Regulation (GPSR). |
Item.Regulatory.ProductSafety .Component |
string | Conditionally |
This field is used by the seller to provide product safety component information for the listing. For example, component information can include specific warnings related to product safety, such as 'Tipping hazard'. This field is optional for Product Safety. Note: Component information can only be specified if used with the Pictograms and/or Statements field; if the component is provided without one or both of these fields, an error will occur. Max length: 50 characters for this field. |
Item.Regulatory.ProductSafety .Pictograms |
PictogramsType | Conditionally |
This container is used by the seller to provide product safety pictograms for the listing. This field is conditionally required if product safety information is supplied. Note: When supplying product safety information, one of the following elements is required: Pictograms or Statements. Both elements can be included on a listing, but only one is required. A maximum of 2 pictograms are allowed for product safety. |
Item.Regulatory.ProductSafety .Pictograms.Pictogram |
string | Conditionally,
repeatable: [0..4] |
This field sets the pictogram code(s) for Hazard and product safety Pictogram(s) for the listing. If your product contains hazardous substances or mixtures, please select the values corresponding to the hazard pictograms that are stated on your product's Safety Data Sheet. The selected hazard information will be displayed on your listing. If your product shows universal product safety or compliance symbols, please select the values corresponding to the product safety pictograms for display in the product safety section of the listing. The seller specifies the identifier of each pictogram in this field. A separate Pictogram field is required for each Hazard or product safety pictogram. Note: For Hazard pictograms, use the getHazardousMaterialsLabels method in the Metadata API to find supported values for a specific marketplace/site. For sample values, see Pictogram sample values. For product safety pictograms, use the getProductSafetyLabels method in the Metadata API to find supported values for a specific marketplace/site. |
Item.Regulatory.ProductSafety .Statements |
StatementsType | Conditionally |
This container is used by the seller to provide product safety statements for the listing. This field is conditionally required if product safety information is supplied. Note: When supplying product safety information, one of the following elements is required: Pictograms or Statements. Both elements can be included on a listing, but only one is required. A maximum of 8 statements are allowed for product safety. |
Item.Regulatory.RepairScore | double | Conditionally |
This field represents the repair index for the listing. The repair index identifies the manufacturer's repair score for a product (how easy is it to repair the product). This field is a floating point value between 0 and 10 but may only have one digit beyond the decimal point, for example: 7.9 Note: 0 should not be used as a default value, as it implies that the product is not repairable.
|
Item.Regulatory .ResponsiblePersons |
ResponsiblePersonsType | Conditionally |
This container provides information about the EU-based Responsible Persons or entities associated with the listing. For Revise and Relist calls: To delete all Responsible Persons information when you revise or relist, specify Item.Regulatory.ResponsiblePersons in DeletedField, and don't pass ResponsiblePersons in the request. Note: As a part of General Product Safety Regulation (GPSR) requirements effective on December 13th, 2024, sellers operating in, or shipping to, EU-based countries or Northern Ireland are conditionally required to provide Responsible Persons information in their eBay listings if the manufacture is not based in the EU. For more information on GPSR, see General Product Safety Regulation (GPSR). |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson |
ResponsiblePersonType | Conditionally,
repeatable: [0..*] |
This container consists of the detailed contact information for each Responsible Person or entity associated with the listing. A maximum of 5 EU Responsible Persons are supported. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.CityName |
string | Conditionally |
The city of the Responsible Person's street address. Max length: 64 characters for this field. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.CompanyName |
string | [invalid value for Returned] |
The name of the the Responsible Person or entity. Max length: 100 characters for this field. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.Country |
CountryCodeType | Conditionally |
The two letter ISO 3166-1 standard abbreviation of the country of the Responsible Person's address.
Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.Email |
string | Conditionally |
The Responsible Person's email address. Max length: 180 characters for this field. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.Phone |
string | Conditionally |
The Responsible Person's business phone number. Max length: 64 characters for this field. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.PostalCode |
string | Conditionally |
The postal code of the Responsible Person's street address. Max length: 9 characters for this field. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson .StateOrProvince |
string | Conditionally |
The state of province of the Responsible Person's street address. Max length: 64 characters for this field. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.Street1 |
string | Conditionally |
The first line of the responsible Responsible Person's address. Max length: 180 characters for this field. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.Street2 |
string | Conditionally |
The second line of the Responsible Person's address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'. Max length: 180 characters for this field. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.Types |
ResponsiblePersonCodeTypes | Conditionally | The type(s) associated with the Responsible Person or entity. |
Item.Regulatory .ResponsiblePersons .ResponsiblePerson.Types.Type |
ResponsiblePersonCodeType | Conditionally,
repeatable: [1..*] |
The type of Responsible Person associated with the listing. Note: Currently, the only supported value is EUResponsiblePerson .
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Item.RelistParentID | long | Conditionally |
The identifier of the original listing that contained the item before the item was relisted. This field is only returned for an item that was relisted.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReservePrice | AmountType (double) | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ReturnPolicy | ReturnPolicyType | Conditionally |
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). Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container. Note: If you are using a return business policy set up through My eBay or via the Account API, then you should not populate the fields in this ReturnPolicy container. Instead, indicate your return policy using the SellerProfiles.SellerReturnProfile container. However, if you do not configure a return policy, all the fields in this ReturnPolicy container that are marked conditional must be populated in your request. 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. 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. Note: The GeteBayDetails call can be used to retrieve site-wide return policy metadata, but it is recommended that sellers use the GetCategoryFeatures call instead, as this call was recently updated to retrieve category-level metadata for both domestic and international return policies. Note: In May 2018, eBay added the ability to create a separate international return policy for items that are shipped to international customers. If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead for international returns. For more information on setting separate domestic and international return policies, see the International returns policy help topic. For the international equivalent of this field, see the InternationalRefundMethodValues field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReturnPolicy.Description | string | Conditionally |
This field contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. This field is valid in only the following marketplaces (the field is otherwise ignored):
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: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description. Max length: 8000 (for DE, AT); 5000 (for FR, IT, ES). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReturnPolicy .InternationalRefundOption |
token | Conditionally |
This field indicates how the seller compensates international buyers for returns. MoneyBack is the only supported value for all marketplaces except for the US. On the US marketplace, you can set this value to either MoneyBack or MoneyBackOrReplacement . MoneyBackOrReplacement can be used by sellers that have the depth of inventory to support an exchange for an identical item. However, ultimately, it is up to the buyer on whether they want money back or a replacement item. For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description. Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the refund option(s) for international returns will default to the value specified in the RefundOption field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See International Refund Methods (in GetCategoryFeatures) for supported international refund value for each site and category. Applicable values: See RefundOptionsCodeType |
Item.ReturnPolicy .InternationalReturnsAcceptedOption |
token | Conditionally |
This field is conditionally required if a seller wants to use a separate return policy for international returns. The value in this field indicates whether or not the seller accepts returns from international buyers. Applicable values are ReturnsAccepted or ReturnsNotAccepted . When set to ReturnsAccepted , this option indicates the seller allows international buyers to return items. Specify ReturnsNotAccepted for a listing if returns are not accepted from international buyers. On the eBay DE, IE, and UK, registered 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. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response. For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description. Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the return accepted value for international returns will default to the value specified in the ReturnsAcceptedOption field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See International Returns Accepted Values (in GetCategoryFeatures) for supported international returns accepted values for each site and category. Applicable values: See ReturnsAcceptedOptionsCodeType |
Item.ReturnPolicy .InternationalReturnsWithinOption |
token | Conditionally |
This field is conditionally required if a seller is using a separate return policy for international returns, and is accepting international returns. The value in this field indicates the number of days that an international buyer has to return an item. The time period begins on the day that the buyer receives the item. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. Applicable values: Retrieve the values supported by a marketplace and category by calling GetCategoryFeatures with FeatureID set to InternationalReturnsDurationValues , then see the values returned under the Category.InternationalReturnsDurationValues container in the response. For AddItem, VerifyAddItem, and RelistItem: If the seller accepts international returns (InternationalReturnsAcceptedOption is set to ReturnsAccepted) but does not specify this field for a listing, eBay sets a default value (often Days_30) and the seller is obligated to honor this setting. For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description. Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, the return period for international returns will default to the value specified in the ReturnsWithinOption field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See International Return Durations (in GetCategoryFeatures) for supported international return durations for each site and category. Applicable values: See ReturnsWithinOptionsCodeType |
Item.ReturnPolicy .InternationalShippingCostPaidByOption |
token | Conditionally |
This field is conditionally required if a seller is using a separate return policy for international returns, and is accepting international returns. The value in this field specifies whether the buyer or the seller pays for international return shipping charges. Accepted values are Buyer or Seller . eBay sites often set Seller as the default value for this field, and sellers are obligated to honor the values that are set for a listing. Depending on the seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues or for late shipments. For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description. Note: If a seller does not add a separate international return policy, the settings in the domestic return policy will be used instead. So if this field is not used in an add/revise/relist call, return shipping cost payee for international returns will default to the value specified in the ShippingCostPaidByOption field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Return Shipping Cost Payee Values (in GetCategoryFeatures) for supported international return shipping cost payee values for each site and category. Applicable values: See ShippingCostPaidByOptionsCodeType |
Item.ReturnPolicy.Refund | string | Conditionally |
Display string that buyer applications can use to present RefundOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the Refund.Description options returned by GeteBayDetails. This field is applicable to only the US marketplace and is not applicable as input to the Add/Revise/Relist family of calls. (Use RefundOption instead.) DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReturnPolicy.RefundOption | token | Conditionally |
This field indicates how the seller compensates buyers for returns. MoneyBack is the only supported value for all marketplaces except for the US. On the US marketplace, you can set this value to either MoneyBack or MoneyBackOrReplacement . MoneyBackOrReplacement can be used by sellers that have the depth of inventory to support an exchange for an identical item. However, ultimately, it is up to the buyer on whether they want money back or a replacement item. For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description. Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalRefundOption field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Domestic Refund Methods (in GetCategoryFeatures) for supported domestic refund value for each site and category. Applicable values: See RefundOptionsCodeType |
Item.ReturnPolicy .ReturnsAccepted |
string | Conditionally |
Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ReturnsAccepted.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.) DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReturnPolicy .ReturnsAcceptedOption |
token | Conditionally |
This required field indicates whether or not the seller accepts returns. Applicable values are ReturnsAccepted or ReturnsNotAccepted . When set to ReturnsAccepted , this option indicates the seller allows items to be returned. Specify ReturnsNotAccepted for a listing if returns are not accepted. On the eBay DE, IE, and UK marketplaces, registered 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. Use the Trading call GetUser to determine the status of an eBay business seller in DE, IE, and UK. Review the User.SellerInfo.SellerBusinessType field in the response. Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for their items (ReturnsAcceptedOption = ReturnsAccepted ) and handling time should be set to zero-day (same-day shipping) or one-day shipping. Set the handling time (in days) using the Item.DispatchTimeMax field. For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description. Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalReturnsAcceptedOption field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Domestic Returns Accepted Values (in GetCategoryFeatures) for supported domestic returns accepted values for each site and category. Applicable values: See ReturnsAcceptedOptionsCodeType |
Item.ReturnPolicy .ReturnsWithin |
string | Conditionally |
Display string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ReturnsWithin.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use ReturnsWithinOption instead.) DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReturnPolicy .ReturnsWithinOption |
token | Conditionally |
Specifies the amount of time the buyer has to return an item. The return period begins when the item is marked "delivered" at the buyer's specified ship-to location. Most marketplaces and categories support 30-day and 60-day return periods. eBay sites often set 30-days as the default value for this field and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted. Applicable values: Retrieve the values supported by a marketplace and category by calling GetCategoryFeatures with FeatureID set to DomesticReturnsDurationValues , then see the values returned under the Category.DomesticReturnsDurationValues container in the response. For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description. Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalReturnsWithinOption field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Domestic Return Durations (in GetCategoryFeatures) for supported domestic return durations for each site and category. Applicable values: See ReturnsWithinOptionsCodeType |
Item.ReturnPolicy .ShippingCostPaidBy |
string | Conditionally |
This is a display string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ShippingCostPaidBy.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use ShippingCostPaidByOption instead.) DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReturnPolicy .ShippingCostPaidByOption |
token | Conditionally |
This option specifies whether the buyer or the seller pays for return shipping charges. Accepted values are Buyer or Seller . eBay sites often set Seller as the default value for this field, and sellers are obligated to honor the values that are set for a listing. This value is required if ReturnsAcceptedOption=ReturnsAccepted. Depending on the seller's return policy and the specifics of a return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues or for late shipments. For ReviseItem only: You cannot change the value of this field if the listing has bids or sales, or if the listing ends within 12 hours. For more details, see the ReturnPolicy description. Note: If a seller ships internationally, and wants to define and use a separate international returns policy, the international equivalent of this field is the InternationalShippingCostPaidByOption field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Return Shipping Cost Payee Values (in GetCategoryFeatures) for supported domestic return shipping cost payee values for each site and category. Applicable values: See ShippingCostPaidByOptionsCodeType |
Item.ReviseStatus | ReviseStatusType | Always |
This container is returned if a listing has been revised in any way since it first became active. One or more boolean fields will be returned under this container based on the type of revision(s) that occured, including a general revision, a price change, or a feature added or removed.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReviseStatus .BuyItNowAdded |
boolean | Conditionally |
This field is returned as true if a Buy It Now price has been added to the auction listing. This field is only returned if the original auction listing did not have a Buy It Now price, but a revision to that original listing included adding a Buy It Now price.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReviseStatus .BuyItNowLowered |
boolean | Conditionally |
This field is returned as true if the Buy It Now price on the original auction listing was lowered as part of a revision to the original auction listing. This field is only returned if the Buy It Now price on the original auction listing was lowered as part of a revision to the original auction listing.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReviseStatus.ItemRevised | boolean | Always |
This field is returned as true if the original listing has been revised. This field is always returned with the ReviseStatus container.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReviseStatus .ReserveLowered |
boolean | Conditionally |
This field is returned as true if the Reserve price on the original auction listing was lowered as part of a revision to the original auction listing. This field is only returned if the Reserve price on the original auction listing was lowered as part of a revision to the original auction listing.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ReviseStatus .ReserveRemoved |
boolean | Conditionally |
This field is returned as true if the Reserve price on the original auction listing was removed as part of a revision to the original auction listing. This field is only returned if the Reserve price on the original auction listing was removed as part of a revision to the original auction listing.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SecondaryCategory | CategoryType | Conditionally |
The unique identifier for a secondary category. This field is only applicable if the seller decides to list the item under two categories. You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. The final value fee is based on the primary category in which the item is listed. Furthermore, you can list the same item in an eBay Motors Parts & Accessories category and in an eligible eBay category, as long as the primary category is associated with the site on which you are listing. That is, the two categories can be a mix of Motors Parts & Accessories and eBay site categories. (Real Estate, Mature Audience (adult), and Business & Industrial categories are not eligible for listing in two categories in this manner.) For example, if you list on Motors, the primary category could be 6750 (eBay Motors > Parts & Accessories > Apparel & Merchandise > Motorcycle > Jackets & Leathers), and the secondary category could be 57988 (eBay > Clothing, Shoes > Accessories > Men's Clothing > Outerwear). If you list on the main eBay site, the primary category could be 57988 and the secondary category could be 6750. If eBay has designated a listing category as a value category (see ValueCategory in GetCategoryFeatures), and that listing category will be the seller's primary category, the seller will not be able to list their item in a secondary category. If a seller's request payload includes a primary or a secondary category that is designated as a value category, then eBay drops the SecondaryCategory ID and only lists the item in the category specified with the PrimaryCategory ID. Also, if the listing request includes Item Specifics (in ItemSpecifics) that are associated with the SecondaryCategory, eBay drops those values as well when the SecondaryCategory is dropped. The same logic is used if you revise an existing listing to add a secondary category, or to change one of the categories: If either the primary or secondary category is a value category, eBay drops the secondary category from your request.) To remove this value when relisting an item, use DeletedField. For ReviseItem only: When revising a listing within 12 hours of the listing's scheduled end time, you can only add or change the secondary category when an auction listing has no active bids or a multiple-quantity, fixed-price listing has no items sold. If you change the secondary category, any corresponding Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the category. For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SecondaryCategory .CategoryID |
string | Conditionally |
This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories. Note: When listing in categoryID 173651 (Auto Performance Tuning Devices & Software), use of catalog products is required. For more information, see Tuning devices and software. In an Add call, the PrimaryCategory.CategoryID is conditionally required unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, item specifics, listing category, and stock photo defined in the catalog product is used to create the listing. In an Add/Revise/Relist call, the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used. Using a Secondary Category can incur a listing fee. For ReviseItem only: Previously, removing the listing from a secondary category was only possible within 12 hours of the listing's scheduled end time when an auction listing had no active bids or a multiple-quantity, fixed-price listing had no items sold, but this restriction no longer exists. Now, the secondary category can be dropped for any active listing at any time, regardless of whether an auction listing has bids or a fixed-price listing has sales. To drop a secondary category, the seller passes in a value of 0 in the SecondaryCategory.CategoryID field. Max length: 10. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SecondaryCategory .CategoryName |
string | Conditionally |
This string value is the display name of the eBay primary category, as it would appear on the eBay site. In GetItem, this will be a fully-qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller | UserType | Always |
Container for information about this listing's seller. Returned by GetItemsAwaitingFeedback if Buyer is making the request. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.AboutMePage | boolean | Always |
A value of true indicates that the user has set up an About Me page. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.eBayGoodStanding | boolean | Always |
This boolean field is returned as true if the eBay user is in good standing with eBay. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.Email | string | Conditionally |
Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. For the GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field . DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.FeedbackPrivate | boolean | Always |
Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). The percentage of positive feedback can still be returned, even if other feedback details are private. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.FeedbackRatingStar | FeedbackRatingStarCodeType | Always |
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. Applicable values: See FeedbackRatingStar. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.FeedbackScore | int | Conditionally |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true . In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.IDVerified | boolean | Always |
Indicates whether the user has been verified. For more information about the ID Verify program, see: Protecting your account Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.NewUser | boolean | Always |
This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less. Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .PositiveFeedbackPercent |
float | Conditionally |
Percent of total feedback that is positive. For example, if the member has 50 feedbacks, where 49 are positive and 1 is neutral or negative, the positive feedback percent could be 98.0. The value uses a max precision of 4 and a scale of 1. If the user has feedback, this value can be returned regardless of whether the member has chosen to make their feedback private. Not returned if the user has no feedback. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Positive Feedback Percentage value for the user is returned to the buyer or seller, but a dummy value of 0.0 will be returned to all third parties.
|
Item.Seller .RegistrationAddress |
AddressType | Conditionally |
This container consists of the Registration address for the eBay user. GetUser: eBay returns complete RegistrationAddress details (including Phone), as applicable to the registration site for the eBay user making the call. GetItem and GetSellerTransactions: RegistrationAddress for another user (except for Phone) is only returned if you have an order relationship with that user AND that user is registered on DE/AT/CH, regardless of your registration site and the site to which you send the request. For example, the seller can see the buyer's registration address if the buyer is registered on DE/AT/CH, or the buyer can see the seller's registration address if the seller is registered on DE/AT/CH. (The buyer and seller won't see their own registration addresses in GetItem.) Note: This container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. DetailLevel: ReturnAll. |
Item.Seller .RegistrationAddress.CityName |
string | Conditionally |
The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress.Country |
CountryCodeType | Conditionally |
The two-digit code representing the country of the user. If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made. Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress .CountryName |
string | Conditionally |
The full name of the country associated with an address on file with eBay. Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress.FirstName |
string | Conditionally |
Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType value is Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress.LastName |
string | Conditionally |
Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress.Name |
string | Conditionally |
The eBay user's name associated with an address on file with eBay. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. Max length: 128. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress.Phone |
string | Conditionally |
User's primary phone number. This may return a value of Invalid Request if:
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress .PostalCode |
string | Conditionally |
User's postal code. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress.Street |
string | Conditionally |
A concatenation of Street1 and Street2, primarily used for a registration address.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress.Street1 |
string | Conditionally |
The first line of the user's street address. Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller .RegistrationAddress.Street2 |
string | Conditionally |
The second line of the user's street address (such as an apartment number or suite number). Returned if the user specified a second street value for their address. Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456" Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.RegistrationDate | dateTime | Always |
Indicates the date the specified user originally registered with eBay. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo | SellerType | Always |
Contains information about a seller, including listing settings, listing preferences, seller rankings, and seller type. Note: This container will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .AllowPaymentEdit |
boolean | Always |
Indicates whether the seller allows buyers to edit the total cost of an item during checkout. Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .BillingCurrency |
CurrencyCodeType | Conditionally |
Currency type in which the user is billed seller fees.
Applicable values: See BillingCurrency. Code so that your app gracefully handles any future changes to this list. |
Item.Seller.SellerInfo .CheckoutEnabled |
boolean | Always |
This flag indicates whether or not the seller's Checkout Enabled preference is turned on. Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .CIPBankAccountStored |
boolean | Always |
This boolean field indicates whether or not the seller has stored bank account information on file with eBay. Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .GoodStanding |
boolean | Always |
This boolean field indicates whether or not the seller is in good standing with eBay. Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .QualifiesForB2BVAT |
boolean | Always |
Indicates whether the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .SafePaymentExempt |
boolean | Always |
If this field is true , the user is exempt from the requirement to offer at least one safe payment method when listing items. Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. Default: false. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .SellerBusinessType |
SellerBusinessCodeType | Conditionally |
This enumeration value indicates the type of eBay account used by the seller.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .SellerLevel |
SellerLevelCodeType | Always |
This enumeration value indicates the user's eBay PowerSeller tier. Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. Applicable values: See SellerLevel. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .StoreOwner |
boolean | Always |
Boolean value indicates whether or not the seller is an eBay Store owner. Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .StoreURL |
anyURI | Conditionally |
The URL for the seller's eBay Store. This field is only returned if the seller is a store owner (look for a value of true in the SellerInfo.StoreOwner field). Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.SellerInfo .TopRatedSeller |
boolean | Conditionally |
This boolean field indicates if the seller is certified as a Top Rated Seller. Only Top Rated Sellers can qualify for Top Rated Plus listings, which receive the Top Rated Plus seal and other benefits. This field is only returned for the following sites: US, Germany, Austria, Switzerland, UK, Ireland, and Australia. The Top Rated Seller and Top Rated Plus listing requirements will differ by site. Below are some links to Help pages that discuss these requirements:
Note: The SellerInfo container and its child fields will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.Site | SiteCodeType | Always |
eBay site the user is registered with. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Applicable values: See Site. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.Status | UserStatusCodeType | Always |
Indicates the user's registration/user status.
Applicable values: See Status. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.UserID | UserIDType (string) | Always |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot , it might be displayed as, "I****A". Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3 . Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.UserIDChanged | boolean | Always |
If true , identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser). Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.UserIDLastChanged | dateTime | Always |
Date and time when the user last changed their eBay user ID (in GMT). Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Seller.VATStatus | VATStatusCodeType | Always |
Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Vat-exempt sellers. |
Item.SellerContactDetails | AddressType | Conditionally |
This container is used by sellers of Classified Ad listings to provide contact information.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .CompanyName |
string | Conditionally |
User's company name. This field should only be passed in or returned if applicable/defined.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .County |
string | Conditionally |
The county associated with an address on file with eBay. This field should only be passed in or returned if applicable/defined.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .FirstName |
string | Conditionally |
Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType value is Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .LastName |
string | Conditionally |
Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .PhoneAreaOrCityCode |
string | Conditionally |
Area or City Code of a user's primary phone number. This field applies to Classified Ad listings only.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .PhoneCountryCode |
CountryCodeType | Conditionally |
Standard ISO code for the country of the user's primary telephone phone number. For Classified Ad listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad listings only.
Applicable values: See PhoneCountryCode. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .PhoneCountryPrefix |
string | Conditionally |
Country Prefix of the secondary phone number. This value is derived from inputs supplied for PhoneCountryCode. This field applies to Classified Ad listings only.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .PhoneLocalNumber |
string | Conditionally |
The local number portion of the user's primary phone number. This field applies to Classified Ad listings only. Note: The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix. Max length: 30. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .Street1 |
string | Conditionally |
The first line of the user's street address. Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerContactDetails .Street2 |
string | Conditionally |
The second line of the user's street address (such as an apartment number or suite number). Returned if the user specified a second street value for their address. Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456" Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles | SellerProfilesType | Conditionally |
This container is used if the seller would like to use/reference business policies to create, revise, relist, or verify their listing. The seller's account must be opted in to business policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy must be specified and applied to the listing. If the seller's account is not opted in to business policies, that seller may not use this container. Sellers must opt-in to business policies through My eBay or by using the optInToProgram call of the eBay Account API. If business policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request. Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. This container is only returned in 'Get' calls if business policies are set for the listing, and the person making the API call is the seller of the listing. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify API call to reference and use the settings/values of a payment business policy. Payment business policies contain a setting to control whether immediate payment is required, settings to specify due dates for the deposit and full payment of a motor vehicle listing (Motors policy only), and settings to specify which offline payment methods are avaiable to buyers for sales transactions that happen off of eBay's platform. Multiple payment business policies can be created and saved at the account level by sellers. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. Note: Sellers will never have to specify electronic payment methods, but offline payment methods are required for listings where offline payment is required or supported. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles .SellerPaymentProfile .PaymentProfileID |
long | Conditionally |
The unique identifier of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a return business policy. Return business policies contain detailed information on the seller's return policy for domestic and international buyers (if the seller ships internationally), including whether or not the seller accepts returns from domestic and international buyers, how many days the buyer has to return the item for a refund, and who pays the return shipping costs. Multiple return policy business policies can be created and saved at the account level by sellers. Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container. This container is only returned in 'Get' calls if Business Policies are set for the listing and the person making the API call is the seller of the listing. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. Return policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a specific shipping business policy. Shipping business policies contain detailed information on domestic and international shipping, including shipping service options and costs, handling time, shipping discount information, and excluded ship-to locations. Multiple shipping business policies can be created and saved at the account level by sellers. Note: Any shipping inclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a shipping business policy. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shippping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence. Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ShipppingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping business policy. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a shipping business policy. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shipping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShippingProfileID takes precedence. In the 'Get' calls, the ShippingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the shipping business policy. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellerVacationNote | string | Conditionally |
This field is returned if the seller of the item is currently on vacation and has configured a custom message to display to potentioal buyers through Time Away settings. Note: There are two Time Away modes - Pause Sales and Allow Sales. If seller is in the Pause Sales mode, all fixed-price listings for that seller will be hidden from search results during the span of the seller's vacation. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus | SellingStatusType | Always |
Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.AdminEnded | boolean | Conditionally |
If included in the response as true , indicates that the listing was administratively canceled due to a violation of eBay's listing policies and that the item can be relisted using RelistItem. Note: GetItem returns an error (invalid item ID) in the response if Item.SellingStatus.AdminEnded = true and the requesting user is not the seller of the item.
|
Item.SellingStatus.BidCount | int | Always |
Number of bids placed so far against the auction item.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .BidIncrement |
AmountType (double) | Always |
The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price listings.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .BidIncrement [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price listings. For a list of possible enumeration values, see CurrencyCodeType. |
Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
Item.SellingStatus .CurrentPrice |
AmountType (double) | Always |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
Item.SellingStatus.HighBidder | UserType | Conditionally |
For ended auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, fixed-price listings, this field is a container for the user ID of the purchaser. This field isn't returned for auctions with no bids, or for active fixed-price listings. In the case of PlaceOffer, for auction listings, this field is a container for the high bidder's user ID. In the PlaceOffer response, the following applies: For multiple-quantity, fixed-price listings, the high bidder is only returned if there is just one order line item (or only for the first order line item that is created). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .AboutMePage |
boolean | Conditionally |
A value of true indicates that the user has set up an About Me page. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .BuyerInfo |
BuyerType | Conditionally |
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .BuyerInfo.ShippingAddress |
AddressType | Conditionally |
This container shows the buyer's shipping address. Note: For an Authenticity Guarantee program order returned in GetItemTransactions or GetSellerTransactions, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer's shipping address. Note: For In-Store Pickup and Click and Collect orders, this is the address of the merchant's store where the buyer will pick up the order. This is only applicable for GetItemTransactions and GetSellerTransactions calls. Note: For eBay Vault scenarios: GetItemTransactions calls, and GetSellerTransactions calls (Seller View only), mock address details are returned for: <ShippingAddress> DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .BuyerInfo.ShippingAddress .Country |
CountryCodeType | Conditionally |
The two-digit code representing the country of the user. If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made. Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .BuyerInfo.ShippingAddress .FirstName |
string | Conditionally |
Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType value is Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .BuyerInfo.ShippingAddress .LastName |
string | Conditionally |
Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .BuyerInfo.ShippingAddress .PostalCode |
string | Conditionally |
User's postal code. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .eBayGoodStanding |
boolean | Conditionally |
This boolean field is returned as true if the eBay user is in good standing with eBay. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder |
string | Conditionally |
Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. For the GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field . DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .FeedbackPrivate |
boolean | Conditionally |
Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). The percentage of positive feedback can still be returned, even if other feedback details are private. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .FeedbackRatingStar |
FeedbackRatingStarCodeType | Conditionally |
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. Applicable values: See FeedbackRatingStar. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .FeedbackScore |
int | Conditionally |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true . In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .IDVerified |
boolean | Conditionally |
Indicates whether the user has been verified. For more information about the ID Verify program, see: Protecting your account Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .NewUser |
boolean | Conditionally |
This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less. Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .PositiveFeedbackPercent |
float | Conditionally |
Percent of total feedback that is positive. For example, if the member has 50 feedbacks, where 49 are positive and 1 is neutral or negative, the positive feedback percent could be 98.0. The value uses a max precision of 4 and a scale of 1. If the user has feedback, this value can be returned regardless of whether the member has chosen to make their feedback private. Not returned if the user has no feedback. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Positive Feedback Percentage value for the user is returned to the buyer or seller, but a dummy value of 0.0 will be returned to all third parties.
|
Item.SellingStatus.HighBidder .RegistrationAddress |
AddressType | Conditionally |
This container consists of the Registration address for the eBay user. GetUser: eBay returns complete RegistrationAddress details (including Phone), as applicable to the registration site for the eBay user making the call. GetItem and GetSellerTransactions: RegistrationAddress for another user (except for Phone) is only returned if you have an order relationship with that user AND that user is registered on DE/AT/CH, regardless of your registration site and the site to which you send the request. For example, the seller can see the buyer's registration address if the buyer is registered on DE/AT/CH, or the buyer can see the seller's registration address if the seller is registered on DE/AT/CH. (The buyer and seller won't see their own registration addresses in GetItem.) Note: This container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. DetailLevel: ReturnAll. |
Item.SellingStatus.HighBidder .RegistrationAddress.CityName |
string | Conditionally |
The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress.Country |
CountryCodeType | Conditionally |
The two-digit code representing the country of the user. If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made. Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress .CountryName |
string | Conditionally |
The full name of the country associated with an address on file with eBay. Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress.FirstName |
string | Conditionally |
Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType value is Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress.LastName |
string | Conditionally |
Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to Commercial .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress.Name |
string | Conditionally |
The eBay user's name associated with an address on file with eBay. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. Max length: 128. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress.Phone |
string | Conditionally |
User's primary phone number. This may return a value of Invalid Request if:
Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress .PostalCode |
string | Conditionally |
User's postal code. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress.Street |
string | Conditionally |
A concatenation of Street1 and Street2, primarily used for a registration address.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress.Street1 |
string | Conditionally |
The first line of the user's street address. Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationAddress.Street2 |
string | Conditionally |
The second line of the user's street address (such as an apartment number or suite number). Returned if the user specified a second street value for their address. Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456" Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .RegistrationDate |
dateTime | Always |
Indicates the date the specified user originally registered with eBay. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .Site |
SiteCodeType | Conditionally |
eBay site the user is registered with. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Applicable values: See Site. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .Status |
UserStatusCodeType | Conditionally |
Indicates the user's registration/user status.
Applicable values: See Status. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .UserAnonymized |
boolean | Always |
Indicates whether or not the User container has been made anonymous. If true , some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed. Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .UserID |
UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot , it might be displayed as, "I****A". Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3 . Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .UserIDChanged |
boolean | Conditionally |
If true , identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser). Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .UserIDLastChanged |
dateTime | Conditionally |
Date and time when the user last changed their eBay user ID (in GMT). Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.HighBidder .VATStatus |
VATStatusCodeType | Conditionally |
Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Vat-exempt sellers. |
Item.SellingStatus.LeadCount | int | Conditionally |
Applicable to Ad type listings only. Indicates how many leads to potential buyers are associated with this item. Returns 0 (zero) for listings in other formats. You must be the seller of the item to retrieve the lead count.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .ListingOnHold |
boolean | Conditionally |
Indicates if a listing is on hold due to an eBay policy violation. If a listing is put on hold, users are unable to view the listing details, the listing is hidden from search, and all attempted purchases, offers, and bids for the listing are blocked. eBay, however, gives sellers the opportunity to address violations and get listings fully reinstated. A listing will be ended if a seller does not address a violation, or if the violation can not be rectified. If a listing is fixable, the seller should be able to view the listing details and this boolean will be returned as true . Once a listing is fixed, this boolean will no longer be returned. |
Item.SellingStatus .ListingStatus |
ListingStatusCodeType | Always |
Specifies an active or ended listing's status in eBay's processing workflow.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .MinimumToBid |
AmountType (double) | Always |
Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to auction listings. Returns null for fixed-price and Ad type listings. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .MinimumToBid [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to auction listings. Returns null for fixed-price and Ad type listings. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
Item.SellingStatus .PromotionalSaleDetails |
PromotionalSaleDetailsType | Conditionally |
If a seller has reduced the price of a listed item with the Promotional Price Display feature, this field contains the original price of the discounted item, along with the start-time and end-time of the discount.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .PromotionalSaleDetails .EndTime |
dateTime | Conditionally |
End time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .PromotionalSaleDetails .OriginalPrice |
AmountType (double) | Conditionally |
Original price of an item whose price a seller has reduced with the Promotional Price Display feature.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .PromotionalSaleDetails .OriginalPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Original price of an item whose price a seller has reduced with the Promotional Price Display feature. For a list of possible enumeration values, see CurrencyCodeType. |
Item.SellingStatus .PromotionalSaleDetails .StartTime |
dateTime | Conditionally |
Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .QuantitySold |
int | Always |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .QuantitySoldByPickupInStore |
int | Always |
Indicates the total quantity of items sold and picked up by buyers using the In-Store Pickup option. This value is the total number of items purchased by one or more buyers using the In-Store Pickup option, and is not the total number of In-Store Pickup orders. So, if two buyers selected the In-Store Pickup option, but each of these buyers bought a quantity of five of these items (in same purchase), the Item.SellingStatus.QuantitySoldByPickupInStore value would be '10' and not '2'. In the case of multi-variation, fixed-price listings, each Item.Variations.Variation.SellingStatus.QuantitySoldByPickupInStore value indicates the total quantity of that corresponding item variation (for example, large blue shirts) sold and picked up by buyers using the In-Store Pickup option, and the Item.SellingStatus.QuantitySoldByPickupInStore value would be the total quantity of all item variations sold for the listing. This field is returned only if the listing is eligible for In-Store Pickup (EligibleForPickupInStore is returned as true ). Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.ReserveMet | boolean | Always |
Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus .SecondChanceEligible |
boolean | Always |
Part of the Second Chance Offer feature, indicates whether the seller can extend a second chance offer for the item.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SellingStatus.SoldAsBin | boolean | Conditionally | If this flag appears in the GetItem response, the auction has ended due to the item being sold to a seller using the Buy It Now option. This flag is not relevant for fixed-priced listings. |
Item.ShippingDetails | ShippingDetailsType | Conditionally |
The shipping-related details for an order, including flat and calculated shipping costs. Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the ShippingDetails container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container. If you do not use a fulfillment business policy, many of the fields under this ShippingDetails container become required in your request. Note: For ReviseItem and ReviseFixedPriceItem calls: If you are updating any field under the ShippingDetails container, you must include all containers and fields set under this container even if their values are not changing. If you do not do this, some fields may be removed from the listing. To find out the values included in the current listing, call GetItem and look through the ShippingDetails container in the response. For additional information, see Revise shipping details. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity, fixed-price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes—the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform. Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
For GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
Item.ShippingDetails .CalculatedShippingDiscount |
CalculatedShippingDiscountType | Conditionally |
If a calculated shipping discount was offered for the domestic shipping services, this contains the details of the calculated shipping discount. Otherwise, it is not returned. Only returned if the calling user is the seller.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingDiscount .DiscountName |
DiscountNameCodeType | Conditionally |
This enumeration value indicates the type of calculated shipping discount rule that is being applied. Each rule is explained below.
Applicable values: (Not all values in DiscountNameCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingDiscount .DiscountProfile |
DiscountProfileType | Conditionally,
repeatable: [0..*] |
This container provides details of this particular calculated shipping discount profile. For SetShippingDiscountProfiles: If the ModifyActionCode value is set to Update , all details of the modified version of the profile must be provided. If the ModifyActionCode value is set to Delete , the DiscountProfileID is required, the MappingDiscountProfileID is optional, and all other fields of the container are no longer applicable. Restrictions on how many profiles can exist for a given discount rule are discussed in the Features Guide documentation on Shipping Cost Discount Profiles. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingDiscount .DiscountProfile .DiscountProfileID |
string | Conditionally |
The unique eBay-created unique identifier for the shipping discount, assigned when the shipping discount rule is created. In a SetShippingDiscountProfiles call,
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingDiscount .DiscountProfile .DiscountProfileName |
string | Conditionally |
The seller-provided title for the shipping discount rule. In a SetShippingDiscountProfiles call,
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingDiscount .DiscountProfile .MappedDiscountProfileID |
string | Conditionally |
For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when ModifyActionCode is set to Delete , any listings currently using the profile identified by DiscountProfileID will have that profile removed.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingDiscount .DiscountProfile.WeightOff |
MeasureType (decimal) | Conditionally |
The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. This field is only applicable for calculated shipping.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingDiscount .DiscountProfile.WeightOff [ attribute unit ] |
token | Conditionally | The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. This field is only applicable for calculated shipping. |
Item.ShippingDetails .CalculatedShippingDiscount .DiscountProfile.WeightOff [ attribute measurementSystem ] |
MeasurementSystemCodeType | Conditionally |
The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. This field is only applicable for calculated shipping. For a list of possible enumeration values, see MeasurementSystemCodeType. |
Item.ShippingDetails .CalculatedShippingRate |
CalculatedShippingRateType | Conditionally |
Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator. Note: The CalculatedShippingRate container should only be used to specify values for the InternationalPackagingHandlingCosts and/or PackagingHandlingCosts fields. The rest of the fields in the CalculatedShippingRate container are used to specify package dimensions and package weight, and these values should now be specified in the ShippingPackageDetails container instead. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts |
AmountType (double) | Always |
This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option. For international calculated shipping only. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option. For international calculated shipping only. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts |
AmountType (double) | Always |
Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .ExcludeShipToLocation |
string | Conditionally,
repeatable: [0..*] |
Use this field in an Add/Revise/Relist call to specify an international country or region, or a special domestic location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you will not ship the associated item. Repeat this element in the call request for each location that you want to exclude as a shipping destination for your item. The exclude ship-to location values are eBay regions and countries. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails, and then look for the ExcludeShippingLocationDetails.Location fields in the response. Repeat GeteBayDetails for each site on which you list. This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where you will, and will not, ship. You can list a region in the ShipToLocations field, then exclude specific countries within that region with this field (for example, you can specify Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation setting). In addition, if your ShipToLocations is Worldwide , you can use this field to specify both regions and countries that you want to exclude from your shipping destinations. Note: The ShipToLocations and ShippingDetails.ExcludeShipToLocation containers are not applicable for motor vehicle listings on the US, CA, or UK marketplaces. If these containers are sent in the request, they are ignored and a warning is returned. Note: Any shipping exclusions specified by this field can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program. You can specify a default set of locations to where you will not ship in My eBay. If you create an Exclude Ship-To List, it is, by default, in effect when you list items. However, if you specify any value in this field on input, it nullifies the default settings in your Exclude Ship-To List. (If you use ExcludeShipToLocation when you list an item, you will need to list all the locations to where you will not ship the associated item, regardless of the default settings in your Exclude Ship-To List.) Specify none in this field to override the default Exclude Ship-To List you might have set up in My eBay and indicate that you do not want to exclude any shipping locations from the respective item listing. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions responses on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See CountryCodeType, ShippingRegionCodeType |
Item.ShippingDetails .FlatShippingDiscount |
FlatShippingDiscountType | Conditionally |
If a flat rate shipping discount was offered for the domestic shipping services, this contains the details of the flat rate shipping discount. Otherwise, it is not returned. Only returned if the calling user is the seller.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .FlatShippingDiscount .DiscountName |
DiscountNameCodeType | Conditionally |
The type of discount or rule that is being used by the profile. The value corresponding to the selected rule is set in the same-named field of FlatShippingDiscount.DiscountProfile.
Applicable values: (Not all values in DiscountNameCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .FlatShippingDiscount .DiscountProfile |
DiscountProfileType | Conditionally,
repeatable: [0..*] |
Details of this particular flat-rate shipping discount profile. If the value of ModifyActionCode is Modify , all details of the new version of the profile must be provided. If ModifyActionCode is Delete , DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .FlatShippingDiscount .DiscountProfile .DiscountProfileID |
string | Conditionally |
The unique eBay-created unique identifier for the shipping discount, assigned when the shipping discount rule is created. In a SetShippingDiscountProfiles call,
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .FlatShippingDiscount .DiscountProfile .DiscountProfileName |
string | Conditionally |
The seller-provided title for the shipping discount rule. In a SetShippingDiscountProfiles call,
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .FlatShippingDiscount .DiscountProfile .EachAdditionalAmount |
AmountType (double) | Conditionally |
The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set the EachAdditionalAmount to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. This field is only applicable for flat-rate shipping.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .FlatShippingDiscount .DiscountProfile .EachAdditionalAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set the EachAdditionalAmount to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. This field is only applicable for flat-rate shipping. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .FlatShippingDiscount .DiscountProfile .EachAdditionalAmountOff |
AmountType (double) | Conditionally |
The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmountOff to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .FlatShippingDiscount .DiscountProfile .EachAdditionalAmountOff [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmountOff to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .FlatShippingDiscount .DiscountProfile .EachAdditionalPercentOff |
float | Conditionally |
The percentage by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalPercentOff to 0.25. The cost to ship three items would normally be $24, but since the seller specified 0.25 ($2 out of $8), the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails.GetItFast | boolean | Always |
Note: This field is deprecated and will stop being returned in order management calls on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .GlobalShipping |
boolean | Conditionally |
Note: The Global Shipping Program (GSP) is only available on the UK marketplace. On the US marketplace, the Global Shipping Program was replaced by the intermediated international shipping program called eBay International Shipping. eBay International Shipping is an account level setting, and no field will need to be set in a add/revise call to enable this setting. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into eBay International Shipping, that same seller can still also specify individual international shipping service options through the ShippingDetails.InternationalShippingServiceOption container. In an Add/Revise/Relist call, this boolean field can be included and set to True if the seller would like to use eBay's Global Shipping Program for orders that are shipped internationally. In 'Get' calls, if this field is returned as True , it indicates that international shipping through the Global Shipping Program is available for the listing. If this field is returned as False , the seller is responsible for shipping the item internationally using one of the specified international shipping service options set for the listing. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalCalculatedShippingDiscount |
CalculatedShippingDiscountType | Conditionally |
This value is returned only if the seller is making the call. If a calculated shipping discount was offered for the international shipping services, this contains the details of the calculated shipping discount. Otherwise, it is not returned.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalCalculatedShippingDiscount .DiscountName |
DiscountNameCodeType | Conditionally |
This enumeration value indicates the type of calculated shipping discount rule that is being applied. Each rule is explained below.
Applicable values: (Not all values in DiscountNameCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalCalculatedShippingDiscount .DiscountProfile |
DiscountProfileType | Conditionally,
repeatable: [0..*] |
This container provides details of this particular calculated shipping discount profile. For SetShippingDiscountProfiles: If the ModifyActionCode value is set to Update , all details of the modified version of the profile must be provided. If the ModifyActionCode value is set to Delete , the DiscountProfileID is required, the MappingDiscountProfileID is optional, and all other fields of the container are no longer applicable. Restrictions on how many profiles can exist for a given discount rule are discussed in the Features Guide documentation on Shipping Cost Discount Profiles. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalCalculatedShippingDiscount .DiscountProfile .DiscountProfileID |
string | Conditionally |
The unique eBay-created unique identifier for the shipping discount, assigned when the shipping discount rule is created. In a SetShippingDiscountProfiles call,
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalCalculatedShippingDiscount .DiscountProfile .DiscountProfileName |
string | Conditionally |
The seller-provided title for the shipping discount rule. In a SetShippingDiscountProfiles call,
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalCalculatedShippingDiscount .DiscountProfile .MappedDiscountProfileID |
string | Conditionally |
For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when ModifyActionCode is set to Delete , any listings currently using the profile identified by DiscountProfileID will have that profile removed.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalCalculatedShippingDiscount .DiscountProfile.WeightOff |
MeasureType (decimal) | Conditionally |
The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. This field is only applicable for calculated shipping.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalCalculatedShippingDiscount .DiscountProfile.WeightOff [ attribute unit ] |
token | Conditionally | The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. This field is only applicable for calculated shipping. |
Item.ShippingDetails .InternationalCalculatedShippingDiscount .DiscountProfile.WeightOff [ attribute measurementSystem ] |
MeasurementSystemCodeType | Conditionally |
The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. This field is only applicable for calculated shipping. For a list of possible enumeration values, see MeasurementSystemCodeType. |
Item.ShippingDetails .InternationalFlatShippingDiscount |
FlatShippingDiscountType | Conditionally |
This value is returned only if the seller is making the call. If a flat rate shipping discount was offered for the international shipping services, this contains the details of the flat rate shipping discount. Otherwise, it is not returned.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalFlatShippingDiscount .DiscountName |
DiscountNameCodeType | Conditionally |
The type of discount or rule that is being used by the profile. The value corresponding to the selected rule is set in the same-named field of FlatShippingDiscount.DiscountProfile.
Applicable values: (Not all values in DiscountNameCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalFlatShippingDiscount .DiscountProfile |
DiscountProfileType | Conditionally,
repeatable: [0..*] |
Details of this particular flat-rate shipping discount profile. If the value of ModifyActionCode is Modify , all details of the new version of the profile must be provided. If ModifyActionCode is Delete , DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalFlatShippingDiscount .DiscountProfile .DiscountProfileID |
string | Conditionally |
The unique eBay-created unique identifier for the shipping discount, assigned when the shipping discount rule is created. In a SetShippingDiscountProfiles call,
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalFlatShippingDiscount .DiscountProfile .DiscountProfileName |
string | Conditionally |
The seller-provided title for the shipping discount rule. In a SetShippingDiscountProfiles call,
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalFlatShippingDiscount .DiscountProfile .EachAdditionalAmount |
AmountType (double) | Conditionally |
The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set the EachAdditionalAmount to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. This field is only applicable for flat-rate shipping.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalFlatShippingDiscount .DiscountProfile .EachAdditionalAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set the EachAdditionalAmount to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. This field is only applicable for flat-rate shipping. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .InternationalFlatShippingDiscount .DiscountProfile .EachAdditionalAmountOff |
AmountType (double) | Conditionally |
The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmountOff to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalFlatShippingDiscount .DiscountProfile .EachAdditionalAmountOff [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmountOff to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .InternationalFlatShippingDiscount .DiscountProfile .EachAdditionalPercentOff |
float | Conditionally |
The percentage by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalPercentOff to 0.25. The cost to ship three items would normally be $24, but since the seller specified 0.25 ($2 out of $8), the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalPromotionalShippingDiscount |
boolean | Conditionally |
On input, this specifies whether to offer the promotional shipping discount for the listing's international shipping services (only applicable if the seller has a promotional shipping discount in effect at the moment). Returned on output only if the seller is making the call. This value indicates whether the promotional shipping discount is being offered for the international shipping services of this listing (if the listing is still active—this is only possible if the seller has a promotional shipping discount in effect at the moment) or whether the discount was offered at the time the listing ended. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalShippingDiscountProfileID |
string | Conditionally |
On input, this is the ID of the shipping discount to offer for the international shipping services (where the shipping discount is either of type FlatShippingDiscount or CalculatedShippingDiscount). In the RelistItem and ReviseItem family of calls, you can remove the existing InternationalShippingDiscountProfileID associated with the item by supplying a value of 0 (zero). Returned on output only if the seller is making the call. The value is the ID of the shipping discount offered and corresponds to whichever is returned: FlatShippingDiscount or CalculatedShippingDiscount. If the user created a shipping discount profile, use InternationalShippingDiscountProfileID. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalShippingServiceOption |
InternationalShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions. If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping or eBay International Shipping is offered for the listing). If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program or eBay International Shipping) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
Item.ShippingDetails .InternationalShippingServiceOption .ShippingService |
token | Conditionally |
An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails. To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. For flat and calculated shipping. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item. When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-types-rates.html. |
Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item. When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .InternationalShippingServiceOption .ShippingServicePriority |
int | Conditionally |
This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified. If this field is omitted from international shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .InternationalShippingServiceOption .ShipToLocation |
string | Conditionally,
repeatable: [0..*] |
An international location or region to where the item seller will ship the item. Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. For the AddItem family of calls, this field is required if any international shipping service is specified. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, ShipToLocation fields will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, ShipToLocation fields are only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Shipping information. Applicable values: See CountryCodeType, ShippingRegionCodeType |
Item.ShippingDetails .PromotionalShippingDiscount |
boolean | Conditionally |
On input, this specifies whether to offer the promotional shipping discount for the domestic shipping services of this listing (only applicable if the seller has a promotional shipping discount in effect at the moment). Returned on output only if the seller is making the call. This indicates whether the promotional shipping discount is being offered for the domestic shipping services of this listing (if the listing is still active—this is only possible if the seller has a promotional shipping discount in effect at the moment) or whether the discount was offered at the time the listing ended. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .PromotionalShippingDiscountDetails |
PromotionalShippingDiscountDetailsType | Conditionally |
This value is returned only if the seller is making the call. Contains details of the promotional shipping discount, if such is being offered while the listing is active or if it was offered at the time the listing ended.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .PromotionalShippingDiscountDetails .DiscountName |
DiscountNameCodeType | Conditionally |
The type of promotional shipping discount that is detailed in the profile. If the discount type is MaximumShippingCostPerOrder , see ShippingCost. If the discount type is ShippingCostXForAmountY , see ShippingCost and OrderAmount. If the discount type is ShippingCostXForItemCountN , see ShippingCost and ItemCount.
Applicable values: (Not all values in DiscountNameCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .PromotionalShippingDiscountDetails .ItemCount |
int | Conditionally |
This is the number of items when DiscountName is set to ShippingCostXForItemsY .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .PromotionalShippingDiscountDetails .OrderAmount |
AmountType (double) | Conditionally |
This is the cost Y of the order (not including shipping cost) when DiscountName is set to ShippingCostXForAmountY .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .PromotionalShippingDiscountDetails .OrderAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This is the cost Y of the order (not including shipping cost) when DiscountName is set to ShippingCostXForAmountY .For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .PromotionalShippingDiscountDetails .ShippingCost |
AmountType (double) | Conditionally |
This is shipping cost X when DiscountName is either ShippingCostXForAmountY or ShippingCostXForItemCountN , and is the maximum cost when DiscountName is MaximumShippingCostPerOrder .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .PromotionalShippingDiscountDetails .ShippingCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This is shipping cost X when DiscountName is either ShippingCostXForAmountY or ShippingCostXForItemCountN , and is the maximum cost when DiscountName is MaximumShippingCostPerOrder .For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .RateTableDetails |
RateTableDetailsType | Conditionally |
This container is used to reference and apply a seller's domestic and/or international shipping rate tables to a listing. Shipping rate tables allow sellers to configure specific shipping costs based on the shipping destinations and level of service (e.g. economy, standard, expedited, and one-day). Generally speaking, sellers want to use these shipping rate tables so they can charge a higher shipping cost to the buyer whenever shipping costs are higher for them as well. For example, shipping to Alaska or Hawaii is generally more expensive than shipping to any other of the 48 US states, or in regards to international shipping, shipping to some regions and countries are more expensive than others. Sellers configure domestic and international shipping rate tables in My eBay Shipping Preferences. To apply shipping rate tables to a listing, the shipping cost type must be flat-rate. For domestic shipping rate tables, the three supported domestic regions are Alaska & Hawaii, US Protectorates (e.g. Puerto Rico and Guam), and APO/FPO destinations, which are US military bases/locations outside of the continental US. In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package, or they can add a surcharge instead. To determine if a domestic shipping rate table is set up for the seller's account, the GetUser call can be used, and then the seller will look for a value of true in the User.SellerInfo.DomesticRateTable field. Although the GetUser call can be used to see if a domestic shipping rate table exists for the seller's account, details of the shipping rate table, including all specified costs for the different regions, can only be viewed and modified in My eBay Shipping Preferences. This functionality is not yet available in any public APIs. For international shipping rate tables, specific rates may be set up for any and all of the nine geographical regions and individual countries within those regions. Similar to domestic shipping rate tables, the seller has the option of adding an extra charge based on the weight of the shipping package. Sellers cannot add a surcharge for international shipping. To determine if a international shipping rate table is set up for the seller's account, the GetUser call can be used, and then the seller will look for a value of true in the User.SellerInfo.InternationalRateTable field. Although the GetUser call can be used to see if an international shipping rate table exists for the seller's account, details of the shipping rate table, including all specified costs for the different regions/countries, can only be viewed and modified in My eBay Shipping Preferences. This functionality is not yet available in any public APIs. If you are applying a domestic or international shipping rate table that specifies a surcharge by weight, you must specify the item weight in the ShippingPackageDetails container's WeightMajor and WeightMinor fields, even though the listing is using flat-rate shipping. Do not use any other fields in the ShippingPackageDetails container because none of those fields are applicable in this use case. This container is only returned in the 'Get' calls if one or more shipping rate tables have been applied to the listing, and if the call is being made by the seller who listed the item. Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Whether a seller is using the old default domestic and international shipping rate tables or the new shipping rate tables, these shipping rate tables are set up in My eBay Shipping Preferences or as part of a Shipping Business Policy. If using the Trading API to create a listing that will use the new shipping rate tables, the DomesticRateTableId and InternationalRateTableId fields are used to reference and apply these new shipping rate tables to the listing. If desired, sellers can still use the old default shipping rate tables, but they are not allowed to mix and match old and new shipping rate tables, meaning that they will get an error if they pass in both the old fields (DomesticRateTable and InternationalRateTable) and the new fields (DomesticRateTableId and InternationalRateTableId). The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Shipping rate tables for more information on using shipping rate tables.. |
Item.ShippingDetails .RateTableDetails .DomesticRateTable |
string | Conditionally |
This field is used in an Add/Revise/Relist/Verify call to apply the domestic shipping rate table to the listing. In all cases, sellers pass in a string value of Default to apply the domestic shipping rate table. The shipping rates and/or surcharges set up in the domestic shipping rate table will only be applicable based on the location of the buyer, and if that shipping service level is covered in one of the specified shipping service options in the listing. Basically, domestic shipping costs and surcharges are set in one or more ShippingServiceOptions containers in the listing, and based on the settings and costs in the domestic shipping rate table, these shipping costs and/or surcharges may be overridden based on the buyer's location. For example, if the buyer lives in Alaska, and the domestic shipping rate table has one or more shipping rates set up for the Alaska & Hawaii domestic region, the buyer will see these rates in the View Item page and not the rates/costs that are defined in the ShippingServiceOptions containers. If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <DomesticRateTable /> This field is returned in the 'Get' calls if a domestic rate table is being applied to the listing, and it is only returned for the seller who listed the item. Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. Currently, for sites other than the ones stated, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).Max length: 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Shipping rate tables for more information on using shipping rate tables.. |
Item.ShippingDetails .RateTableDetails .DomesticRateTableId |
string | Conditionally |
Note: This field is only available for sellers on the US, Australia, Canada (English and French), Italy, UK, and Germany sites. The unique shipping rate identifiers that will be passed into this field can be retrieved using the getRateTables call of the Account API, or these identifiers can be viewed in the displayed URL when the seller selects a specific shipping rate table in the Shipping rate tables UI in My eBay. This field is included in an Add/Revise/Relist/Verify call if the seller wants to apply a customized domestic shipping rate table to the listing. The string value that is supplied in this field is the unique identifier of the shipping rate table. If the DomesticRateTableId field is used, the seller must make sure that the DomesticRateTable and InternationalRateTable fields are not used, as the old and new rate tables cannot be used together or an error will occur. In domestic shipping rate tables, sellers customize the flat-rate cost of shipping based on shipping destination (region/state/province) and shipping service level (one-day, expedited, standard, economy in US). In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package, or they can add a surcharge instead. If the seller is using the Revise or Relist call, they must include the DomesticRateTableId field or the domestic shipping rate table currently being applied to the listing will be unassociated from the listing. If they want to continue using the same domestic shipping rate table, the seller will pass in this identifier. The seller can also change the domestic shipping rate table by passing in the identifier for a different domestic shipping rate table. If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <DomesticRateTableId /> This field is returned in the 'Get' calls if a customized domestic rate table is being applied to the listing, and it is only returned for the seller who listed the item. Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).Max length: 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .RateTableDetails .InternationalRateTable |
string | Conditionally |
This field is used in an Add/Revise/Relist/Verify call to apply the international shipping rate table to the listing. International shipping rate tables can be used only for items listed on the eBay US, UK, and DE sites. In all cases, sellers pass in a string value of Default to apply the international shipping rate table. The shipping rates set up in the international shipping rate table will only be applicable based on the location of the buyer, and if that shipping service level is covered in one of the specified international shipping service options in the listing. Basically, international shipping costs are set in one or more InternationalShippingServiceOption containers in the listing, and based on the settings and costs in the international shipping rate table, these shipping costs may be overridden based on the buyer's location. For example, if the buyer lives in Argentina, and the international shipping rate table has one or more shipping rates set up for the country of Argentina, the buyer will see these rates in the View Item page and not the rates/costs that are defined in the InternationalShippingServiceOption containers. If a seller is revising or relisting an item, the international shipping rate table can be unassociated from the listing by using the empty tag: <InternationalRateTable /> This field is returned in the 'Get' calls if an international rate table is being applied to the listing, and it is only returned for the seller who listed the item. Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. Currently, for sites other than the ones stated, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).Max length: 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Shipping rate tables for more information on using shipping rate tables.. |
Item.ShippingDetails .RateTableDetails .InternationalRateTableId |
string | Conditionally |
Note: This field is only available to sellers on the US, Australia, Canada (English and French), Italy, UK, and Germany sites. The unique shipping rate identifiers that will be passed into this field can be retrieved using the getRateTables call of the Account API, or these identifiers can be viewed in the displayed URL when the seller selects a specific shipping rate table in the Shipping rate tables UI in My eBay. This field is included in an Add/Revise/Relist/Verify call if the seller wants to apply a customized international shipping rate table to the listing. The string value that is supplied in this field is the unique identifier of the shipping rate table. If the InternationalRateTableId field is used, the seller must make sure that the DomesticRateTable and InternationalRateTable fields are not used, as the old and new rate tables cannot be used together or an error will occur. In international shipping rate tables, sellers customize the flat-rate cost of shipping based on shipping destination (continent/region/country) and shipping service level (expedited, standard, economy in US). In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package. Unlike domestic shipping, sellers cannot add a surcharge for international shipping. If the seller is using the Revise or Relist call, they must include the InternationalRateTableId field or the international shipping rate table currently being applied to the listing will be unassociated from the listing. If they want to continue using the same international shipping rate table, the seller will pass in this identifier. The seller can also change the international shipping rate table by passing in the identifier for a different international shipping rate table. If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <InternationalRateTableId /> This field is returned in the 'Get' calls if a customized international rate table is being applied to the listing, and it is only returned for the seller who listed the item. Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US, Australia, Canada (English and French), Italy, UK, and Germany sites. For other sites, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).Max length: 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails.SalesTax | SalesTaxType | Conditionally |
This container shows sales tax information for an item in a specific tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites. This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the SetTaxTable call). A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to true . The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions. This container is only returned in order management 'Get' calls if sales tax is applicable to the order line item. For eBay Collect and Remit states, the sales tax information is displayed in the Transaction.Taxes container instead. Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process. Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails.SalesTax .SalesTaxPercent |
float | Conditionally |
This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call. Although this field will be returned at the order level in order management calls for a single line item order, sales tax is applied at the line item level and not order level. For multiple line item orders, this field will not be returned at all at the order level. Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process. Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails.SalesTax .SalesTaxState |
string | Conditionally |
This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all two-digit identifiers for all states/territories/provinces for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll , or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction . Please note that both GetTaxTable and GeteBayDetails calls use a JurisdictionID field to express these tax jurisdiction identifiers instead of SalesTaxState, but the values used in these fields are the same. The SalesTaxState field is conditionally required in an Add/Revise/Relist/Verify call if the seller is applying sales tax to a listing for a particular jurisdiction, and is returned with each SalesTax container to identify the tax jurisdiction. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails.SalesTax .ShippingIncludedInTax |
boolean | Conditionally |
This field is included in an Add/Revise/Relist/Verify call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified. This field is always returned with the SalesTax container (whether true or false ). Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process. Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .SellerExcludeShipToLocationsPreference |
boolean | Conditionally |
Sellers can set up a global Exclude Ship-To List through their My eBay account. The Exclude Ship-To List defines the countries to where the seller does not ship, by default. This flag returns true if the Exclude Ship-To List is enabled by the seller for the associated item. If false , the seller's Exclude Ship-To List is either not set up, or it has been overridden by the seller when they listed the item with ExcludeShipToLocation fields. In the response, ExcludeShipToLocation fields detail the locations to where the seller will not ship the item, regardless of the value returned in this field. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .ShippingDiscountProfileID |
string | Conditionally |
On input, this is the ID of the shipping discount to offer for the domestic shipping services (where the shipping discount is either of type FlatShippingDiscount or CalculatedShippingDiscount). On output, this is the ID of the shipping discount offered and corresponds to whichever is returned: FlatShippingDiscount or CalculatedShippingDiscount. Only returned if the calling user is the seller. If the user created a shipping discount profile, use the ShippingDiscountProfileID. In the RelistItem and ReviseItem family of calls, you can remove the existing ShippingDiscountProfileID associated with the item by supplying a value of 0 (zero). Only returned if the calling user is the seller. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Always,
repeatable: [1..*] |
This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
Item.ShippingDetails .ShippingServiceOptions .ExpeditedService |
boolean | Conditionally |
This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .ShippingServiceOptions .FreeShipping |
boolean | Conditionally |
This boolean field indicates whether or not the corresponding domestic shipping service option is free to the buyer. In an Add/Revise/Relist call, free shipping can only be offered for the first specified shipping service (so, the corresponding ShippingServicePriority value should be 1 or included first in the call request). If 'free shipping' is for any other shipping service, this field is ignored. For 'Get' calls, including GetItem, this field is only returned if 1 . Note: If a seller is specifying a shipping service option as 'free shipping', in addition to this FreeShipping boolean field, the seller will also need to include the corresponding ShippingServiceCost field and set its value to 0.0 , as eBay will not do this automatically. Note: If the condition is certified refurbished (ConditionID set to 2000 , 'Certified - Refurbished'), you must offer a free shipping option. Set FreeShipping as true (or 1 ) along with the ShippingServiceCost as 0.0 for the first domestic shipping service.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Free shipping. |
Item.ShippingDetails .ShippingServiceOptions .ShippingService |
token | Conditionally |
This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails . The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards, and to coins & paper money, postcards, stamps, patches, and similar eligible categories, and is only available on the US marketplace. See eBay standard envelope for details, restrictions, and an envelope size template. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope . For the REST equivalent, see Using the eBay standard envelope (eSE) service. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
Item.ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0 , as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup , ShippingServiceCost must be set to 0.0 . Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0 , as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup , ShippingServiceCost must be set to 0.0 . Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
Item.ShippingDetails .ShippingServiceOptions .ShippingServicePriority |
int | Conditionally |
Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options. If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .ShippingServiceOptions .ShippingTimeMax |
int | Conditionally |
The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer. This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .ShippingServiceOptions .ShippingTimeMin |
int | Conditionally |
The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer. This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .ShippingType |
ShippingTypeCodeType | Conditionally |
The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these. GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.
Applicable values: See ShippingType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails.TaxTable | TaxTableType | Conditionally |
Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned. For GetItem, a tax table is returned if it exists when:
DetailLevel: ItemReturnDescription, ReturnAll. |
Item.ShippingDetails.TaxTable .TaxJurisdiction |
TaxJurisdictionType | Conditionally,
repeatable: [0..*] |
In a SetTaxTable, a TaxJurisdiction container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states, provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a TaxJurisdiction container will override any existing values defined in the seller's Sales Tax Table. If GetTaxTable is called without the DetailLevel field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the DetailLevel field is included in the request and set to ReturnAll , all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions. This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item. Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process. Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails.TaxTable .TaxJurisdiction .JurisdictionID |
string | Conditionally |
This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all JurisdictionID values for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll , or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction . The JurisdictionID field is always required in a SetTaxTable call, and always returned with each TaxJurisdiction container to identify the tax jurisdiction. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails.TaxTable .TaxJurisdiction .SalesTaxPercent |
float | Conditionally |
This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). This field is only returned in GetTaxTable (and other 'Get' calls) if a sales tax percentage rate has been set. Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process. Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails.TaxTable .TaxJurisdiction .ShippingIncludedInTax |
boolean | Conditionally |
This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified. This field is always returned with each TaxJurisdiction container (whether true or false ). Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process. Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI). DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingDetails .ThirdPartyCheckout |
boolean | Always |
Note: This field is deprecated and will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingPackageDetails | ShipPackageDetailsType | Conditionally |
Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the Get calls if specified for the item. Note: For ReviseItem and ReviseFixedPriceItem calls: For flat-rate shipping, if any of the ShippingPackageDetails fields are defined for the current listing, those fields must be included again in the revise call even if their values are not changing. If you do not do this, some/all of the fields under this container may be removed from the listing. To find out the values included in the current listing, call GetItem and look through the ShippingPackageDetails container in the response. Note: Package weight and dimensions are only supported for the following marketplaces: AU, CA, DE, IT, UK, US, and Motors. If this information is provided on other marketplaces, it will be ignored. |
Item.ShippingPackageDetails .PackageDepth |
MeasureType (decimal) | Conditionally |
Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs. Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingPackageDetails .PackageDepth [ attribute unit ] |
token | Conditionally |
Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs. Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. |
Item.ShippingPackageDetails .PackageDepth [ attribute measurementSystem ] |
MeasurementSystemCodeType | Conditionally |
Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs. Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. For a list of possible enumeration values, see MeasurementSystemCodeType. |
Item.ShippingPackageDetails .PackageLength |
MeasureType (decimal) | Conditionally |
Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingPackageDetails .PackageLength [ attribute unit ] |
token | Conditionally |
Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. |
Item.ShippingPackageDetails .PackageLength [ attribute measurementSystem ] |
MeasurementSystemCodeType | Conditionally |
Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. For a list of possible enumeration values, see MeasurementSystemCodeType. |
Item.ShippingPackageDetails .PackageWidth |
MeasureType (decimal) | Conditionally |
Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingPackageDetails .PackageWidth [ attribute unit ] |
token | Conditionally |
Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. |
Item.ShippingPackageDetails .PackageWidth [ attribute measurementSystem ] |
MeasurementSystemCodeType | Conditionally |
Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. For a list of possible enumeration values, see MeasurementSystemCodeType. |
Item.ShippingPackageDetails .ShippingIrregular |
boolean | Conditionally |
Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingPackageDetails .ShippingPackage |
ShippingPackageCodeType | Conditionally |
The nature of the package used to ship the item(s). Required for calculated shipping only.
Applicable values: See ShippingPackage. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingPackageDetails .WeightMajor |
MeasureType (decimal) | Conditionally |
WeightMajor and WeightMinor are used to specify the weight of a shipping package. WeightMajor is used to specify the weight of the package in pounds (in US) or kilograms (all countries that use metric system). Although MeasureType is of decimal type, decimal values should not be used in WeightMajor and WeightMinor. If a shipping package was 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr: <WeightMajor unit="lbs">5</WeightMajor> If a package weighed 14 oz or 324 gr, below is how you would represent this weight: <WeightMajor unit="lbs">0</WeightMajor> If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight: <WeightMajor unit="lbs">2</WeightMajor> In all cases, both the WeightMajor and WeightMinor should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'. The WeightMajor and WeightMinor are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingPackageDetails .WeightMajor [ attribute unit ] |
token | Conditionally |
WeightMajor and WeightMinor are used to specify the weight of a shipping package. WeightMajor is used to specify the weight of the package in pounds (in US) or kilograms (all countries that use metric system). Although MeasureType is of decimal type, decimal values should not be used in WeightMajor and WeightMinor. If a shipping package was 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr: <WeightMajor unit="lbs">5</WeightMajor> If a package weighed 14 oz or 324 gr, below is how you would represent this weight: <WeightMajor unit="lbs">0</WeightMajor> If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight: <WeightMajor unit="lbs">2</WeightMajor> In all cases, both the WeightMajor and WeightMinor should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'. The WeightMajor and WeightMinor are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. |
Item.ShippingPackageDetails .WeightMajor [ attribute measurementSystem ] |
MeasurementSystemCodeType | Conditionally |
WeightMajor and WeightMinor are used to specify the weight of a shipping package. WeightMajor is used to specify the weight of the package in pounds (in US) or kilograms (all countries that use metric system). Although MeasureType is of decimal type, decimal values should not be used in WeightMajor and WeightMinor. If a shipping package was 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr: <WeightMajor unit="lbs">5</WeightMajor> If a package weighed 14 oz or 324 gr, below is how you would represent this weight: <WeightMajor unit="lbs">0</WeightMajor> If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight: <WeightMajor unit="lbs">2</WeightMajor> In all cases, both the WeightMajor and WeightMinor should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'. The WeightMajor and WeightMinor are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. For a list of possible enumeration values, see MeasurementSystemCodeType. |
Item.ShippingPackageDetails .WeightMinor |
MeasureType (decimal) | Conditionally |
WeightMajor and WeightMinor are used to specify the weight of a shipping package. WeightMinor is used to specify the weight of the package in ounces (in US) or grams (all countries that use metric system). Although MeasureType is of decimal type, decimal values should not be used in WeightMajor and WeightMinor. If a shipping package was 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr: <WeightMajor unit="lbs">5</WeightMajor> If a package weighed 14 oz or 324 gr, below is how you would represent this weight: <WeightMajor unit="lbs">0</WeightMajor> If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight: <WeightMajor unit="lbs">2</WeightMajor> In all cases, both the WeightMajor and WeightMinor should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'. The WeightMajor and WeightMinor are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. Min: 0. Max: 15 for ounces; 999 for grams. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.ShippingPackageDetails .WeightMinor [ attribute unit ] |
token | Conditionally |
WeightMajor and WeightMinor are used to specify the weight of a shipping package. WeightMinor is used to specify the weight of the package in ounces (in US) or grams (all countries that use metric system). Although MeasureType is of decimal type, decimal values should not be used in WeightMajor and WeightMinor. If a shipping package was 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr: <WeightMajor unit="lbs">5</WeightMajor> If a package weighed 14 oz or 324 gr, below is how you would represent this weight: <WeightMajor unit="lbs">0</WeightMajor> If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight: <WeightMajor unit="lbs">2</WeightMajor> In all cases, both the WeightMajor and WeightMinor should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'. The WeightMajor and WeightMinor are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. |
Item.ShippingPackageDetails .WeightMinor [ attribute measurementSystem ] |
MeasurementSystemCodeType | Conditionally |
WeightMajor and WeightMinor are used to specify the weight of a shipping package. WeightMinor is used to specify the weight of the package in ounces (in US) or grams (all countries that use metric system). Although MeasureType is of decimal type, decimal values should not be used in WeightMajor and WeightMinor. If a shipping package was 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr: <WeightMajor unit="lbs">5</WeightMajor> If a package weighed 14 oz or 324 gr, below is how you would represent this weight: <WeightMajor unit="lbs">0</WeightMajor> If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight: <WeightMajor unit="lbs">2</WeightMajor> In all cases, both the WeightMajor and WeightMinor should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'. The WeightMajor and WeightMinor are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Note: The unit and measurementSystem attributes associated with this field will be returned by the GetItem call and are automatically derived based on the MeasurementUnit value specified during listing creation or revision. These attributes will be ignored if passed into the request of the AddItem family of calls. For a list of possible enumeration values, see MeasurementSystemCodeType. |
Item .ShippingServiceCostOverrideList |
ShippingServiceCostOverrideListType | Conditionally |
This container is used when the seller wants to override the flat shipping costs for all domestic and/or all international shipping services defined in the shipping business policy referenced in the SellerProfiles.SellerShippingProfile.ShippingProfileID field. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services. A ShippingServiceCostOverrideList.ShippingServiceCostOverride container is required for each domestic and/or international shipping service that is defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the shipping business policy. Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each ShippingServiceCostOverrideList.ShippingServiceCostOverride container will not change the shipping costs defined for the same shipping services in the shipping business policy. For Revise and Relist calls: To delete all shipping service cost overrides when you revise or relist, specify Item.ShippingServiceCostOverrideList in DeletedField, and don't pass ShippingServiceCostOverrideList in the request. |
Item .ShippingServiceCostOverrideList .ShippingServiceCostOverride |
ShippingServiceCostOverrideType | Conditionally,
repeatable: [0..*] |
A ShippingServiceCostOverride container is required for each domestic and/or international shipping service option, defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the Business Policies shipping profile, that the seller wishes to override the shipping costs. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services. Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each ShippingServiceCostOverride container will not change the shipping costs defined for the same shipping service options in the Business Policies shipping profile. To override the shipping costs for any domestic shipping service option in the Business Policies shipping profile, the ShippingServiceType field should be set to 'Domestic', and to override the shipping costs for any international shipping service option, the ShippingServiceType field should be set to 'International'. For both domestic and international shipping services, the ShippingServicePriority value should match the sortOrderId value for the matching shipping service in the shipping profile. If any of the domestic and/or international shipping service priorities and shipping service options in the Add/Revise/Relist call and Business Policies shipping profile do not match, an error occurs. If shipping service cost overrides are used in a listing, the ShippingServiceCostOverride container will be returned in the GetItem, and GetSellerList calls. |
Item .ShippingServiceCostOverrideList .ShippingServiceCostOverride .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
This dollar value indicates the cost to ship each additional identical item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceAdditionalCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile. This field is only applicable to multi-quantity, fixed-price listings. |
Item .ShippingServiceCostOverrideList .ShippingServiceCostOverride .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This dollar value indicates the cost to ship each additional identical item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceAdditionalCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile. This field is only applicable to multi-quantity, fixed-price listings. For a list of possible enumeration values, see CurrencyCodeType. |
Item .ShippingServiceCostOverrideList .ShippingServiceCostOverride .ShippingServiceCost |
AmountType (double) | Conditionally | This dollar value indicates the shipping service cost to ship one item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile. |
Item .ShippingServiceCostOverrideList .ShippingServiceCostOverride .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This dollar value indicates the shipping service cost to ship one item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile. For a list of possible enumeration values, see CurrencyCodeType. |
Item .ShippingServiceCostOverrideList .ShippingServiceCostOverride .ShippingServicePriority |
int | Conditionally |
This integer value maps the particular instance of the ShippingServiceCostOverride container to the domesticShippingPolicyInfoService or intlShippingPolicyInfoService container of the Business Policies shipping profile. The ShippingServicePriority value should match the sortOrderId value for the matching shipping service in the Business Policies shipping profile. If overriding the shipping costs for a domestic shipping service, the ShippingServiceType field should be set to 'Domestic', and to override the shipping costs for an international shipping service, the ShippingServiceType field should be set to 'International'. If any of the domestic and/or international shipping service priorities and shipping service options in the Add/Revise/Relist call and Business Policies shipping profile do not match, an error occurs. |
Item .ShippingServiceCostOverrideList .ShippingServiceCostOverride .ShippingServiceType |
ShippingServiceType | Conditionally |
This enumerated value indicates whether the shipping costs of a domestic or an international shipping costs are being overridden. To override the shipping costs for any domestic shipping service in the Business Policies shipping profile, this field should be set to 'Domestic', and to override the shipping costs for any international shipping service, this field should be set to 'International'.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Item.ShipToLocations | string | Always,
repeatable: [1..*] |
An international location or region to which the seller is willing to ship, regardless of shipping service. The country of the listing site is added by eBay. Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, the ShipToLocations field should not be used in the request. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container. Use GeteBayDetails with a DetailName of ShippingLocationDetails to determine which international locations are valid for the site. Omit ShipToLocations if you want to ship only within the country of the listing site. To state that you do not wish to ship at all, set ShipToLocations to None . ReviseItem can add a ShipToLocations. On output, ShipToLocations is the collection of all input item-level ShipToLocations plus international shipping service-level ShipToLocation values. Note: The ShipToLocations and ShippingDetails.ExcludeShipToLocation containers are not applicable for motor vehicle listings on the US, CA, or UK marketplaces. If these containers are sent in the request, they are ignored and a warning is returned. If you have specified a region to which you will ship (such as Asia), you can use ExcludeShipToLocation to exclude certain countries within that region to where you will not ship (such as Afghanistan). Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
Applicable values: See CountryCodeType, ShippingRegionCodeType |
Item.Site | SiteCodeType | Always |
The name of the eBay listing site. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing. When you specify Item.Site in AddItem or AddFixedPriceItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY-API-SITEID header (for the XML API). Applicable values: See Site. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SKU | SKUType (string) | Conditionally |
A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU . Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.) If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request. Note: The eBay site cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing. Max length: 50. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
Item.StartPrice | AmountType (double) | Always |
The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items—it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items—it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. For a list of possible enumeration values, see CurrencyCodeType. |
Item.Storefront | StorefrontType | Conditionally |
This container provides details about the seller's eBay store. In an Add/Revise/Relist call, the seller can include this container to set/change which customized eBay store category that the item will be placed in. For 'Get' calls, this container is returned if the seller of the item has an eBay store. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Storefront .StoreCategory2ID |
long | Conditionally |
Unique identifier for the secondary custom category in which to list the item. Set this field to a root-level custom category or a custom category that has no child categories (subcategories). The system resets the value to 0 (None) in the following cases: - The values of StoreCategoryID and StoreCategory2ID field are the same - You specify StoreCategory2ID but not StoreCategoryID In other words, StoreCategoryID must be set to a valid custom category and be different from StoreCategory2ID. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Storefront .StoreCategoryID |
long | Conditionally |
Unique identifier of a primary custom category in which to list the item. A custom category is a category that the seller created in their eBay Store. eBay Store sellers can create up to three levels of custom categories for their stores, but the API only supports root-level categories. To list an item using the categories in a seller's store, you must set this field to a root-level custom category or a custom category that has no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the 'Other' store category. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Storefront.StoreURL | anyURI | Conditionally |
The URL of the seller's eBay Stores page.
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.SubTitle | string | Conditionally |
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). When you revise a item, you can add, change, or remove the subtitle. Max length: 55. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
Item.TaxCategory | string | Conditionally |
Tax exception category code. This is to be used only by sellers who have opted into sales tax being calculated by a sales tax calculation vendor. If you are interested in becoming a tax calculation vendor partner with eBay, contact developer-relations@ebay.com.
DetailLevel: ReturnAll. |
Item.TimeLeft | duration | Always |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds).
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Title | string | Always |
This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours. Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold. Max length: 80. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.TopRatedListing | boolean | Conditionally |
This boolean field is returned as true if the listing was created by a Top-Rated Seller and the listing has all of the requirements that qualifies it as a Top-Rated Plus listing. The Top-Rated Seller program is only available on the US, UK, and Germany sites. See the Top-Rated Seller requirements help topic for more information on qualifying as a Top-Rated Seller and the Top-Rated Plus listing requirements help topic for more information on what a listing must offer to qualify as a Top-Rated Plus listing and get the Top-Rated Plus badge. Information on the overall program can be found on the Top-Rated Seller home page in the Seller Center.
|
Item.UnitInfo | UnitInfoType | Conditionally |
This container provides information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the UnitType and UnitQuantity values and the item's listed price to calculate and display the per-unit price on eBay EU sites. This container will only be returned if price per unit information exists for the listing, and the IncludeItemSpecifics field was included in the call request and set to true .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.UnitInfo.UnitQuantity | double | Conditionally |
Number of units of size, weight, volume or count of the specified unit type for the item. eBay divides the item price by this number to get the price per unit to be displayed in the item listing for comparison purposes. With GetItem, this field is returned only when you provide IncludeItemSpecifics in the request and set it to true .
|
Item.UnitInfo.UnitType | string | Conditionally |
Designation of size, weight, volume or count to be used to specify the unit quantity of the item. This value can be one of the following: Kg 100g 10g L 100ml 10ml M M2 M3 UnitWith GetItem, this field is returned only when you provide IncludeItemSpecifics in the request and set it to true .
|
Item.UUID | UUIDType (string) | Conditionally |
Use an UUID value to ensure that you only list (or relist) a particular item once. This field can be particularly useful if you are listing many items on a daily basis and/or many items at once with an AddItems call. If your call request does not generate a response, or if you get one or more (blocking) errors, be sure to use the same UUID value when you attempt to list or relist the same item with another call request. If you pass in a UUID value that has already been used to successfully create or relist an item, you will receive an error message that includes the Item ID for that listing and a boolean value indicating whether the duplicate UUID was sent by the same application. We recommend that you use the Item.UUID field for add and relist calls (for example, AddItem and RelistItem), but use the Item.InvocationID field instead when using a revise call. The UUID can only contain digits from 0-9 and letters from A-F and must be 32 characters long. The UUID value must be unique across all of the seller's eBay across all eBay marketplaces. Max length: 32. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Variations | VariationsType | Conditionally |
Variations are similar (but not identical) items in a multiple-variation, fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.) If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories. 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 purchases, 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.) For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request. Note: This container will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Variations.Pictures | PicturesType | Conditionally |
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. Variation, Pictures, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests 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. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Variations.Pictures .VariationSpecificName |
string | Conditionally |
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 VariationSpecifics container. This field is required in each Item.Variations.Pictures container that is used. Max length: 40. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Variations.Pictures .VariationSpecificPictureSet |
VariationSpecificPictureSetType | Conditionally,
repeatable: [0..*] |
A container consisting of one or more picture URLs associated with a variation specific value (e.g., color=blue). 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. A variation specific picture set can consist of up to 12 images hosted by eBay Picture Services (EPS) or self-hosted (hosted outside of eBay) pictures. The eBay Picture Services and self-hosted images can never be combined into the same variation specific picture set. 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. Note: All images must comply with the Picture Requirements. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Variations.Pictures .VariationSpecificPictureSet .ExtendedPictureDetails |
ExtendedPictureDetailsType | Conditionally | Returns the URLs of the seller's self-hosted (hosted outside of eBay) variation specific pictures and the URL for the corresponding eBay Picture Services (EPS), that was generated when the picture was uploaded. |
Item.Variations.Pictures .VariationSpecificPictureSet .ExtendedPictureDetails .PictureURLs |
PictureURLsType | Conditionally,
repeatable: [0..*] |
Deprecated as of version 1375. No longer returned. Use PictureDetails.ExternalPictureURL instead. The ExtendedPictureDetails container and its child fields are no longer returned under any circumstances, including when self-hosted pictures are used for the item. When self-hosted pictures are used by the seller, only the external URL of the gallery image is shown in the PictureDetails.ExternalPictureURL field, and only the equivalent eBay Picture Server (EPS) URLs are shown for the rest of the item's images in separate PictureDetails.PictureURL fields. Deprecation version: 1375. See also Deprecated Objects. |
Item.Variations.Pictures .VariationSpecificPictureSet .ExtendedPictureDetails .PictureURLs.eBayPictureURL |
anyURI | Conditionally,
repeatable: [0..24] |
Deprecated as of version 1375. The ExtendedPictureDetails container and its child fields are no longer returned under any circumstances, including when self-hosted pictures are used for the item. When self-hosted pictures are used by the seller, only the external URL of the gallery image is shown in the PictureDetails.ExternalPictureURL field, and only the equivalent eBay Picture Server (EPS) URLs are shown for the rest of the item's images in separate PictureDetails.PictureURL fields. Max length: 150. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1375. See also Deprecated Objects. |
Item.Variations.Pictures .VariationSpecificPictureSet .ExtendedPictureDetails .PictureURLs .ExternalPictureURL |
anyURI | Conditionally |
Deprecated as of version 1375. The ExtendedPictureDetails container and its child fields are no longer returned under any circumstances, including when self-hosted pictures are used for the item. When self-hosted pictures are used by the seller, only the external URL of the gallery image is shown in the PictureDetails.ExternalPictureURL field, and only the equivalent eBay Picture Server (EPS) URLs are shown for the rest of the item's images in separate PictureDetails.PictureURL fields. Max length: 150. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1375. See also Deprecated Objects. |
Item.Variations.Pictures .VariationSpecificPictureSet .ExternalPictureURL |
anyURI | Conditionally,
repeatable: [0..*] |
Returns the URL of a variation-specific picture that is hosted outside of eBay. When you list, revise, or relist a variation, use VariationSpecificPictureSet.PictureURL (not ExternalPictureURL) to specify your self-hosted picture or EPS picture. Note: All images must comply to the Picture Requirements. This is returned only when the seller used a self-hosted picture for the variation. Max length: 150. outputSelector: Variations. See Picture hosting. |
Item.Variations.Pictures .VariationSpecificPictureSet .PictureURL |
anyURI | Conditionally,
repeatable: [0..*] |
The URL of a picture that is associated with the VariationSpecificValue. A variation specific picture set can consist of up to 12 self-hosted or eBay Picture Services (EPS) hosted pictures. eBay Picture Services and self-hosted images can never be combined into the same variation specific picture set. To specify more than one image, use multiple PictureURL fields, passing in a distinct URL in each of those fields. This field cannot have an empty/null value. The UploadSiteHostedPictures call can be used to upload pictures to EPS. Note that if pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. The image specified in the first PictureURL field is also used as the thumbnail image 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 thumbnail image for all the red shirt variations. Note: Up to 12 pictures may be specified for one variation within a multiple-variation listing. Note: All images, whether they are hosted by EPS or self-hosted, must comply with eBay picture requirements, including the requirement that all images must be at least 500 pixels on its longest side. If the image does not satisfy the 500 pixels requirement, the listing may be blocked. For more information about other requirements and tips for adding pictures to listings, see the Adding pictures to your listings help page. 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. Note: If a URL contains spaces, those spaces can be replaced with %20 . For example, https://example.com/my image.jpg must be submitted as https://example.com/my%20image.jpg to replace the space in the image file name. However, a semicolon character (;) cannot be replaced with %20 , so a semicolon cannot be a part of the URL, as an error will occur. Variation pictures cannot be added or removed from a fixed-price listing when the listing is scheduled to end within 12 hours or if the item variation has already had transactions. Note: For some large merchants, there are no limitations on when variation pictures can be added or removed from a fixed-price listing, even when the item variation has had transactions or is set to end within 12 hours. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Variations.Pictures .VariationSpecificPictureSet .VariationSpecificValue |
string | Conditionally |
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 .
DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Variations.Variation | VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one item variation from another. For example, if an item varies 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 item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call. When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0 . Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Variations.Variation .DiscountPriceInfo |
DiscountPriceInfoType | Conditionally |
This container provides information for a single variation (within a multiple-variation listing) that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. For a multiple-variation listing, the discount pricing information should be set at the variation level and not at the item level (e.g. Item.DiscountPriceInfo). STP and MAP apply only to fixed-price listings. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, Spain, and Ireland sites, while MAP is available only on the US site. Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a 'special account flag' (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. STP is intended for eBay partners and their sellers only. As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Discount pricing. |
Item.Variations.Variation .DiscountPriceInfo .MadeForOutletComparisonPrice |
AmountType (double) | Conditionally |
Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet). The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet. In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.) DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
Item.Variations.Variation .DiscountPriceInfo .MadeForOutletComparisonPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet). The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet. In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.) For a list of possible enumeration values, see CurrencyCodeType. |