Trading API879

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:

Related Information

See:
    Retrieving Items
    Introduction to Pictures in Item Listings

See also the reference documentation for these calls:



Back to top

GetItem Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <IncludeCrossPromotion> boolean </IncludeCrossPromotion>
  <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]
IncludeCrossPromotion boolean Optional This flag should no longer be used as eBay Store Cross Promotions are no longer supported by the Trading API.

Specifies whether or not to include cross-promotion information for the item in the call response.
IncludeItemCompatibilityList boolean Optional This field is used to specify whether to retrieve Parts Compatiblity information. If true, any compatible applications associated with the item will be returned in the response ( Item.ItemCompatibilityList). If no compatible applications have been specified for the item, no item compatibilities will be returned.

If false or not specified, the response will return a compatibility count (ItemCompatibilityCount) when parts compatibilities have been specified for the item.

Parts Compatibility is supported in limited Parts & Accessories categories, for the eBay US Motors (100), UK (3), AU (15) and DE (77) sites only.
Default: false.

See:
    ItemCompatibilityCount
    ItemCompatibilityList
    Listing Items with Parts Compatibility

IncludeItemSpecifics boolean Optional If true, the response returns the ItemSpecifics node (if the listing has custom Item Specifics).

Item Specifics are well-known aspects of items in a given category. For example, items in a washer and dryer category might have an aspect like Type=Top-Loading; whereas items in a jewelry category might have an aspect like Gemstone=Amber.

Including this field set to true also returns the UnitInfo node, which enables European Union sellers to provide the required price-per-unit information so buyers can accurately compare prices for certain types of products.

(This does not cause the response to include ID-based attributes. To also retrieve ID-based attributes, pass DetailLevel in the request with the value ItemReturnAttributes or ReturnAll.)

See Working with Custom Item Specifics.

IncludeTaxTable boolean Optional If true, an associated tax table is returned in the response. If no tax table is associated with the item, then no tax table is returned, even if IncludeTaxTable is set to true.
IncludeWatchCount boolean Optional Indicates if the caller wants to include watch count for that item in the response. You must be the seller of the item to retrieve the watch count.
ItemID ItemIDType (string) Conditional Specifies the ItemID that uniquely identifies the item listing for which to retrieve the data.

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.
Max length: 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits).
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 (transaction). 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.
Max length: 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.).
VariationSKU SKUType (string) Optional 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 Optional 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 varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.

When you list with Item Variations:
a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
b) Specify up to five VariationSpecifics in each Variation node.
c) Specify all applicable names with all their supported values in the VariationSpecificSet node.

See the Variation sample in the AddFixedPriceItem call reference for examples.

For PlaceOffer: Required if the item being purchased includes Item Variations.
VariationSpecifics
  .NameValueList.Name
string Optional A name in a name/value pair.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing.

For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations.

For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer").

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 40.
VariationSpecifics
  .NameValueList.Value
string Optional,
repeatable: [0..*]
A value associated with the name.

For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing.

For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available.

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 50.
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 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:

•   ItemReturnAttributes

(in) For GetItem, returns Item Specifics and Pre-filled Item Information, if any. For GetSearchResults, only returns Item Specifics (if any) that are applicable to search results, and only under certain conditions. See the description of Item.AttributeSetArray for details about the effects for applicable calls. Also see the description of Item.ProductListingDetails for GetItem.

•   ItemReturnDescription

(in) Returns Description, plus the ListingDesigner node and some additional information if applicable

•   ReturnAll

(in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.


(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. Specify the standard RFC 3066 language identification tag (e.g., en_US).

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

See Tags for the Identification of Languages.

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 fields you specified in the request. 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:

 ...
<OutputSelector>ViewItemURL</OutputSelector>
<OutputSelector>BuyItNowPrice</OutputSelector>

...

See Selecting Fields to Retrieve.

Version string Conditional The version number of the API code that you are programming against (e.g., 859). The version you specify for a call has these basic effects:
- It indicates the version of the code lists and other data that eBay should use to process your request.
- It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.

For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    Routing the Request (Gateway URLs)
    eBay Schema Versioning Strategy
    Lowest Supported Version

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

(in) Return warnings when the application passes unrecognized or deprecated elements in a request.

•   Low

(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.


See Warning Level.



Back to top

GetItem Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?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>
    <AttributeSetArray> AttributeSetArrayType </AttributeSetArray>
    <AutoPay> boolean </AutoPay>
    <BestOfferDetails> BestOfferDetailsType
      <BestOfferCount> int </BestOfferCount>
      <BestOfferEnabled> boolean </BestOfferEnabled>
      <NewBestOffer> boolean </NewBestOffer>
    </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
      <LinkedPayPalAccount> boolean </LinkedPayPalAccount>
      <MaximumBuyerPolicyViolations> MaximumBuyerPolicyViolationsType
        <Count> int </Count>
        <Period> PeriodCodeType </Period>
      </MaximumBuyerPolicyViolations>
      <MaximumItemRequirements> MaximumItemRequirementsType
        <MaximumItemCount> int </MaximumItemCount>
        <MinimumFeedbackScore> int </MinimumFeedbackScore>
      </MaximumItemRequirements>
      <MaximumUnpaidItemStrikesInfo> MaximumUnpaidItemStrikesInfoType
        <Count> int </Count>
        <Period> PeriodCodeType </Period>
      </MaximumUnpaidItemStrikesInfo>
      <MinimumFeedbackScore> int </MinimumFeedbackScore>
      <ShipToRegistrationCountry> boolean </ShipToRegistrationCountry>
      <VerifiedUserRequirements> VerifiedUserRequirementsType
        <MinimumFeedbackScore> int </MinimumFeedbackScore>
        <VerifiedUser> boolean </VerifiedUser>
      </VerifiedUserRequirements>
      <ZeroFeedbackScore> boolean </ZeroFeedbackScore>
    </BuyerRequirementDetails>
    <BuyerResponsibleForShipping> boolean </BuyerResponsibleForShipping>
    <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
    <Charity> CharityType
      <CharityID> string </CharityID>
      <CharityName> string </CharityName>
      <CharityNumber> int </CharityNumber>
      <DonationPercent> float </DonationPercent>
      <LogoURL> string </LogoURL>
      <Mission> string </Mission>
      <Status> CharityStatusCodeType </Status>
    </Charity>
    <ConditionDescription> string </ConditionDescription>
    <ConditionDisplayName> string </ConditionDisplayName>
    <ConditionID> int </ConditionID>
    <Country> CountryCodeType </Country>
    <CrossBorderTrade> string </CrossBorderTrade>
    <!-- ... more CrossBorderTrade values allowed here ... -->
    <CrossPromotion> CrossPromotionsType
      <ItemID> ItemIDType (string) </ItemID>
      <PrimaryScheme> PromotionSchemeCodeType </PrimaryScheme>
      <PromotedItem> PromotedItemType </PromotedItem>
      <!-- ... more PromotedItem nodes allowed here ... -->
      <PromotionMethod> PromotionMethodCodeType </PromotionMethod>
      <SellerID> string </SellerID>
      <ShippingDiscount> boolean </ShippingDiscount>
    </CrossPromotion>
    <Currency> CurrencyCodeType </Currency>
    <Description> string </Description>
    <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>
    <eBayNowAvailable> boolean </eBayNowAvailable>
    <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>
    <GetItFast> boolean </GetItFast>
    <GiftIcon> int </GiftIcon>
    <GiftServices> GiftServicesCodeType </GiftServices>
    <!-- ... more GiftServices values allowed here ... -->
    <HideFromSearch> boolean </HideFromSearch>
    <HitCount> long </HitCount>
    <HitCounter> HitCounterCodeType </HitCounter>
    <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
    <InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod>
    <IsIntermediatedShippingEligible> boolean </IsIntermediatedShippingEligible>
    <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>
    <ListingCheckoutRedirectPreference> ListingCheckoutRedirectPreferenceType
      <ProStoresStoreName> string </ProStoresStoreName>
      <SellerThirdPartyUsername> string </SellerThirdPartyUsername>
    </ListingCheckoutRedirectPreference>
    <ListingDesigner> ListingDesignerType
      <LayoutID> int </LayoutID>
      <OptimalPictureSize> boolean </OptimalPictureSize>
      <ThemeID> int </ThemeID>
    </ListingDesigner>
    <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>
      <TCROriginalItemID> ItemIDType (string) </TCROriginalItemID>
      <ViewItemURL> anyURI </ViewItemURL>
      <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
    </ListingDetails>
    <ListingDuration> token </ListingDuration>
    <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
    <!-- ... more ListingEnhancement values allowed here ... -->
    <ListingSubtype2> ListingSubtypeCodeType </ListingSubtype2>
    <ListingType> ListingTypeCodeType </ListingType>
    <LiveAuction> boolean </LiveAuction>
    <Location> string </Location>
    <LocationDefaulted> boolean </LocationDefaulted>
    <LotSize> int </LotSize>
    <MechanicalCheckAccepted> boolean </MechanicalCheckAccepted>
    <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
    <OutOfStockControl> boolean </OutOfStockControl>
    <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
      <ExternalPictureURL> anyURI </ExternalPictureURL>
      <GalleryDuration> token </GalleryDuration>
      <GalleryErrorInfo> string </GalleryErrorInfo>
      <GalleryStatus> GalleryStatusCodeType </GalleryStatus>
      <GalleryType> GalleryTypeCodeType </GalleryType>
      <GalleryURL> anyURI </GalleryURL>
      <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
      <PictureSource> PictureSourceCodeType </PictureSource>
      <PictureURL> anyURI </PictureURL>
      <!-- ... more PictureURL values allowed here ... -->
    </PictureDetails>
    <PostalCode> string </PostalCode>
    <PostCheckoutExperienceEnabled> boolean </PostCheckoutExperienceEnabled>
    <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>
      <IncludePrefilledItemInformation> boolean </IncludePrefilledItemInformation>
      <IncludeStockPhotoURL> boolean </IncludeStockPhotoURL>
      <ISBN> string </ISBN>
      <ProductID> string </ProductID>
      <StockPhotoURL> anyURI </StockPhotoURL>
      <UPC> string </UPC>
      <UseStockPhotoURLAsGallery> boolean </UseStockPhotoURLAsGallery>
    </ProductListingDetails>
    <ProxyItem> boolean </ProxyItem>
    <Quantity> int </Quantity>
    <QuantityAvailableHint> QuantityAvailableHintCodeType </QuantityAvailableHint>
    <QuantityInfo> QuantityInfoType
      <MinimumRemnantSet> int </MinimumRemnantSet>
    </QuantityInfo>
    <QuantityThreshold> int </QuantityThreshold>
    <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch>
    <RelistParentID> long </RelistParentID>
    <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
    <ReturnPolicy> ReturnPolicyType
      <Description> string </Description>
      <EAN> string </EAN>
      <ExtendedHolidayReturns> boolean </ExtendedHolidayReturns>
      <Refund> string </Refund>
      <RefundOption> token </RefundOption>
      <RestockingFeeValue> token </RestockingFeeValue>
      <RestockingFeeValueOption> token </RestockingFeeValueOption>
      <ReturnsAccepted> string </ReturnsAccepted>
      <ReturnsAcceptedOption> token </ReturnsAcceptedOption>
      <ReturnsWithin> string </ReturnsWithin>
      <ReturnsWithinOption> token </ReturnsWithinOption>
      <ShippingCostPaidBy> string </ShippingCostPaidBy>
      <ShippingCostPaidByOption> token </ShippingCostPaidByOption>
      <WarrantyDuration> string </WarrantyDuration>
      <WarrantyDurationOption> token </WarrantyDurationOption>
      <WarrantyOffered> string </WarrantyOffered>
      <WarrantyOfferedOption> token </WarrantyOfferedOption>
      <WarrantyType> string </WarrantyType>
      <WarrantyTypeOption> token </WarrantyTypeOption>
    </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>
      <MotorsDealer> boolean </MotorsDealer>
      <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>
        <CheckoutEnabled> boolean </CheckoutEnabled>
        <CIPBankAccountStored> boolean </CIPBankAccountStored>
        <GoodStanding> boolean </GoodStanding>
        <MerchandizingPref> MerchandizingPrefCodeType (token) </MerchandizingPref>
        <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
        <SafePaymentExempt> boolean </SafePaymentExempt>
        <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
        <SellereBayPaymentProcessConsent> SellereBayPaymentProcessConsentCodeType
          <PayoutMethod> PayoutMethodType </PayoutMethod>
          <PayoutMethodSet> boolean </PayoutMethodSet>
          <UserAgreementInfo> UserAgreementInfoType
            <AcceptedTime> dateTime </AcceptedTime>
            <SellereBayPaymentProcessEnableTime> dateTime </SellereBayPaymentProcessEnableTime>
            <SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
            <Site> SiteCodeType </Site>
            <UserAgreementURL> anyURI </UserAgreementURL>
          </UserAgreementInfo>
          <!-- ... more UserAgreementInfo nodes allowed here ... -->
        </SellereBayPaymentProcessConsent>
        <SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
        <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>
      <Phone2AreaOrCityCode> string </Phone2AreaOrCityCode>
      <Phone2CountryCode> CountryCodeType </Phone2CountryCode>
      <Phone2CountryPrefix> string </Phone2CountryPrefix>
      <Phone2LocalNumber> string </Phone2LocalNumber>
      <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>
    <SellerProvidedTitle> string </SellerProvidedTitle>
    <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>
      <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
      <AllowPaymentEdit> boolean </AllowPaymentEdit>
      <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>
        <OriginatingPostalCode> string </OriginatingPostalCode>
        <PackageDepth unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageDepth>
        <PackageLength unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageLength>
        <PackageWidth unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageWidth>
        <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
        <ShippingIrregular> boolean </ShippingIrregular>
        <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
        <WeightMajor unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightMajor>
        <WeightMinor unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightMinor>
      </CalculatedShippingRate>
      <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
      <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>
      <InsuranceDetails> InsuranceDetailsType
        <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
      </InsuranceDetails>
      <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
      <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
      <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>
      <InternationalInsuranceDetails> InsuranceDetailsType
        <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
      </InternationalInsuranceDetails>
      <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 ... -->
      <PaymentInstructions> string </PaymentInstructions>
      <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>
        <InternationalRateTable> string </InternationalRateTable>
      </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>
        <LogisticPlanType> string </LogisticPlanType>
        <ShippingService> token </ShippingService>
        <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
        <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
        <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>
    <ShippingTermsInDescription> boolean </ShippingTermsInDescription>
    <ShipToLocations> string </ShipToLocations>
    <!-- ... more ShipToLocations values allowed here ... -->
    <Site> SiteCodeType </Site>
    <SKU> SKUType (string) </SKU>
    <SkypeContactOption> SkypeContactOptionCodeType </SkypeContactOption>
    <!-- ... more SkypeContactOption values allowed here ... -->
    <SkypeEnabled> boolean </SkypeEnabled>
    <SkypeID> string </SkypeID>
    <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
          <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>
          <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>
        <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
      <BusinessSeller> boolean </BusinessSeller>
      <RestrictedToBusiness> boolean </RestrictedToBusiness>
      <VATID> string </VATID>
      <VATPercent> float </VATPercent>
      <VATSite> string </VATSite>
    </VATDetails>
    <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 ItemType object that contains the data for the specified item.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ApplicationData string Conditionally Returns 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.

Not applicable to Half.com; use SellerInventoryID instead.
Max length: 32.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ApplyBuyerProtection BuyerProtectionDetailsType Conditionally Container consisting of details related to whether or not the item is eligible for buyer protection and which of the buyer protection programs will cover the item. This container is not returned if the item is not eligible for eBay or PayPal buyer protection.
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:

•   CustomCode

(out) Reserved for internal or future use.

•   eBay

(out) This value indicates that the item is possibly eligible for buyer protection under the eBay Buyer Protection Program.

•   PayPal

(out) This value indicates that the item is possibly eligible for buyer protection under the PayPal Purchase Protection Program.


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:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) This value indicates that the item is eligible for buyer protection.

•   ItemIneligible

(out) This value indicates that the item is ineligible for buyer protection. In many cases, the item is ineligible for buyer protection due to the category it is listed under.

•   ItemMarkedEligible

(out) This value indicates that the eBay customer support has marked the item as eligible per special criteria.

•   ItemMarkedIneligible

(out) This value indicates that the eBay customer support has marked the item as ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) This value indicates that the item is ineligible for coverage under any buyer protection program.


Item.AttributeSetArray AttributeSetArrayType Conditionally Deprecated as of version 773. No longer functional. Use Item.ItemSpecifics instead.
No longer applicable to any categories.

DetailLevel: ItemReturnAttributes, ReturnAll.
Deprecation version: 773. See also Deprecated Objects.
Item.AutoPay boolean Always To create a requirement that a buyer pays immediately (through PayPal or PaisaPay) for an auction (Buy It Now only) or fixed-price item, the seller can include and set the AutoPay field to 'true' for an Add/Revise/Relist API call. If the seller does not want to create an immediate payment item, this field is either omitted, or included and set to 'false'.

If this feature is enabled for a listing, the buyer must pay immediately for the item through PayPal or PaisaPay (India site only), and the buyer's funds are transferred instantly to the seller's PayPal or PaisaPay account. The seller's item will remain available for purchase by other buyers until the buyer actually completes the payment.

In order for a seller to apply an immediate payment requirement for an item, the following must be true:
  • seller must have a Premier or Business PayPal account (or PaisaPay for India sellers);
  • the Buy It Now price (if applicable) cannot be higher than $10,000 USD;
  • the listing site supports PayPal (or PaisaPay for India site) payments;
  • the category supports PayPal (or PaisaPay for India site) payments;
  • the listing type is fixed-price or auction (with Buy It Now option).

To successfully enable the immediate payment requirement, the seller must also perform the following actions through the API call:
  • seller must provide a valid Item.PayPalEmailAddress value (not required for India site);
  • seller must offer PayPal as the only payment method, or for the India site, one or more of the three supported PaisaPay payment methods;
  • seller must specify all related costs to the buyer, since the buyer will not be able to use the Buyer Request Total feature in an immediate payment listing; these costs include flat-rate shipping costs for each domestic and international shipping service offered, package handling costs, and any shipping surcharges;
  • seller must include and set the PromotionalShippingDiscount field to true if a promotional shipping discount is being applied to the listing;
  • seller must include the ShippingDiscountProfileID and reference a valid flat or calculated Shipping Discount Profile ID if a flat or calculated shipping rule is being applied to the listing.

In the Trading API calls that return the AutoPay field, be aware that the field's appearance in the output does not necessarily indicate that the immediate payment feature was successfully enabled/used for the active or ended listing, but only that the seller attempted to enable (by including and setting AutoPay to 'true' in the request) the immediate payment feature for the listing.

To discover if a category supports immediate payment for an item, use GetCategories and look for the appearance of the AutoPayEnabled boolean field in the output for that category (identified by CategoryID). AutoPayEnabled is returned as an empty element if the category supports immediate payment, and is not returned at all if the category does not support immediate payment.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Specifying a Payment Method
    Requiring Immediate Payment of a Vehicle Deposit

Item.BestOfferDetails BestOfferDetailsType Conditionally For Add/Revise/Relist/Verify calls: This container is used to enable the Best Offer feature on a listing. The Best Offer feature is not available for auction listings.

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.

Not applicable to Half.com.

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 container will not appear in the response.

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 this item. A seller of a fixed-price item (in a category for which Best Offer is also enabled) can opt that item into the Best Offer feature. This feature enables a buyer to make a lower-priced binding offer on that item.

As long as a fixed-price listing has no Best Offer transaction completed or pending, or is not scheduled to end within 12 hours, a seller can change this value (enable or disable).

Note: Some large merchant accounts are enabled to revise this field through a Revise call even within 12 hours of the listing's scheduled end time. The exception to this rule is that Best Offers can not be disabled if the listing has any completed or pending Best Offers.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BestOfferDetails
  .NewBestOffer
boolean Conditionally The value of this boolean field will indicate whether or not the listing is eligible for the Immediate Payment for Best Offers feature. This field's value will be 'true' if a listing is requiring immediate payment, and the item's category supports the Immediate Payment for Best Offers feature. Initially, Immediate Payment for Best Offers will be supported by the Computers & Tablets, Jewelry & Watches, and Art categories, but this feature will get enabled in more categories going forward.

If the Immediate Payment for Best Offers feature is enabled for a listing, and a buyer's Best Offer for the item is accepted by the seller, that buyer will be expected to pay immediately for the item, or that buyer will run the risk of losing the item to another buyer since that item will remain on sale until payment is made.

This field is always returned for fixed-price, Classified Ad, and Motors Local Market listings. It is not applicable to auction 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 Displays the AdditionalContactInformation of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .Address
AddressType Conditionally Displays the Address of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

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 is set to '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
  .Email
string Conditionally Displays the email address of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails.Fax string Conditionally Displays the fax number of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .LegalInvoice
boolean Conditionally Displays the LegalInvoice of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .TermsAndConditions
string Conditionally Displays the TermsAndConditions of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .TradeRegistrationNumber
string Conditionally Displays the TradeRegistrationNumber of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .VATDetails
VATDetailsType Conditionally Displays the VATDetails of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .VATDetails.BusinessSeller
boolean Conditionally If true, this indicates that the seller is a business user and intends to use listing features that are offered to business users only. Applicable only to business sellers residing in Germany, Austria, or Switzerland who are listing in a B2B VAT- enabled category on the eBay Germany (DE), Austria (AT), or Switzerland (CH) sites. The seller must have a valid VAT ID registered with eBay. This must be set to true if RestrictedToBusiness is true. It has no effect (and it's not returned) if RestrictedToBusiness is false. If an item was not qualified as a business item when originally listed, but meets the conditions for business items when the item is revised or relisted, the seller can convert the item to a business item by specifying the appropriate VAT details. See the eBay Web Services guide for more information and additional rules.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .VATDetails
  .RestrictedToBusiness
boolean Conditionally If true, this indicates that the seller elects to offer the item exclusively to business users. If false (or not returned), this indicates that the seller elects to offer the item to all users. Applicable only to business sellers residing in Germany, Austria, or Switzerland who are listing in a B2B VAT-enabled category on the eBay Germany (DE), Austria (AT), or Switzerland (CH) sites. If this argument is true, the seller must have a valid VAT-ID registered with eBay, and BusinessSeller must also be true.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .VATDetails.VATID
string Conditionally Displays the VatSite Id of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .VATDetails.VATPercent
float Conditionally VAT rate for the item, if any. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max applicable length is 6 characters, including the decimal (e.g., 12.345). The scale is 3 decimal places. (If you pass in 12.3456, eBay may round up the value to 12.346.) Note: The View Item page may display the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored.
Min: 0. Max: 30.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BusinessSellerDetails
  .VATDetails.VATSite
string Conditionally Displays the VatSite Id of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerGuaranteePrice AmountType (double) Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerGuaranteePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

For a list of possible enumeration values, see CurrencyCodeType.
Item.BuyerProtection BuyerProtectionCodeType Conditionally Flag to indicate an item's eligibility for the PayPal Purchase Protection program. This field is only returned if 'true'. If this field is not returned, the item is not eligible for PayPal Purchase Protection. For more information on items that are eligible for PayPal Purchase Protection, see the PayPal Purchase Protection help page.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) This value indicates that the item is eligible for buyer protection.

•   ItemIneligible

(out) This value indicates that the item is ineligible for buyer protection. In many cases, the item is ineligible for buyer protection due to the category it is listed under.

•   ItemMarkedEligible

(out) This value indicates that the eBay customer support has marked the item as eligible per special criteria.

•   ItemMarkedIneligible

(out) This value indicates that the eBay customer support has marked the item as ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) This value indicates that the item is ineligible for coverage under any buyer protection program.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Miscellaneous Item Field Differences.

Item.BuyerRequirementDetails BuyerRequirementDetailsType Conditionally When this container is present in an AddItem or AddFixedPriceItem call, all buyer requirements for the resulting listing are set by this container. Furthermore, individual buyer requirements cannot be modified or added when including this container in a ReviseItem call. The ReviseItem call needs to provide the entire set of buyer requirements to modify or add any of the requirements. Unless otherwise specified, most buyer requirements are only returned if the caller is the seller. All global My eBay Buyer Requirements are overridden by the contents of this container. This means that buyer requirements set in My eBay cannot be combined with buyer requirements included in this container.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Selecting Buyer Requirements (eBay Web site help).

Item.BuyerRequirementDetails
  .LinkedPayPalAccount
boolean Conditionally The seller includes and sets this field to 'true' as a mechanism to block bidders who do not have a PayPal account linked to their eBay account.
Default: false.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
MaximumBuyerPolicyViolationsType Conditionally The seller uses this container as a mechanism to block prospective buyers who have one or more buyer policy violations on their account during a specified time period.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .Count
int Conditionally This integer value sets the maximum number of buyer policy violations that a prospective buyer is allowed to have during a specified time period (MaximumBuyerPolicyViolations.Period) before being blocked from buying/bidding on the item.

To retrieve a list of allowed values for this field, the seller should call GeteBayDetails, including BuyerRequirementDetails in the DetailName field of the request, and then look for the BuyerRequirementDetails.MaximumBuyerPolicyViolations.NumberOfPolicyViolations.Count fields in the response.
Default: 4.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .Period
PeriodCodeType Conditionally This enumerated value defines the length of time over which a prospective buyer's buyer policy violations will be counted. If the prospective buyer's number of buyer policy violations during this defined period exceeds the value set in the 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 buyer policy violations is blocked from buying/bidding on the item.
Default: Days_30.

Applicable values:

•   Days_180

(in/out) This value indicates that the evaluation period is set back 180 days from the present date.

•   Days_30

(in/out) This value indicates that the evaluation period is set back 30 days from the present date.


(Not all values in PeriodCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .MaximumItemRequirements
MaximumItemRequirementsType Conditionally The seller uses this container as a mechanism to restrict the number of items (specifying a MaximumItemCount value) a prospective buyer can purchase from the seller during a 10-day period. The seller also has the option of setting a MinimumFeedbackScore requirement. If both fields of the MaximumItemRequirements container are set, the MaximumItemCount limit will only apply to those prospective buyers that don't equal or exceed the specified minimum Feedback Score.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .MaximumItemRequirements
  .MaximumItemCount
int Conditionally This field is conditionally required if the MaximumItemRequirements container is used.

The value of this field specifies the maximum number of items a prospective buyer can purchase from the seller during a 10-day period. The prospective buyer will be blocked from bidding/buying once this value is reached. To see the valid values for your site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.MaximumItemRequirements.MaximumItemCount fields. As of Jan. 2013, the valid values for the US site are: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 25, 50, and 75.

If the MaximumItemRequirements.MinimumFeedbackScore field is also specified, the MaximumItemCount limit will only apply to those prospective buyers who don't meet the specified Minimum Feedback Score threshold.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Buyers Who May Bid on Several of My Items and Not Pay.

Item.BuyerRequirementDetails
  .MaximumItemRequirements
  .MinimumFeedbackScore
int Conditionally This is an optional field that is ignored if a MaximumItemCount value has not been provided.

If this field is used, a prospective buyer is blocked from bidding/buying if they have reached or exceeded the MaximumItemCount and their feedback score is less than the value of this field. To see the valid values for your site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.MaximumItemRequirements.MinimumFeedbackScore fields. Currently, the valid values for the US site are: 0, 1, 2, 3, 4, and 5.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
MaximumUnpaidItemStrikesInfoType Conditionally The seller uses this container as a mechanism to block prospective buyers who have one or more unpaid item strikes 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 sets the maximum number of unpaid item strikes that a prospective buyer is allowed to have during a specified time period (MaximumUnpaidItemStrikesInfo.Period) before being blocked from buying/bidding on the item.

To retrieve a list of allowed values for this field, the seller should call GeteBayDetails, including BuyerRequirementDetails in the DetailName field of the request, and then look for the BuyerRequirementDetails.MaximumUnpaidItemStrikesInfo.MaximumUnpaidItemStrikesCount.Count fields in the response.
Default: 2.

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 item strikes will be counted. If the prospective buyer's number of unpaid item strikes during this defined period exceeds the value set in the 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 item strikes is blocked from buying/bidding on the item.
Default: Days_30.

Applicable values:

•   Days_180

(in/out) This value indicates that the evaluation period is set back 180 days from the present date.

•   Days_30

(in/out) This value indicates that the evaluation period is set back 30 days from the present date.

•   Days_360

(in/out) This value indicates that the evaluation period is set back 360 days from the present date.


(Not all values in PeriodCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .MinimumFeedbackScore
int Conditionally The seller includes this field as a mechanism to block bidders who have a Feedback Score less than the specified value. To obtain the list of supported values, call GeteBayDetails, include BuyerRequirementDetails as a DetailName value in the request, and then look for the list of Minimum Feedback Score values returned under the MinimumFeedbackScore container in the response. Currently, the valid values for the US site are -3, -2, and -1.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .ShipToRegistrationCountry
boolean Conditionally The seller includes and sets this field to 'true' as a mechanism to block bidders who reside (according to their eBay primary shipping address) in countries that are on the ship-to exclusion list. Sellers add countries or regions to their ship-to exclusion list by adding those countries or regions using one or more ExcludeShipToLocation fields in an Add/Revise/Relist call.
Default: false.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .VerifiedUserRequirements
VerifiedUserRequirementsType Conditionally The seller uses this container as a mechanism to block prospective buyers who are not verified users on PayPal, or in the case of eBay India, not verified users on PaisaPay.

The Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.VerifiedUserRequirements container.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .VerifiedUserRequirements
  .MinimumFeedbackScore
int Conditionally This field is ignored unless the VerifiedUser field is included and set to 'true'.

The seller includes this field as a mechanism to block verified users who have a feedback score less than the specified value.

The Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.VerifiedUserRequirements container. The valid MinimumFeedbackScore values will be seen in the BuyerRequirementDetails.VerifiedUserRequirements.FeedbackScore fields.
Default: 5.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyerRequirementDetails
  .VerifiedUserRequirements
  .VerifiedUser
boolean Conditionally To block non-verified users from buying/bidding on their items, the seller should include this field and set its value to 'true'.

The Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.VerifiedUserRequirements container.
Default: false.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Field Differences for eBay Sites.

Item.BuyerRequirementDetails
  .ZeroFeedbackScore
boolean Conditionally This Buyer Requirements feature is only available to sellers on the China site, and is only applicable to fixed-price or auction Buy It Now items.

The seller includes and sets this field to 'true' as a mechanism to block prospective buyers with a feedback score of 0 from buying items with a price of 100 RMB or higher.
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, the buyer is responsible for vehicle pickup or shipping. If false, specify vehicle shipping arrangements in the item description. Default is true. (The description can also include vehicle shipping arrangements when this value is true.) If the item has bids or ends within 12 hours, you cannot modify this flag. Do not specify ShippingDetails.ShippingServiceOptions for vehicle listings.

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.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.BuyItNowPrice AmountType (double) Always For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.

This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings.

Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not.

There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user.

To remove this value when revising or relisting an item, use DeletedField.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Seller Limits
    GeteBayDetails
    Revising US eBay Motors Listings

Item.BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing.

There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid.

This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings.

Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not.

There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user.

To remove this value when revising or relisting an item, use DeletedField.

For a list of possible enumeration values, see CurrencyCodeType.
Item.Charity CharityType Conditionally Identifies a Giving Works listing and the benefiting nonprofit charity organization selected by the charity seller (if any). If specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

When you revise an item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. For an auction listing, you can revise an item to add a charity if there are more than 12 hours left for the listing (whether or not the item has bids). For a fixed-price listing, you can revise an item to add a charity if there are more than 12 hours left for the listing, and the item has not been sold.

When you relist an item, use DeletedField to remove charity information.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.

See:
    Miscellaneous Item Field Differences
    Working with Listings that Benefit Nonprofits

Item.Charity.CharityID string Conditionally A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items.

DetailLevel: ItemReturnDescription, ReturnAll.
Item.Charity.CharityName string Conditionally The name of the benefiting nonprofit charity organization selected by the charity seller.
Max length: 150.

DetailLevel: ItemReturnDescription, ReturnAll.
Item.Charity.CharityNumber int Conditionally A unique identifier assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. This value can contain up to 10 digits. This value is superseded by CharityID.

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 Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items.

DetailLevel: ItemReturnDescription, ReturnAll.
Item.Charity.LogoURL string Conditionally The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing.

DetailLevel: ItemReturnDescription, ReturnAll.
Item.Charity.Mission string Conditionally The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing.
Max length: 511.

DetailLevel: ItemReturnDescription, ReturnAll.
Item.Charity.Status CharityStatusCodeType Conditionally The status of the nonprofit charity organization.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   NoLongerValid

(out) The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider.

•   Valid

(out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider.




DetailLevel: ItemReturnDescription, ReturnAll.
Item.ConditionDescription string Conditionally This string field is used by the seller to more clearly describe the condition of items that are not brand new.

The ConditionDescription field is available for all categories, including categories where the condition type is not applicable (e.g., Antiques). This field is applicable for all item conditions except "New", "Brand New", "New with tags", and "New in box". If ConditionDescription is used with these conditions (Condition IDs 1000-1499), eBay will simply ignore this field if included, and eBay will return a warning message to the user.

This field should only be used to further clarify the condition of the used item. For example, "The right leg of the chair has a small scratch, and on the seat back there is a light blue stain about the shape and size of a coin." It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition type (Item.ConditionID), condition description, item description (Item.Description), and the listing's pictures do not contradict one another.

Note: The ConditionDescription field is optional For Add/Revise/Relist API calls. However, this field may become required in some categories starting with the Spring 2013 Seller Release.
ConditionDescription is currently supported on the eBay US and US eBay Motors (0), UK (3), CA (2), CAFR (210), AU (15), AT (16), BEFR (23), BENL (123), FR (71), DE (77), IT (101), NL (146), ES (186), CH (193), IE (205) and PL (212) sites.
The ConditionDescription field is returned by GetItem (and other related calls that return the Item object) if a condition description is specified in the listing.
Max length: 1000.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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.
Max length: 50.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ConditionID int Conditionally The numeric ID (e.g., 1000) for the item condition. Sellers should also clarify the item's condition in their own item description.

Note: In addition to including notes on flaws or wear and tear on an used item in the Item.Description, and including a ConditionID value, you can provide additional information about the condition of your used item through the Item.ConditionDescription string field.
For the AddItem family of calls: Use GetCategoryFeatures for details about which categories support (or require) ConditionID, plus policies and help on choosing the right condition for the item (to reduce disputes).

Please note the following behavior if you pass a ConditionID value that is not valid for the category: If ConditionID is disabled (or not applicable) for the category, the item is listed with no condition. If ConditionID is enabled or required for the category, the listing request fails.

If you are listing in two categories, the primary category determines which condition model (ConditionID or item specifics) and which condition values can be used.

US eBay Motors Parts & Accessories and vehicle categories require ConditionID for new listings and re-listings.

Not applicable to Half.com in listing requests (e.g., AddItem). However, ConditionID could be returned in responses for Half.com listings that are available to or sold on the eBay site (as appropriate for the corresponding eBay category).

For Revise/Relist calls: In most cases, you can add or modify ConditionID when you revise or relist. If GetCategoryFeatures returns ConditionEnabled=Required for the listing's category, you cannot remove ConditionID from the listing.

If an auction has bids or ends within 12 hours, you cannot remove or change its condition, and you cannot replace a condition attribute or custom item specific with ConditionID. In this case, you will still be able to modify other fields that are normally editable, even if ConditionID is not present.

In most cases, you can add or modify ConditionID for multi-quantity fixed price listings. (If a multi-quantity fixed price listing has revision restrictions imposed by other choices the seller has made in the listing, you might not be able to remove or change the condition.)

If you revise or relist a GTC listing that only has a condition attribute or custom item specific, you need to specify ConditionID (if the category requires it). ReviseInventoryStatus also fails if you attempt to revise listings that are missing ConditionID. (This rule does not apply during auto-renewal of a GTC listing. It only applies when you perform an action on the listing.)

For GetItem and GetSellerList: Only returned when the seller specified ConditionID in their listing. Also returns a localized display name.

Note: For most categories, eBay does not convert item condition data in the older AttributeSetArray, LookupAttributeArray, or ItemSpecifics format to this format in older listings or when you revise or relist items. This means GTC listings and older ended or sold listings may still return the item condition in these other fields even after new listings only support ConditionID.

There are a few categories in which automatic mapping does occur, where the old and newer conditions are identical. See the "Automatic Mapping" tab in the Item Condition Look-up Table link below for details.

Also, if you specified ConditionID but the category also supports condition in item specifics, you may receive a "Dropped condition from Item specifics" warning. You can ignore this warning as long as you used ConditionID.


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Specifying an Item's Condition
    ConditionValues in GetCategoryFeatures
    Item Condition Look-up Table (and Automatic Mapping)

Item.Country CountryCodeType Always Defines the 2-letter country code set.

To see the list of currently supported country codes, and the English names associated with each code (e.g., KY="Cayman Islands"), call GeteBayDetails with DetailName set to CountryDetails, and then look for CountryDetails.Country fields in the response.

Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO codes in the eBay list. (Additional codes appear at the end of this code list and are noted as non-ISO.)

Also applicable as input to AddItem and related calls when you list items to Half.com (specify 'US').

Applicable values: See Country.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See GeteBayDetails.

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 Making Listings Available by Default on Another Site.

Item.CrossPromotion CrossPromotionsType Conditionally This container is no longer supported as eBay Store Cross Promotions are no longer supported by the Trading API.

Container for cross-promoted items related to a specific item ID. The items are either upsell or cross-sell, according to the promotion method passed in the request. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.CrossPromotion.ItemID ItemIDType (string) Conditionally Unique item ID for the referring item.
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.CrossPromotion
  .PrimaryScheme
PromotionSchemeCodeType Conditionally The primary cross-promotion rule scheme that was applied to return the cross-promoted item.

Applicable values:

•   CategoryProximity

(out) This scheme is returned as a backfill scheme used to promote items.

•   CustomCode

(out) Reserved for internal or future use.

•   DefaultCrossSellLogic

(out) This scheme is returned as a backfill scheme used to promote items.

•   DefaultRule

(out) The seller specifies a store category or eBay category, with optional keywords, for referring items and one for promoted items. When a referring item is selected from the category and keywords, items from the promoted category and keywords are also displayed.

•   DefaultUpSellLogic

(out) This scheme is returned as a backfill scheme used to promote items.

•   ItemToDefaultRule

(out) The seller specifies a referring item and defines promoted items selected from a store category, eBay category, or keywords.

•   ItemToItem

(out) The seller specifies individual items in the store that are promoted when a buyer views, bids on, or purchases a store item.

•   ItemToStoreCat

(out) The seller specifies a store category from which items are promoted when a buyer views, bids on, or purchases an individual item in the store.

•   RelatedCategoryRule

(out) This scheme is returned as related category scheme used to promote items.

•   StoreToStoreCat

(out) The seller specifies referring and promoted categories, both from the store. When a buyer views or acts on any item from that category, items from the promoted category are also displayed.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.CrossPromotion
  .PromotedItem
PromotedItemType Conditionally,
repeatable: [0..*]
Contains one cross-promoted item.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.CrossPromotion
  .PromotionMethod
PromotionMethodCodeType Conditionally The type of promotion, CrossSell or UpSell.

Applicable values:

•   CrossSell

(in/out) Promote/present items that are related to or can be used with the specified item.

•   CustomCode

(in/out) Reserved for internal or future use.

•   UpSell

(in/out) Promote/present items that of higher quality or more expensive than the specified item.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.CrossPromotion.SellerID string Conditionally The eBay user ID of the seller offering the cross-promoted item.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.CrossPromotion
  .ShippingDiscount
boolean Conditionally Whether a shipping discount is offered by the seller when the cross-promoted item is purchased.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Currency CurrencyCodeType Always Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item.

To see the list of currently supported currency codes, call GeteBayDetails with DetailName set to CurrencyDetails, and then look for the CurrencyDetails.Currency fields in the response.

Applicable values: See Currency.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    GeteBayDetails
    Field Differences for eBay Sites

Item.Description string Always This field is used by the seller to provide a 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. An error is returned if this contains malicious JavaScript content. (For more information on eBay's HTML and JavaScript policy, see the HTML and JavaScript policy help topic.)

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 PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif. See "Including Pictures in an Item Listing" in the Trading API Guide.

This field is required for all listings except when creating a listing using an eBay catalog product (Item.ProductListingDetails container).

Note: In addition to including notes on flaws or wear and tear on an used item in the Item.Description, and including a ConditionID value, you can provide additional information about the condition of your used item through the Item.ConditionDescription string field.
For GetItem: Item.Description can be empty when IncludePrefilledItemInformation is set to 'true' and the seller did not write their own description. Item.Description doesn't return pre-filled descriptions from catalogs. The eBay site shows the catalog product description (if any) in the product details section of a listing. To retrieve a URL for the catalog product details page, see DetailsURL in FindProducts in the Shopping API.

Not applicable to Half.com. (For Half.com, use AttributeArray.Attribute with the attributeLabel attribute set to 'Notes' to specify a brief description or note to the buyer.)
Max length: 500000 (some sites may allow more, but the exact number may vary).

DetailLevel: ItemReturnDescription, ReturnAll.

See:
    IncludePrefilledItemInformation
    DetailsURL in FindProducts (Shopping API)

Item.DisableBuyerRequirements boolean Conditionally If true: all buyer requirements (from Item.BuyerRequirementDetails or Buyer requirements preferences in My eBay) are ignored.

If false (or omitted): Item.BuyerRequirementDetails or Buyer requirements preferences are used, with Item.BuyerRequirementDetails having the higher precedence.
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, UK, and German (DE) sites, while MAP is available only on the US site.

Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a "special account flag" (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. Sellers should contact their account manager or Customer Service to see if they qualify for the Strikethrough Pricing program.

As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing. The following link details your legal obligations when you utilize Discount Pricing to sell items: Strikethrough Pricing Requirements

For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem: If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Displaying Discount Pricing Information to Buyers.

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:

•   CustomCode

(in/out) Reserved for future use.

•   DuringCheckout

(in/out) DuringCheckout specifies that the discounted price must be shown on the eBay checkout flow page.

•   None

(in/out) None means the discount price is not shown via either PreCheckout nor DuringCheckout.

•   PreCheckout

(in/out) PreCheckout specifies that the buyer must click a link (or a button) to navigate to a separate page (or window) that displays the discount price. eBay displays the discounted item price in a pop-up window.




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:

•   CustomCode

(out) Reserved for future use.

•   MAP

(out) MAP stands for MinimumAdvertisedPrice

•   MFO

(out) MFO means stands for MadeForOutletComparisonPrice.

•   None

(out) None means neither STP nor MinimumAdvertisedPrice.

•   STP

(out) STP stands for Strike Through Pricing.




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, 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).

For the AddItem family of calls: Required for listings in certain categories when certain shipping services (with delivery) are offered. See HandlingTimeEnabled in GetCategoryFeatures. The seller sets this field to a positive integer value indicating the number of days. For a list of allowed values on each eBay site, use GeteBayDetails with DetailName set to DispatchTimeMaxDetails. (Typical values are 0, 1, 2, 3, 4, 5, 10, 15, or 20, but this can vary by site and these may change over time.)

Valid for flat and calculated shipping. Does not apply when there is no shipping, when it is local pickup only or when it is freight shipping. For example, when ShippingService=Pickup or ShipToLocations=None, then DispatchTimeMax is not required.

A DispatchTimeMax value of 0 indicates same day handling for an item. In this case, the seller's shipping commitment depends on the order cut off time set in the seller's user preferences. This defaults to 2:00 PM local time on most sites, which can be overridden by using SetUserPreferences to set DispatchCutoffTimePreference.CutoffTime for the eBay site on which the item is listed. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays).

Note: If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time. With Add, Relist, Revise and Verify calls, if you wish to indicate that a listing with flat or calculated shipping has no handling time commitment, submit Item.DispatchTimeMax as an empty field.

To add Get It Fast to listings (for domestic shipping), in addition to setting GetItFast to true, DispatchTimeMax must be set to 0 or 1 and the seller must specify at least one qualifying expedited shipping service.

Note: To receive a Top-Rated Plus seal for their listing, Top-Rated Sellers must offer same day or 1-day handling (DispatchTimeMax=0 or DispatchTimeMax=1) and accept returns (ReturnPolicy.ReturnsAcceptedOption=ReturnsAccepted). Top-Rated listings qualify for the greatest average boost in Best Match and the 20 percent Final Value Fee discount. For more information on changes to eBay's Top-rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page. 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:
    GeteBayDetails
    (GetCategoryFeatures) SiteDefaults.HandlingTimeEnabled
    Same Day Handling

Item.eBayNowAvailable boolean Conditionally This boolean field will be returned as 'true' if the item is available for eBay Now delivery. However, buyers should realize that they must be in an area where eBay Now delivery is available. As of April 2014, eBay Now has been launched on the San Francisco Penisula (from San Francisco to San Jose), in Chigago, in Dallas, and in the New York City boroughs of Manhattan, Brooklyn, and Queens.
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 Returned for classified ads to indicate whether contact by email is enabled. In the pay-per-lead feature, which will be available in upcoming months on the US site, this field will specify whether potential buyers can email the seller after viewing a pay-per-lead listing.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
ContactHoursDetailsType Conditionally All fields related to contact hours including time ranges and user-designated time zone.

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:

•   CustomCode

(in/out) Reserved for internal or future use.

•   EveryDay

(in/out) Seller can be contacted any day during the specified contact hours.

•   None

(in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored.

•   Weekdays

(in/out) Seller can be contacted Monday through Friday during the specified contact hours.

•   Weekends

(in/out) Seller can be contacted Saturday or Sunday during the specified contact hours.




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:

•   CustomCode

(in/out) Reserved for internal or future use.

•   EveryDay

(in/out) Seller can be contacted any day during the specified contact hours.

•   None

(in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored.

•   Weekdays

(in/out) Seller can be contacted Monday through Friday during the specified contact hours.

•   Weekends

(in/out) Seller can be contacted Saturday or Sunday during the specified contact hours.




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 ID for a second category that eBay added as a free promotion. You cannot add this yourself. Only returned if the item was listed in a single category and eBay added a free second category.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.FreeAddedCategory
  .CategoryID
string Conditionally Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID.

For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories.
Max length: 10.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.FreeAddedCategory
  .CategoryName
string Conditionally Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).

In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings.
Max length: 30.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.GetItFast boolean Conditionally Indicates whether the seller has committed to the GetItFast shipping rules for this listing. If the GetItFast field is set to true, and the seller's first priority domestic shipping service (the service that has the ShippingServicePriority field set to 1) is an expedited shipping service, then every shipping service offered for this listing is considered a GetItFast service. Therefore, the seller commits to delivering the item to the buyer-selected shipping service within one day.
Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Enabling Multi-Jurisdiction Sales Tax
    Miscellaneous Item Field Differences

Item.GiftIcon int Always If turned on at listing time, this flag allows the seller to offer one or more gift services to buyers, and a generic gift icon displays next to the listing's title in Search and View Item pages. GiftIcon must be included at listing time and set to '1' to be able to use one or more GiftServices options. The value of '1' indicates that this feature is on, and the value of '0' indicates that the feature is off.

Gift Services are only available on the following eBay sites:
  • Belgium (Dutch)
  • Belgium (French)
  • France
  • Italy
  • Netherlands
  • Poland
  • Spain


To verify if Gift Services are enabled for an eBay site, call , call GeteBayDetails with DetailName set to ListingFeatureDetails. Then look for GiftIcon=Enabled under the ListingFeatureDetails container in the response.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See GeteBayDetails.

Item.GiftServices GiftServicesCodeType Conditionally,
repeatable: [0..*]
This field allows the seller to offer optional gift services to the buyer. To offer one or more gift services to the buyer through an Add/Revise/Relist API call, the seller must also include the GiftIcon field and set that flag to 'true'.

Gift Services are only available on the following eBay sites:
  • Belgium (Dutch)
  • Belgium (French)
  • France
  • Italy
  • Netherlands
  • Poland
  • Spain


This field is only returned in GetItem (and other calls that retrieve Item object) if it is set for the listing.

To verify if Gift Services are enabled for an eBay site, call GeteBayDetails with DetailName set to ListingFeatureDetails. Then look for GiftIcon=Enabled under the ListingFeatureDetails container in the response.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   GiftExpressShipping

(in/out) The seller is offering to ship the item via an express shipping method as explained in the item description.

•   GiftShipToRecipient

(in/out) The seller is offering to ship to the gift recipient (instead of to the buyer) after payment clears.

•   GiftWrap

(in/out) The seller is offering to wrap the item (and optionally include a card) as explained in the item description.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See GeteBayDetails.

Item.HideFromSearch boolean Conditionally If this field is returned in GetItem as 'true', the auction listing is being hidden from search on the eBay site. This field is not returned if 'false'.

To see the reason why the auction listing is being hidden from search, take a look at the value returned in the ReasonHideFromSearch field. Currently, only auction listings that have been determined to be duplicate listings with zero bids are hidden from search, but there may be other reasons to hide auction listings from search in the future.

Is it possible that a previously hidden listing will be resurfaced in search if the original auction listing or other duplicate listings get bids or are purchased through Buy It Now.

It is also possible that eBay will administratively end duplicate auction listings with zero bids. If this occurs, the listing fee will be credited back to the seller's account, and the value returned in the AccountDetailsEntryType field of the GetAccount API call will be CreditAuctionEndEarly.

This field is associated with eBay Duplicate Listings Policy, which has taken effect 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.
Item.HitCount long Conditionally The number of page views for the item. This number is calculated by eBay and cannot be set via the API. Returned if the hit counter type is BasicStyle, RetroStyle, or HiddenStyle. For HiddenStyle, HitCount is returned only if the requestor is the item's seller.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.HitCounter HitCounterCodeType Always Indicates whether an optional hit counter is displayed on the item's listing page and, if so, what type. See HitCounterCodeType for specific values.

Not applicable to Half.com.

Applicable values:

•   BasicStyle

(in/out) A basic style hit counter.

•   CustomCode

(in/out) Reserved for internal or future use

•   GreenLED

(in/out) A green LED, computer-style hit counter (US only). Non-US sites will return errors if they use GreenLED as input, and should use RetroStyle instead.

•   Hidden

(in/out) A hidden hit counter (US only). The number of page views will only be available to the item's seller. For faster "View Item" page loads, use HiddenStyle.

•   HiddenStyle

(in/out) A hidden hit counter. The number of page views will only be available to the item's seller.

•   HonestyStyle

(in/out) A basic style hit counter (US only). Non-US sites will return errors if they use HonestyStyle as input, and should use BasicStyle instead.

•   NoHitCounter

(in/out) No hit counter. The number of page views will not be available.

•   RetroStyle

(in/out) A retro, computer-style hit counter.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item
  .IntegratedMerchantCreditCardEnabled
boolean Conditionally Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. A payment gateway account is used by sellers to accept online credit cards (Visa, MasterCard, American Express, and Discover).

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 you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method.

If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.
For GetItem and related calls: Only returned when the value is SKU; not returned when the value is ItemID. Not applicable to Half.com.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   ItemID

(in/out) The seller prefers to track the listing by its eBay item ID. This is the default for all listings.

•   SKU

(in/out) The seller prefers to track the listing by their own SKU. When you track by SKU, it means you can pass 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.




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 If true, sellers can offer eBay's Global Shipping Program when listing the specified item.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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.
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 desribe 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.

Note: Only valid parts compatibility name-value pairs will be added to the listing. Any invalid parts compatibility combinations will be reported in the long error message in the response errors with a severity of Warning. 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 returned only if:
  • The seller included item compatibility in the listing.
  • The item compatibility details were specified manually; that is, they do not correspond to an eBay catalog product. (To retrieve compatibility details that do correspond to eBay catalog products, use the eBay Product API's getProductCompatibilities call.)
  • IncludeItemCompatibilityList is set to true in the GetItem request
  • .

See Product API ProductCompatibilities call reference for information about retrieving compatibility details that correspond to eBay catalog products..

Item.ItemCompatibilityList
  .Compatibility
ItemCompatibilityType Conditionally,
repeatable: [0..*]
Details for an individual compatible application, consisting of the name-value pair and related compatibility notes. When revising or relisting, the Delete field can be used to delete individual compatibility nodes.

Note: For the GetItem call, Compatibility includes only compatibility details that were specified manually; that is, they do not correspond to an eBay catalog product. To retrieve 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 compatibility details that correspond to eBay catalog products..

Item.ItemCompatibilityList
  .Compatibility
  .CompatibilityNotes
string Conditionally The seller may optionally enter any notes pertaining to the 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.

The K type vehicle number is supported in the DE, UK, and AU eBay sites to specify parts compatibility. To use a K type number to specify item compatiblities, set the Name field to "KType" and set the corresponding Value field to the K type number.
Item.ItemCompatibilityList
  .Compatibility.NameValueList
  .Name
string Conditionally A name in a name/value pair.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing.

For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations.

For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer").

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 40.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ItemCompatibilityList
  .Compatibility.NameValueList
  .Source
ItemSpecificSourceCodeType Conditionally The origin of this Item Specific. Only returned if the source is not custom Item Specifics.

Applicable values:

•   Attribute

(out) The Item Specific was originally stored with eBay's system-defined (ID-based) attributes format. (For example, the seller used the AttributeSetArray node in AddItem at a time when the category supported Attributes.)

•   CustomCode

(out) Reserved for future use.

•   ItemSpecific

(out) The Item Specific was originally stored with custom Item Specifics fields. (For example, the seller used the ItemSpecifics node in AddItem.) This is the default setting if Source isn't returned.

•   Product

(out) The Item Specific is prefilled from a product catalog. (For example, the seller used ExternalProductID or ProductID in AddItem.)




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ItemCompatibilityList
  .Compatibility.NameValueList
  .Value
string Conditionally,
repeatable: [0..*]
A value associated with the name.

For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing.

For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available.

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 50.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ItemID ItemIDType (string) Always The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value.

Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing.

In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.)

In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem.
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. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base.
Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 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 A list of Item Specific name and value pairs that the seller specified for the item.

Item Specifics describe well-known aspects of an item or product in a standard way, to help buyers find that type of item or product more easily. or example, "Publication Year" is a typical aspect of books, and "Megapixels" is a typical aspect of digital cameras.

In the AddItem family of calls, use Item.ItemSpecifics to specify custom Item Specifics.

To determine which categories support custom Item Specifics, use GetCategoryFeatures.

To retrieve recommended Item Specifics, use GetCategorySpecifics.

With GetItem, this is only returned when you specify IncludeItemSpecifics in the request (and the seller included custom Item Specifics in their listing).

For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add Item Specifics. If the 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 specified.

To delete all Item Specifics when you revise or relist, specify Item.ItemSpecifics in DeletedField and don't pass ItemSpecifics in the request.

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 custom item specific, eBay drops the condition item specific.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Working with Custom Item Specifics
    Seller Central: Changes to 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 varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.

When you list with Item Variations:
a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
b) Specify up to five VariationSpecifics in each Variation node.
c) Specify all applicable names with all their supported values in the VariationSpecificSet node.

See the Variation sample in the AddFixedPriceItem call reference for examples.

For PlaceOffer: Required if the item being purchased includes Item Variations.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ItemSpecifics
  .NameValueList.Name
string Conditionally A name in a name/value pair.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing.

For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations.

For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer").

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 40.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ItemSpecifics
  .NameValueList.Source
ItemSpecificSourceCodeType Conditionally The origin of this Item Specific. Only returned if the source is not custom Item Specifics.

Applicable values:

•   Attribute

(out) The Item Specific was originally stored with eBay's system-defined (ID-based) attributes format. (For example, the seller used the AttributeSetArray node in AddItem at a time when the category supported Attributes.)

•   CustomCode

(out) Reserved for future use.

•   ItemSpecific

(out) The Item Specific was originally stored with custom Item Specifics fields. (For example, the seller used the ItemSpecifics node in AddItem.) This is the default setting if Source isn't returned.

•   Product

(out) The Item Specific is prefilled from a product catalog. (For example, the seller used ExternalProductID or ProductID in AddItem.)




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ItemSpecifics
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
A value associated with the name.

For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing.

For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available.

For PlaceOffer: Required if the item being purchased includes Item Variations.
Max length: 50.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item
  .ListingCheckoutRedirectPreference
ListingCheckoutRedirectPreferenceType Conditionally Container consisting of the ProStores store name and user name.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item
  .ListingCheckoutRedirectPreference
  .ProStoresStoreName
string Conditionally The name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item
  .ListingCheckoutRedirectPreference
  .SellerThirdPartyUsername
string Conditionally The user name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ListingDesigner ListingDesignerType Conditionally Contains the detail data for the Listing Designer theme and template (if either are used), which can optionally be used to enhance the appearance of the description area of an item's description. See ListingDesignerType for its child elements.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
Item.ListingDesigner.LayoutID int Always Identifies the Layout template to use when displaying the item's description. Call GetDescriptionTemplates for valid IDs. Set to false in GetDescriptionTemplates (or do not specify LayoutID) to get the standard layout. If a Listing Designer layout is used (except standard layout), PhotoDisplayType must be false (or not be specified). When relisting an item, LayoutID is removed from the listing if you specify ListingDesignerType without LayoutID. Alternatively, to remove this value when revising or relisting an item, use DeletedField.

DetailLevel: ItemReturnDescription, ReturnAll.
Item.ListingDesigner
  .OptimalPictureSize
boolean Conditionally If true, indicates that the item's picture will be enlarged to fit description of the item.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ListingDesigner.ThemeID int Always ID for the Listing Designer theme template to use when displaying the item's description. When relisting, if you specify ListingDesignerType without ThemeID, ThemeID is removed from the listing. Alternatively, to remove this value when revising or relisting an item, use DeletedField.

DetailLevel: ItemReturnDescription, ReturnAll.
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.

Not applicable to Half.com.

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.)

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 above this value, the offer is automatically accepted by the seller. Applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature. Best Offer must be enabled for the item, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response. On the US eBay Motors site (site ID 0), you cannot use the API to add a minimum Best Offer price. For a ReviseItem call on US eBay Motors, prior use of a minimum Best Offer price on eBay.com is ignored.

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 above this value, the offer is automatically accepted by the seller. Applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature. Best Offer must be enabled for the item, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response. On the US eBay Motors site (site ID 0), you cannot use the API to add a minimum Best Offer price. For a ReviseItem call on US eBay Motors, prior use of a minimum Best Offer price on eBay.com is ignored.

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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ListingDetails
  .BuyItNowAvailable
boolean Conditionally This flag 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 This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Checkout.

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.

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.

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.

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.

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.

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.

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). The value in this field indicates the seller's reason for ending the listing early.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   Incorrect

(in/out) The start price or reserve price is incorrect.

•   LostOrBroken

(in/out) The item was lost or broken.

•   NotAvailable

(in/out) The item is no longer available for sale.

•   OtherListingError

(in/out) The listing contained an error (other than start price or reserve price).

•   SellToHighBidder

(in/out) Seller want to sell the listing to the high bidder. A seller can end a listing in order to seller to the current high bidder when the listing has qualifying bids (i.e., there is a current high bid that, when applicable, meets the minimum reserve price) and there is more than 12 hours before the listing ends.
: In the last 12 hours of an item listing, you cannot end an item early if it has bids.

•   Sold

(in/out) The vehicle was sold. Applies to local classified listings for vehicles only.


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.

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.

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 by the seller. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item, and only the seller who listed the item can see this value. To remove this value when revising or relisting an item, use DeletedField.

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 by the seller. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item, and only the seller who listed the item can see this value. To remove this value when revising or relisting an item, use DeletedField.

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 should reflect the last relist.

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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ListingDetails
  .TCROriginalItemID
ItemIDType (string) Conditionally Indicates the item ID of the original item listing from which a Transaction Confirmation Request (TCR) was created. This value is only returned when the data for a TCR is retrieved.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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).

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 ?.

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. To set a duration of 1 day, the seller must have a Feedback score of at least 10.

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.

Required for Half.com (but only specify GTC).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    GetCategoryFeatures
    Fees per Site



Applicable values: See ListingDurationCodeType
Item.ListingEnhancement ListingEnhancementsCodeType Conditionally,
repeatable: [0..*]
This field can be used by the seller to activate one or more listing upgrades for a listing, such as a Bold Title, a Subtitle, or a Value Pack bundle. A ListingEnhancement field is required for each listing upgrade that the seller wants to activate. There is a small fee associated with each listing upgrade. See the Listing Upgrades help page for more information on the available listing upgrades.

The listing upgrades that are available vary by site and by the seller's account status. To discover which listing upgrades are available, call GeteBayDetails with DetailName set to ListingFeatureDetails and pass in the appropriate SiteID value. Then look for the ListingFeatureDetails container in the response. Listing upgrades will either be listed as 'Enabled' or 'Disabled'.

GetItem (and other calls that retrieve Items) will only return this field if one or more listing upgrades are set for the listing.

You cannot remove listing upgrades when you revise a listing. When you relist an item, use DeletedField to remove a listing upgrade.

Not applicable to Half.com.

Applicable values:

•   BasicUpgradePackBundle

(in/out) No longer applicable to any site.

•   BoldTitle

(in/out) If specified, the seller wants the title for the item's listing to be in boldface type. Applicable listing fees apply. Does not affect the item subtitle (Item.SubTitle), if any. Not applicable to eBay Motors.

•   Border

(in/out) If specified, the seller wants to add a border around the listing's pictures. Applicable listing fees apply.

Note: The Picture Border feature is no longer available on the US site.

•   CustomCode

(in/out) Reserved for internal or future use.

•   Featured

(in/out) Listing is a "Featured Plus" item. The item will display prominently in the Featured Items section of its category list, and it will stand out on search results pages. It will also display in the regular, non- featured item list. Only available to users with a Feedback rating of 10 or greater.

•   Highlight

(in/out) Listing is highlighted in a different color in lists.

•   HomePageFeatured

(in/out) Listing will have a chance to rotate into a special display on eBay's Home page. Your item is very likely to show up on the Home page, although eBay does not guarantee that your item will be highlighted in this way. This is the highest level of visibility on eBay.

Not applicable for eBay Motors. In order to feature the listing on eBay Motors home page, use PictureDetails.GalleryType.Featured instead. See GalleryTypeCodeType for more information.

•   ProPackBundle

(in/out) Listing is using ProPackBundle (a feature pack). Applies only to vehicle listings on eBay Motors (US and Canada), and to the Parts and Accessories category in the eBay Motors US site. Contains the BoldTitle, Border, Featured and Highlight features.

•   ProPackPlusBundle

(in/out) Support for this feature varies by site and category. A ProPackPlusBundle listing is using ProPackPlus bundle (a feature pack), which combines the features of BoldTitle, Border, Highlight, Featured (which is equivalent to a GalleryType value of Featured), and Gallery, for a discounted price. Note that if, for example, in AddItem, if you use ProPackPlusBundle and a GalleryType value of Gallery, then the resulting item will have a GalleryType value of Featured.

•   ValuePackBundle

(in/out) Listing is using ValuePack bundle (a feature pack), which combines the features Gallery, Subtitle, and Listing Designer for a discounted price. Support for this feature varies by site and category.

Note: The following sites offer free Gallery: US and the Parts & Accessories Category on US Motors (site ID 0), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, whenever ValuePackBundle is selected in a request, the basic Gallery feature included in the Value Pack bundle is automatically upgraded to the Gallery Plus feature at no extra cost (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus).

If ValuePackBundle is selected and no Gallery picture is found, the request is still accepted and the ValuePackBundle fee will still apply. Whenever a listing with ValuePackBundle is created on a site that offers free Gallery, the Gallery Plus upgrade will display on all sites and categories that support ValuePackBundle.

Note that if Gallery Showcase is automatically included with Gallery Plus, it will be extended to listings with ValuePackBundle that upgrade Gallery to Gallery Plus (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus).




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See GeteBayDetails.

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:

•   ClassifiedAd

(in/out) General classified ad listing subtype.

Note: This value indicates a classified ad (or digital download) listing on ebay.com websites, not on ebayclassifieds.com. The ebayclassifieds.com site is not supported by the Trading API. For information about other differences between these two sites, see Advertising with classified ads on eBay and eBay Classifieds.

•   CustomCode

(in/out) Reserved for internal or future use

•   LocalMarketBestOfferOnly

(in/out) General LocalMarketBestOfferOnly listing subtype.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    About Local Market Listings
    Advertising with Classified Ads

Item.ListingType ListingTypeCodeType Always The format of the listing the seller wants to use, such as auction style or fixed price.

Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing.

Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned).



Applicable values:

•   AdType

(in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings.

•   Chinese

(in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.

•   CustomCode

(in/out) Reserved for internal or future use.

•   FixedPriceItem

(in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more.

Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for auctions).

Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide.

Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days).

•   LeadGeneration

(in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).

•   PersonalOffer

(out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings.

•   Shopping

(out) Reserved for internal or future use. You can ignore Shopping.com items in your results.


(Not all values in ListingTypeCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Different Ways of Selling
    Listing Types (Formats)
    GetCategoryFeatures
    Fees per Site

Item.LiveAuction boolean Conditionally This field should be included and set to 'true' in Add/Revise/Relist calls to enable the listing as a "Live Auction". The Live Auctions feature will allow real-time bidding on eBay for items that are up for bidding at a live auction (physical location).

To enable a "Live Auction" listing through an Add call, the following things must be true:
  • The eBay site must support Live Auction listings.
  • The seller must be eligible to list Live Auction items.
  • The Item.ListingType value should be set to 'Chinese' (auction format).
  • The Item.ListingDuration value should be set to 'Days_3', 'Days_5', 'Days_7', or 'Days_10'.
With Live Auction listings, the seller can:
  • set the ShippingServiceOptions.ShippingService field to 'LocalPickup', which will allow the buyer to pick up the item at the auction house/auction location. Other shipping service options will also be allowed. However, if 'LocalPickup' is used, the shipping type must be set to flat-rate shipping (ShippingDetails.ShippingType=Flat).
  • Create the listing without any electronic payment method. To do this, the seller would pass in 'PaymentSeeDescription' in one Item.PaymentMethods, and then would describe the payment instructions/arrangement in the Item.Description field.
  • Use the Item.ScheduleTime field to set the auction start time to a date in the future. The time between the listing creation time and the auction start time can be used to allow interested eBay users to register for the Live Auction event.


eBay users will be required to register for Live Auction events if they wish to bid on a Live Auction item. Once they are registered, they will also be allowed to add the Live Auction item to their Watch List. If the Live Auction listing accepts an electronic form of payment (like PayPal), the winning bidder can add the Live Auction item to the shopping cart and use eBay checkout.

The LiveAuction boolean field will only be returned in GetItem if 'true'.

Note: The Live Auction feature is scheduled to start ramping up for eligible eBay US sellers (site ID=0) in late August 2014. For the eBay UK (site ID=3), eBay France (site ID=71), and eBay Hong Kong (site ID=201), the Live Auction feature is scheduled to start ramping up for eligible sellers on those sites in late September 2014.
Item.Location string Always Indicates the geographical location of the item (along with Country) to be displayed on eBay listing pages. 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.

Note: If you specify both Location and PostalCode, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. For the Classified Ad format for eBay Motors vehicles, the value provided in the Location 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.

Also applicable as input to AddItem and related calls when you list items to Half.com.
Max length: 45.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.LocationDefaulted boolean Conditionally True if 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.

Not applicable to Half.com.

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.

Not applicable to Half.com.
Max: 100000.

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 Car category listings on the UK site.
Default: false.
Item.MotorsGermanySearchable boolean Conditionally If this field is included and set to 'true' for a motor vehicle listing on the Germany site, the seller's motor vehicle listing will also appear on the mobile.de partner site. This field is only applicable to the eBay Germany site and only applicable when listing a motor vehicle on that site. If this field is used in any other situation, it is ignored.

Listing on the mobile.de is considered a listing upgrade so the seller will be charged a listing upgrade fee.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Cross-Promoting Vehicles on the Mobile.de Site.

Item.OutOfStockControl boolean Conditionally When this field is set to 'true' the item is hidden from search when the quantity goes to 0 (zero) but the listing is kept alive. Using an OutOfStockControl flag in an Add/Revise/Relist call, a seller can keep a Fixed-Price GTC (Good 'Til Canceled) listing alive even when the "quantity available" value goes to 0 (zero). While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the element HideFromSearch would be returned as 'true' and ReasonHideFromSearch would be returned as 'OutOfStock'.

This is useful for a seller who is waiting for additional stock of an item with the same ItemID. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can use the Revise calls to update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields) and the listing would appear again.

Using this flag also has the following benifits.
  • Increasing SEO (search engine optimization) -- Since the item is a long running item this increases the chances that it will be indexed by popular search engines.
  • Making merchandizing and inventory management easier
    • Due to the 1:1 mapping of the SKU and ItemID mapping, the merchant doesn't have to refer to multiple ItemIDs to get a count of how much they have in stock, what was sold, etc.
    • Since the listing stays alive, the sales history is retained.
Things to Note:
  • This feature is best suited for Business to Consumer sellers and is available only through the API.
  • OutOfStockControl is set at the item level. So you can set this flag for existing listings using a Revise call and can include it in Add calls.
  • Once this flag is set to 'true' you cannot change it. To remove it, end the item and relist it by setting the OutOfStockControl field to 'false'.
  • When OutOfStockControl is set to 'true', you can set the quantity of the item to zero. When OutOfStockControl is set to 'false' you cannot set the quantity to zero.
  • On a single SKU item, with OutOfStockControl set to 'true' and the quantity is zero, the item does not appear in the SRP (Search Results Page). If a user has the ItemID, they can go to the VIP (View Item Page) directly. On this page, the Buy It Now and Add to cart buttons are gone, and there is a label showing that the item is out of stock.
  • On a multi-SKU item with OutOfStockControl set to 'true', if at least one variation has stock, the item will appear on the SRP. Variations with zero quantity will be shown as 'out of stock' on the VIP. When all of the variations have zero quantity, the item will not appear on the SRP. However, if a user has the ItemID, they can go to the VIP directly. In that case, all the variations are greyed out, the Buy It Now and Add to cart buttons are gone, and there is a label showing that the item is out of stock.
  • Variations: Changing the quantity to zero of variations behaves differently depending on the value of OutOfStockControl. The following shows the behavior when setting the quantity of a variation to zero. In this example there are three variations; A with a quantity of 5, B with a quantity of 3, and C with a quantity of 1 and there have been no sales of any of these variations.

    Variation Quantity Set to 0OutOfStockControl = falseOutOfStockControl = true
    A Variation A is deleted. Variation is retained. Since at least one variation has stock, this variation will show up on the SRP (Search Results Page). On the VIP (View Item Page) it will be shown as 'Out of Stock'.
    B Variation B is deleted. Variation is retained. Since at least one variation has stock, this variation will show up on the SRP. On the VIP it will be shown as 'Out of Stock'.
    C You receive an error because you cannot set the last variation to quantity zero. The variation is retained and all variations will be shown as 'Out of Stock' on the VIP. The item will not appear on the SRP.
  • If you want to delete a variation for an item that has OutOfStockControl set to 'true', you will need to set the Item.Variations.Variation.Delete field to 'true'.


IMPORTANT: When an item is hidden the listing is still alive. That means the Good 'Til Cancelled automatic renewal will continue every 30 days AND the listing fees will be charged. This is best suited for long running items where inventory can be replace in a reasonable time.


Default: false.

See Using the Out-of-Stock Feature.

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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.PaymentDetails PaymentDetailsType Conditionally This container is used by the seller to specify amounts and due dates for deposits and full payment on motor vehicle listings.

The PaymentDetails container and its child fields are only applicable to vehicle listings on eBay Motors (US and CA).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Payment Methods for Motors.

Item.PaymentDetails
  .DaysToFullPayment
int Conditionally This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are '3', '7' (default), '10', and '14'.

In order for a buyer to make a full payment on an US or CA motor vehicle, at least one of the following PaymentMethods values must be specified for the listing:
  • CashInPerson
  • LoanCheck
  • MOCC (money order or cashier's check)
  • PaymentSeeDescription (indicates to prospective buyers that payment instructions are in the item's description
  • PersonalCheck

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 deposit that a buyer must make on a purchased motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00. If not specified, this value defaults to '0.0'. If the seller is requiring that the buyer put down a deposit on the vehicle, the seller must include and set the DepositType field to 'OtherMethod' and specify an HoursToDeposit value. If specified, then also specify HoursToDeposit

Deposits can only be paid using PayPal, so if DepositAmount is specified (and not '0.0'), then the listing must offer 'PayPal' as a payment method (in addition to the payment methods offered for the full payment). Unlike other listings, PayPal is not automatically added to a Motors listing even if the seller has a PayPal preference set in My eBay. The seller also needs to have a linked PayPal account in order to require a deposit.

The deposit amount appears in the shipping, payment details and return policy section of the View Item page.

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.
Min: 0.0. Max: 2000.0. Default: 0.0.

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 deposit that a buyer must make on a purchased motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00. If not specified, this value defaults to '0.0'. If the seller is requiring that the buyer put down a deposit on the vehicle, the seller must include and set the DepositType field to 'OtherMethod' and specify an HoursToDeposit value. If specified, then also specify HoursToDeposit

Deposits can only be paid using PayPal, so if DepositAmount is specified (and not '0.0'), then the listing must offer 'PayPal' as a payment method (in addition to the payment methods offered for the full payment). Unlike other listings, PayPal is not automatically added to a Motors listing even if the seller has a PayPal preference set in My eBay. The seller also needs to have a linked PayPal account in order to require a deposit.

The deposit amount appears in the shipping, payment details and return policy section of the View Item page.

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 This field applies to eBay Motors (US and CA) vehicles listings. If the seller is requiring that the buyer make a deposit on the vehicle, the DepositType value must be included and set to 'OtherMethod'. Otherwise, specify 'None' (or don't pass in DepositType).
Default: None.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   FastDeposit

(in/out) No longer used.

•   None

(in/out) No deposit needed.

•   OtherMethod

(in/out) Pay the deposit using PayPal, and then use any of the other specified payment methods to pay the balance.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.PaymentDetails
  .HoursToDeposit
int Conditionally This integer value indicates the number of hours that a buyer has (after he/she commits to buy) to make a deposit to the seller as a down payment on a motor vehicle. Valid values are '24', '48' (default), and '72'.

The deposit amount is specified in the DepositAmount field. If not specified, the DepositAmount value defaults to 0.0, in which case, a deposit on the vehicle is not required.
Min: 24. Max: 72. Default: 48.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.PaymentMethods BuyerPaymentMethodCodeType Conditionally,
repeatable: [0..*]
Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. For the AddItem family of calls, at least one payment method is required.

Use GetCategoryFeatures to determine the payment methods that are allowed for a category on a site. For example, the response data of GetCategoryFeatures will show that on the US site, most categories only allow electronic payments. Also use GetCategoryFeatures to determine the default payment method for a site (see SiteDefaults.PaymentMethod). If a seller does not include at least one payment method in a Add/Revise/RelistItem API call, the default payment method is used for the listing.

Do not use GeteBayDetails to determine the payment methods for a site.

For a DE or AT seller's items that are subject to the new eBay payment process, only one PaymentMethod field will be returned, and the value will always be 'StandardPayment'.

If you specify multiple PaymentMethods fields, the repeating fields must be contiguous. For example, you can specify PayPalEmailAddress after a list of repeating PaymentMethods fields, but not between them:

<PaymentMethods>VisaMC</PaymentMethods>
<PaymentMethods>PayPal</PaymentMethods>
<PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress>

In general, if you separate repeating instances of a field, the results will be unpredictable. This rule applies to all repeating fields (maxOccurs="unbounded" or greater than 1) in the schema. See "Overview of the Schema" in the Trading API Guide.

This field is not applicable to eBay Real Estate Ad format, Classified Ad format, or Half.com listings.

For ReviseItem and RelistItem only: A listing must have at least one valid payment method. When you revise or relist an item and you specify a payment method that is invalid for the target site, eBay ignores the invalid payment method, applies the other valid changes, and returns a warning to indicate that the invalid payment method was ignored. If multiple payment methods were invalid, the warning indicates that they were all ignored. If you modify the listing so that it includes no valid payment methods, an error is returned. This situation could occur when the seller removes all valid payment methods or when all the payment methods specified for the item are no longer valid on the target site.

Applicable values: See PaymentMethods.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Determining the Payment Methods Allowed for a Category
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema
    GeteBayDetails

Item.PayPalEmailAddress string Conditionally Valid PayPal email address for the PayPal account that the seller will use if they offer PayPal as a payment method for the listing. eBay uses this to identify the correct PayPal account when the buyer pays via PayPal during the checkout process. (As a seller can have more than one PayPal account, you cannot necessarily rely on PayPal account data returned from GetUser for details about the account associated with the PayPal email address that the seller specifies.)

Required if seller has chosen PayPal as a payment method (PaymentMethods) for the listing.

For digital listings, the seller needs to use an email address that is associated with a PayPal Premier or PayPal business account.

For ReviseItem and RelistItem only: To remove this value when you revise or relist an item, use DeletedField. When you revise a listing, if the listing has bids (or items have been sold) or it ends within 12 hours, you can add PayPalEmailAddress, but you cannot remove it.

Not applicable to eBay Motors listings.
Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences

Item.PickupInStoreDetails PickupInStoreDetailsType Conditionally This container is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup or Click and Collect.

This container is returned in GetItem, GetSellerList, and GetItemShipping if In-Store Pickup or Click and Collect is set for the listing.

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. The Click and Collect feature is only available to large merchants selling on the eBay UK site.
Item.PickupInStoreDetails
  .EligibleForPickupDropOff
boolean Conditionally This field is used in Add/Revise/Relist calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large retail merchants on the eBay UK site (site ID=3).

In addition to setting the EligibleForPickupDropOff boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing:
  • Have inventory for the product at one or more physical stores tied to the merchant's account.
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the Item.AutoPay flag in the call request and set its value to 'true';
    • Include only one Item.PaymentMethods field in the call request and set its value to 'PayPal';
    • Include a valid PayPal payment address in the Item.PayPalEmailAddress field.


When a UK merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.
Item.PickupInStoreDetails
  .EligibleForPickupInStore
boolean Conditionally This field is used in Add/Revise/Relist calls 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'. A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. 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.

In addition to setting the EligibleForPickupInStore boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the In-Store Pickup option on a multi-quantity, fixed-price listing:
  • Have inventory for the product at one or more physical stores tied to the seller's account. By using the REST-based Inventory Management API API, sellers associate physical stores to their account by using the AddInventoryLocation call, and add product inventory to one or more of these stores by using the AddInventory call. For more information on the Inventory Management API, see the In-Store Pickup Users Guide;
  • Include the seller-defined SKU value of the product(s) in the call request. For a single-variation listing, the SKU value would be specified in the Item.SKU field, and for a multi-variation listing, the SKU value(s) would be specified in the Item.Variations.Variation.SKU field(s);
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the Item.AutoPay flag in the call request and set its value to 'true';
    • Include only one Item.PaymentMethods field in the call request and set its value to 'PayPal';
    • Include a valid PayPal payment address in the Item.PayPalEmailAddress field.


When a seller is successful at listing an item with the In-Store Pickup feature enabled, prospective buyers within a reasonable distance (25 miles or so) from one of the seller's stores (that has stock available) will see the "Available for In-Store Pickup" option on the listing, along with information on the closest store that has the item.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. 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.
Item.PictureDetails PictureDetailsType Conditionally Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture.


Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Introduction to Pictures in Listings.

Item.PictureDetails
  .ExternalPictureURL
anyURI Conditionally When returned this contains the original URL of a self-hosted picture, 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 Working with Pictures in an Item Listing.

Item.PictureDetails
  .GalleryDuration
token Conditionally Describes the number of days that the Featured Gallery type applies to a listing. Applicable values include 'Days_7' and 'LifeTime'.

When a seller chooses Featured as the Gallery type, the listing is highlighted and is included at the top of search results. This functionality is applicable only for Gallery Featured items and returns an error for any other Gallery type. Additionally, an error is returned if the seller attempts to downgrade from Lifetime to limited duration, but the seller can upgrade from limited duration to Lifetime duration. This field is not applicable to auction listings.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

Applicable values: See ListingEnhancementDurationCodeType
Item.PictureDetails
  .GalleryErrorInfo
string Conditionally This indicates the reason why 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 This indicates if the gallery photo upload failed, and gives a reason for the failure, such as 'InvalidUrl' or 'ServerDown'. It is not returned if the gallery photo is uploaded correctly.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ImageNonExistent

(out) We could not find your Gallery image when we went to retrieve it.

•   ImageProcessingError

(out) We were not able to process the image.

•   ImageReadTimeOut

(out) The image failed to come across the Internet when we tried to retrieve it.

•   InvalidFile

(out) There is a problem with the file containing the image.

•   InvalidFileFormat

(out) The file containing your image is not in standard jpeg, bmp, or tif format.

•   InvalidProtocol

(out) URL does not start with http:// - That is the only protocol currently supported for pictures.

•   InvalidUrl

(out) The URL for the image is not valid.

•   Pending

(out) Gallery image has not yet been generated.

•   ServerDown

(out) The server containing your image was unavailable when we tried to retrieve it.

•   Success

(out) Gallery Image successfully generated.


Item.PictureDetails
  .GalleryType
GalleryTypeCodeType Conditionally Specifies the Gallery enhancement type for the listing. These types are accumulative. This means if you use Plus, you also get the features of Gallery and if you use Featured, you get all the features of Gallery and Plus. Passing the values Gallery, Plus, and/or Featured together in the same request will return an error.

Note: Gallery is free on most sites and Featured is supported only on specific sites. For more information about these sites, see the detailed information for Gallery and Featured below. On Gallery-free sites, all listings automatically get the Gallery enhancement. These sites can set this field to Plus or Featured (for sites that support Featured). Do not use the GalleryURL field to specify the Gallery image. The Gallery image will be the first PictureURL in the array of PictureURL fields. This URL will be automatically set as the value of GalleryURL. If the first value of PictureURL is a self-hosted picture, it will be uploaded to EPS (eBay Picture Services) and a thumbnail version will be generated, which will be used on the Search Results Page.

Note: All images must comply to the

On sites where Gallery is not free and no GalleryType value is specified, there will not be a photo of the item in the search results. Instead an icon of a camera appears.

When GalleryType value is set and there are multiple images are specified, eBay checks the available image URLs in the following order to determine which URL to use for the Gallery image:

  1. If specified, use the URL in GalleryURL.
  2. Otherwise, if ProductListingDetails.UseStockPhotoURLAsGallery=true, use the eBay stock photo.
  3. Otherwise, use the value of the first PictureURL in the array of PictureURL fields, if any.
  4. Otherwise, if ProductListingDetails.ProductID is specified, use the eBay stock photo for that ProductID (eBay resets UseStockPhotoURLAsGallery to true in this case).
You cannot remove Gallery, Plus, or Featured when revising an item, however you can upgrade to a higher feature. On upgrade, the original feature fee is credited, and the new feature fee is charged.

There are a number of categories on some eBay sites that always offer the Gallery feature for free. (The API doesn't flag these categories in any metadata calls.) In these categories, if you specify a picture and you don't specify GalleryType, eBay may add GalleryType=Gallery to the listing (for free) and return a warning. The Knowledge Base article below explains a use case that could result in an unexpected gallery fee if the seller moves the item to a category that doesn't offer the free gallery feature. This fee can also appear when the seller moves the item from a site that offers free Gallery (across all its categories) to one where free Gallery is not yet available. Whenever you change the primary category, it is a good idea to clearly specify whether the seller is intentionally requesting the gallery option.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   Featured

(in/out) Highlights the listing by randomly placing it at the top of the search results. When Featured is included in an item listing, the listing also automatically gets the Gallery and Plus functionality at no extra cost.

Sites That Support Featured: You can check if a site supports Featured by using the GeteBayDetails call and passing in ListingFeatureDetails in the DetailName field. In the response, check the ListingFeatureDetails container for FeaturedFirst.

•   Gallery

(in/out) Gallery image is included in the search results. A Gallery image is an image that was uploaded and copied to EPS (eBay Picture Service). This copy is stored for a finite period (usually 30 days) until the image is associated with a listing. Once the image is associated with a listing, the period is extended to 90 days after the item's sale_end date and is extended again if the item is relisted or used in subsequent listings. As part of storing a copy, EPS also makes additional sizes available (thumbnail, main image, zoom layer, supersize popup, etc.), which are used by the various Gallery enhancements.

All images must comply to the

Free Gallery Sites: Many sites support Gallery at no cost. Since this is subject to change, you can determine if a site is a free Gallery site by using VerifyAddItem to check the fees. You can also check the eBay help for the site.

•   None

(in/out) No Gallery enhancement is selected and on sites where Gallery is not free, a camera icon image appears in search results.

This is mainly useful for removing an existing Gallery setting when using RelistItem.

•   Plus

(in/out) Adds a Gallery Plus icon to the listing.

When Plus is selected in a request that specifies at least two eBay Picture Services (EPS) hosted 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 usually the first 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).

Not applicable to eBay Stores Inventory listings.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    KB article: Why am I getting charged a GalleryFee in my RelistItem call...?

Item.PictureDetails.GalleryURL anyURI Always Supported only in Production (not in Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is 'None' or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing.

Note: Many sites support Gallery at no cost. This is subject to change so you can use VerifyAddItem to check the fees. You can also check the eBay help for the site.

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules, see the description of GalleryType above.


(See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See Introduction to Pictures in Listings in the eBay Features Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the GalleryURL value if it was previously specified. Not applicable to eBay Motors listings.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.
Max length: 1024.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    (ReviseItem) DeletedField

Item.PictureDetails
  .PhotoDisplay
PhotoDisplayCodeType Always Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL.

You cannot use PhotoDisplay in combination with Listing Designer layouts. Specify 'None' or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0.

Some PhotoDisplay options can result in listing fees, even when the item is relisted. If you are relisting an item that was originally listed with a PhotoDisplay option, and you do not want that PhotoDisplay enhancement in your relisted item, you need to specifically remove PhotoDisplay in your RelistItem call (or RelistFixedPriceItem, as applicable) by setting PhotoDisplay to None. Use VerifyRelistItem to review your listing fees before you relist an item.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   None

(in/out) No special image display options. Valid for US Motors listings.

•   PicturePack

(in/out) Increase the number of images displayed. This is only available for images hosted with eBay. See GetCategoryFeatures and the online Help (on the eBay site) for additional information.

Picture Pack applies to all sites (including US Motors), except for NL (site ID 146). You can specify a minimum of one EPS picture, or no SuperSize-qualified EPS pictures in the request. For the NL site, PicturePack is replaced with SuperSize.

•   SuperSize

(in/out) Increase the size of each image and allow buyers to enlarge images further. Only available for site-hosted (EPS) images. Not valid for US Motors listings. For all sites that do not automatically upgrade SuperSize to PicturePack (see note below), specifying no SuperSize-qualified images is now accepted in the request.

Note: SuperSize is automatically upgraded to PicturePack for the same SuperSize fee on the US Motors Parts & Accessories Category and US (site ID 0) and CA (site ID 2) and CAFR (site ID 210). This upgrade applies only to EPS images.

•   SuperSizePictureShow

(in/out) This is valid for US Motors listing only. For other listings, use SuperSize.


(Not all values in PhotoDisplayCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Introduction to Pictures in Item Listings
    Fees Resulting from Listing an Item

Item.PictureDetails
  .PictureSource
PictureSourceCodeType Conditionally The service hosting the pictures in PictureURL, if any. This information is primarily useful for Picture Manager subscribers, who pay a flat subscription fee instead of individual picture fees per listing. Only returned when PictureURL is returned.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   EPS

(in/out) The PictureURL images are hosted by eBay Picture Services and the seller is not a Picture Manager subscriber.

•   Vendor

(in/out) The PictureURL images are not hosted by eBay.




DetailLevel: ItemReturnAttributes, ReturnAll.
Item.PictureDetails.PictureURL anyURI Conditionally,
repeatable: [0..24]
Contains a URL for a picture associated with an item; cannot be empty or null. The picture may be hosted on eBay Picture Services (EPS). Some options require hosting through EPS. Alternatively, the picture may be self-hosted.

Note: All images must comply to the eBay determines where the picture is hosted by parsing the value specified in the request. On sites with free gallery, if a listing uses a self-hosted picture (except in the case of a multi-variation listing), the picture will be copied to EPS. The PictureDetails.PictureURL value returned by GetItem will be an EPS URL.

On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL.

On free-gallery sites, eBay selects a Gallery thumbnail from picture URLs in the request (i.e., either the GalleryURL or the first PictureURL), with selection rules that consider which URLs were specified and whether an eBay stock photo exists for the item. eBay selects a picture regardless of whether you specified GalleryType or GalleryURL. Note that a stock photo is not generated unless the following are true: UseStockPhotoURLAsGallery and IncludeStockPhotoURL. Therefore, an item that does not have a PictureURL may have no Gallery picture. Note that a Gallery fee applies only if you set GalleryType to Plus or Featured (as basic Gallery is free). As a result of these changes, under certain scenarios the picture at the top of a listing may not be the picture you specified in PictureURL. For information about selection rules for the gallery thumbnail on sites with free Gallery, see .
To specify multiple pictures, send each URL in a separate, adjacent PictureURL element. In most cases, the picture at the first URL is also used for the picture at the top of a listing.
Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name. On the main eBay site, a listing can have up to 12 EPS-hosted pictures, or one self-hosted picture. You cannot mix self-hosted and EPS-hosted pictures in one listing.

On the US eBay Motors site (for all vehicle listings), and on the eBay Canada site for motors, the picture pack of a listing can contain up to 24 pictures.

If you embed pictures in the description (with IMG tags) instead of using PictureURL, but you want a camera icon to appear in the search and listing pages, specify the following "clear picture" URL in PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif.

Note: On free-gallery sites, the camera icon doesn't display as a gallery thumbnail (or on a listing page) when the first PictureURL field in the request is set to the "clear picture" URL; instead, eBay tries to use the picture referenced by GalleryURL as the gallery thumbnail. If GalleryURL has not been specified, a blank (camera-less) gallery thumbnail displays in the search results and at the top of the listing page. If you set the first PictureURL to the "clear picture" URL, you can specify Item.ProductListingDetails.UseStockPhotoURLAsGallery or Item.ProductListingDetails.UseStockPhotoURL to true, and eBay will use a stock photo, if available, for the gallery thumbnail and for the picture at the top of a listing.

Note that a gallery picture isn't generated if UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to false (or not set) and no alternative picture is in PictureURL. A Gallery fee applies only if you have specified GalleryType as either Plus or Featured (see Item.PictureDetails.GalleryType above for information). See Using Gallery Features on Sites with Free Gallery for information on eBay's selection rules for Gallery pictures on sites with free Gallery.

For VerifyAddItem only: For VerifyAddItem, you can use the following fake eBay Picture Services URL (http://i2.ebayimg.com/abc/M28/dummy.jpg) to verify that your application is obtaining the correct fees for the quantity of pictures you pass in.

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. To remove all PictureURL fields from a listing, specify item.PictureDetails.PictureURL in DeletedField. However, note that if the listing also includes a gallery picture that is based on the first picture in the listing, you may need to supply an alternate picture to use as the gallery picture if you delete all PictureURL fields. Pictures can not be added or removed from a fixed-price listing when the listing is scheduled to end within 12 hours or if the listing has already had transactions.

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. There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for details about fees that could be charged if you change the category in these cases (or when revising a listing from a site with free gallery to one where free gallery is not yet available.)
Max length: 500.

DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    Introduction to Pictures in Item Listings
    Working with Pictures in an Item Listing
    (ReviseItem) DeletedField
    (RelistItem) GalleryType

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.

eBay derives a geographical location from the postal code to display on eBay listing pages. If you do not specify PostalCode, you must specify Item.Location.

Note: If you specify both PostalCode and Location, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item
  .PostCheckoutExperienceEnabled
boolean Conditionally Reserved for future use.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.PrimaryCategory CategoryType Always Category ID for the first (or only) category in which the item is listed (or will be listed, if the item is new). A number of listing features have dependencies on the primary category. We have pointed out a few of the notable dependencies below. See the descriptions of the fields you are using to determine whether the feature you're supporting depends on the listing's primary category.

For the AddItem family of calls: Use calls like GetCategories and GetCategoryFeatures to determine valid values for the site on which you are listing (see the eBay Web Services Guide for information on working with categories). Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill.

There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for information about fees that could be charged if you change the category in these cases.

Coming soon: If you list with a catalog product, eBay may drop the primary category you specify and use the category that is associated with the product instead, if different.

Not applicable to Half.com.

For ReviseItem only: When revising a listing, you can change the primary category only if an item has no bids (or no items have sold) and the listing does not end within 12 hours.

Note: For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. See Item.AttributeSetArray. For the eBay US site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details.

You cannot change the meta-categories for vehicles (i.e., you cannot change a truck to a motorcycle), but you can change the leaf category (e.g., change one motorcycle subcategory to another motorcycle subcategory). See the eBay Web Services Guide for additional rules. International sites (such as the eBay Germany site) have similar rules for revising vehicle categories.

When you list an event ticket on the US site, you must specify the Event Tickets category as the primary category. Also, when revising a listing, you cannot change the primary category from another category to the Event Tickets category. (You need to specify the Event Tickets category when you initially list the item.)

For GetItemRecommendations only: For GetItemRecommendations, use this value to control the category that is searched for recommendations. Specify the category in which the item will be listed.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Applying Categories
    Listing US and CA eBay Motors Items
    (RelistItem) GalleryType

Item.PrimaryCategory
  .CategoryID
string Always Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID.

For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories.
Max length: 10.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.PrimaryCategory
  .CategoryName
string Conditionally Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).

In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings.
Max length: 30.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.PrivateListing boolean Always The PrivateListing boolean field can be used by the seller in the Add/Relist/Revise family of calls to obscure item title, item ID, and item price from post-order Feedback comments left by buyers. Typically, it is not advisable that sellers use the Private Listing feature, but using this feature may be appropriate for sellers listing in Adults Only categories, or for high-priced and/or celebrity items.

For GetItem, order retrieval calls, and other calls that retrieve the Item object, the PrivateListing field is only returned if 'true'.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ProductListingDetails ProductListingDetailsType Conditionally Specifies stock product information to include in a listing. Only applicable when listing items with product details. See the eBay Trading API Guide for information on listing with product details.

As ProductID and ProductReferenceID are defined by eBay, they provide the most reliable means to identify a product. If you use one of the other industry identifiers (e.g., UPC), eBay attempts to find a matching product on your behalf and use it in the listing. If no match is found, you can try using FindProducts in the Shopping API to determine a ProductReferenceID.

When you specify ProductListingDetails, you must specify at least one of the available identifiers (e.g., UPC). If you specify more than one (such as UPC and BrandMPN), eBay uses the first one that matches a product in eBay's catalog system. (This may be useful if you aren't sure which identifier is more likely to result in a match.)

When you specify TicketListingDetails, you must specify the Event Tickets category as the primary category. For other product identifiers: If you list in two categories and the primary and secondary categories are both catalog-enabled, this product identifier should correspond to the primary category (not the secondary category). If only one category is catalog-enabled, the product identifier should correspond to the catalog-enabled category.

Note: As a general rule, the primary category is required. However, if you have trouble finding a catalog-enabled category, you may be able to omit the primary category (except for event tickets). If you do, eBay will attempt to determine an appropriate category based on the product ID (if we find a matching product). When you specify a category that corresponds to the product, your category is used. If we don't find a match in our catalogs, we will list the item in the primary category you specified, without product details. We will not pre-fill the listing's item specifics in this case, and the identifier won't be surfaced in View Item or returned in GetItem. However, it will still be indexed for search on eBay, and it will be searchable by more third-party natural search engines. As this can help buyers find your listing more easily, we strongly recommend that you always use ProductListingDetails to pass in these values. (This product indexing behavior is only available if you use UPC, ISBN, EAN, or GTIN in ProductListingDetails. It is not available if you use ExternalProductID, and it may not be available if you exclusively use Item Specifics.)

Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. (ExternalProductID is no longer recommended.)

For ReviseItem and RelistItem only: If a listing includes product details and you change a category, the rules for continuing to include product details depend on whether or not the new category is mapped to a characteristic set associated with the same product ID. When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product ID and you cannot remove existing product data. However, you can change or add preferences such as IncludeStockPhotoURL, UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all catalog data when you revise or relist an item, specify Item.ProductListingDetails in DeletedField and don't pass ProductListingDetails in the request.

For GetMyeBayBuying only: When products have been added to a buyer's Wish List, the product information is returned in ItemArray.Item.ProductListingDetails within the UserDefinedList node. Products can be added to a buyer's Wish List only. Does not apply to any other user-defined list. The ProductListingDetails node is not included for items in the Wish List.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ReturnAll.
Item.ProductListingDetails
  .BrandMPN
BrandMPNType Conditionally The combination of Brand and MPN (manufacturer part number) can be used as a unique identifier for a product. Please specify both Brand and MPN to ensure a unique product match.

Only used to match catalog products when creating listings (not for buy-side searching).
Item.ProductListingDetails
  .BrandMPN.Brand
string Conditionally The brand of the product. eBay searches against the names that are publicly available in eBay's catalogs. This means you can specify the well-known brand name that an average user would recognize. Specify this in combination with MPN.
Max length: 4000.
Item.ProductListingDetails
  .BrandMPN.MPN
string Conditionally The manufacturer part number of the product. Use the value specified by the manufacturer. (eBay removes special characters and spaces to normalize the values in order to find a match.)
Max length: 4000.
Item.ProductListingDetails
  .Copyright
string Conditionally,
repeatable: [0..*]
Copyright statement indicating the source of the product information. This information will be included in the listing with Pre-filled Item Information. Your application should also display the copyright statement when rendering the Pre-filled Item Information. If more than one copyright statement is applicable, they can be presented to the user in alphabetical order. Returned as HTML.

DetailLevel: ItemReturnAttributes, ReturnAll.
Item.ProductListingDetails.EAN string Conditionally EAN is a unique 8 or 13 digit identifier that many industries (such as book publishers) use to identify products. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).

Only used to match catalog products when creating listings. (In some categories, eBay may also copy the ISBN, UPC, or EAN to the listing's item specifics.)
Max length: 13.
Item.ProductListingDetails
  .IncludePrefilledItemInformation
boolean Conditionally If true, specifies that the listing should include additional information about the product, such as a publisher's description or film credits. Such information is hosted through the eBay site and cannot be edited. If true, Item.Description is optional in item-listing requests.

For GetItem and related calls: The eBay site shows the catalog product description in the product details section of a listing. You cannot download this pre-filled description text via the API. To retrieve a URL for the catalog product details page, see DetailsURL in GetProductSearchResults, GetProductFamilyMembers, or GetProductSellingPages. Or see DetailsURL in FindProducts in the Shopping API (which may be easier to use if your application doesn't support eBay Attributes).

DetailLevel: ItemReturnAttributes, ReturnAll.
Item.ProductListingDetails
  .IncludeStockPhotoURL
boolean Conditionally If true, indicates that the item listing includes the stock photo. To use an eBay stock photo in an item listing, set IncludeStockPhotoURL to true. If a stock photo is available, it is used at the top of the View Item page and in the Item Specifics section of the listing. If you also include Item.PictureDetails.PictureURL, the stock photo only appears in the Item Specifics section of the listing. Other pictures you specify by using Item.PictureDetails.PictureURL appear in a separate section of the listing. If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL to true (and you cannot set it to false). In GetItem, the URL of the stock photo will be returned in StockPhotoURL. If you set IncludeStockPhotoURL to false, the stock photo does not appear in the listing at all.

Note: The following sites offer free Gallery: US and the Parts & Accessories Category on US Motors (site ID 0), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free).

Along with these changes, IncludeStockPhotoURL will be used in the request. In some cases, if IncludeStockPhotoURL is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information.


Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ReturnAll.

See:
    Introduction to Pictures in Item Listings
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.

Item.ProductListingDetails
  .ISBN
string Conditionally ISBN is a unique identifer for books (an international standard). Specify a 10 or 13-character ISBN. If you specify the 13-character ISBN, the value must begin with either 978 pr 979. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).

Only used to match catalog products when creating listings. (In some categories, eBay may also copy the ISBN, UPC, or EAN to the listing's item specifics.)
Max length: 13.
Item.ProductListingDetails
  .ProductID
string Conditionally eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter product ID (ePID) value that is displayed on the eBay Web site, see ProductReferenceID instead.)

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).

In item-listing requests, if you pass in an old product ID, eBay lists the item with the latest version of the product and the latest product ID, and the call returns a warning indicating that the data has changed.

Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, replacing, deleting, or merging some products (as a result of migrating from one catalog data provider to another). If you specify one of these products in a request, the call may return the product with a warning, or it may fail with an error if the product has been deleted.
Max length: 4000.

DetailLevel: ItemReturnAttributes, ReturnAll.
Item.ProductListingDetails
  .StockPhotoURL
anyURI Conditionally Fully qualified URL for a standard image (if any) that is associated with the product. A seller includes the stock photo in the listing by setting IncludeStockPhotoURL.

DetailLevel: ItemReturnAttributes, ReturnAll.
Item.ProductListingDetails.UPC string Conditionally UPC is a unique, 12-character identifier that many industries use to identify products.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).

Only used to match catalog products when creating listings. (In some categories, eBay may also copy the ISBN, UPC, or EAN to the listing's item specifics.)
Max length: 12.
Item.ProductListingDetails
  .UseStockPhotoURLAsGallery
boolean Conditionally If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. When listing an item, IncludeStockPhotoURL must also be true and Item.PictureDetails.GalleryType must be passed in with a value of Gallery or Gallery Featured (but not both). See the eBay Trading API guide for additional validation rules for pictures.

Note: The following sites offer free Gallery:US and the Parts & Accessories Category on US Motors (site ID 0), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free).

Along with these changes, UseStockPhotoURLAsGallery will be used in the request. In some cases, if UseStockPhotoURLAsGallery is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information.



DetailLevel: ItemReturnAttributes, ReturnAll.

See:
    Including Pictures in the Search Results Gallery for complete details on how eBay selects a gallery thumbnail.
    Introduction to Pictures in Item Listings

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 The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the Item.Quantity value indicates the number of identical items the seller has available for purchase in the listing.

For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the Item.Quantity should not be used; instead, the quantity of each variation is specified in the Variation.Variation.Quantity field instead. See the Creating a listing with variations eBay Help page for more information on variations.

For RelistItem, RelistFixedPriceItem, and VerifyRelistItem: Previously in RelistItem, RelistFixedPriceItem, and VerifyRelistItem the Quantity field retained its value from the previous listing unless you specifically changed it by including the field in a relist call and giving it a new value. And this value was often not accurate with the quantity that was really still available for purchase and it was often out of synch with the QuantityAvailable value that is returned with the GetMyeBaySelling call. As of March 13, 2014, this behavior has been changed in the following manner:
  • For a listing that has ended with an available quantity greater than zero, the Quantity value of the newly relisted item is set to the actual QuantityAvailable value (see the GetMyeBaySelling call) when the previous listing ended.
  • For listings that ended with an available quantity of zero, the relisted item will retain the Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had an available quantity of zero when the listing ended, we strongly recommend that you pass in the correct available quantity through the Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value.

You can set the Quantity to 0 (zero) and keep the listing active if OutOfStockControl is set to 'true'.

When eBay auto-renews a GTC listing (ListingDuration=GTC) on your behalf, eBay relists with correct quantity available.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below.
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. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change.

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).

For GetDispute: Quantity is the number of items being raised in the dispute.

For SetCart input, this is only required if the parent container is submitted.

Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings.


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Seller Limits
    Selecting a Selling Format

Item.QuantityAvailableHint QuantityAvailableHintCodeType Conditionally Indicates the type of message that will be returned describing the quantity available for the item.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Limited

(out) The message "Limited quantity available" is shown in the web flow (e.g., for a flash sale or a Daily Deal).

•   MoreThan

(out) The message "More than 10 available" is shown in the web flow. 10 is the value of QuantityThreshold tag based on the seller's preference.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.QuantityInfo QuantityInfoType Conditionally This container is used to set the minimum number of event tickets that should remain available after a buyer makes a purchase. This functionality allows the seller to avoid the possibility of being left with just one event ticket after a sale.

This container can be used when adding, revising, or relisting event tickets, and it will only be returned in GetItem if set for the listing.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.QuantityInfo
  .MinimumRemnantSet
int Conditionally Enables you (the seller) to avoid being left with 1 item in your listing. A typical use case is event tickets in reserved, adjacent seats, or items that typically only sell if more than 1 can be purchased at once.

Specify the minimum number of items that should remain if a buyer doesn't purchase all the items. Based on the value of MinimumRemnantSet and the listing's available quantity (Quantity-QuantitySold), eBay calculates how many items a buyer can purchase. For example, suppose you list 5 tickets, and you want at least 2 tickets remaining for the final buyer to purchase. In this case, you would set MinimumRemnantSet to 2. This means a buyer can purchase 1, 2, 3, or 5 tickets, but not 4 (because 4 would leave the seller with 1 ticket).

To remove this restriction when you revise or relist, set MinimumRemnantSet to 1.

Applicable to multi-quantity, fixed-price listings. Currently supported for US and CA event ticket listings.
Default: 1.

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.
Default: 10.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReasonHideFromSearch ReasonHideFromSearchCodeType Conditionally The enumeration value in this field indicates why the auction listing is being hidden from search on the eBay site. This field is only returned if the HideFromSearch field is returned as 'true' in the GetItem response.

Currently, only auction listings that have been determined to be duplicate listings with zero bids are hidden from search, but there may be other reasons to hide auction listings from search in the future.

This field is associated with eBay Duplicate Listings Policy, which has taken effect 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.

Applicable values:

•   DuplicateListing

(out) This value indicates that the auction listing is being hidden from search on the eBay site because the listing has been determined by eBay to be a duplicate listing with zero bids.

This enumeration is associated with eBay Duplicate Listings Policy, which has taken effect 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.

•   OutOfStock

(out) This value indicates that the listing is hidden from search because the quantity is zero. However, the lising is still alive and will and will reappear in the search results when the quantity is set set to something greater than zero. For more information, see OutOfStockControl.


Item.RelistParentID long Conditionally The eBay Item ID of the current item's parent (original) listing. Only a relisted item will have a parent item, so this field will only be returned if the current item is a relisted item.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReservePrice AmountType (double) Conditionally The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings.

You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings.

The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Revising US eBay Motors Listings
    Reserve Price (eBay Web site help)
    Fees Overview (eBay Web site help)

Item.ReservePrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings.

You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings.

The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing.

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ReturnPolicy ReturnPolicyType Conditionally Container that describes the seller's return policy. Most categories on most eBay sites require the seller to include a return policy through the ReturnPolicy container.

For the AddItem family of calls: Required for most categories on most sites. Use ReturnPolicyEnabled in GetCategoryFeatures to determine which categories require this field. To determine which ReturnPolicy fields can be used on each site, call GeteBayDetails with DetailName set to ReturnPolicyDetails.

eBay India (IN), Australia (AU), and US eBay Motors Parts and Accessories categories typically support but do not require a return policy. (However, we strongly recommend that you specify a clear return policy whenever possible.)

For ReviseItem only: If the listing has bids or sales and it ends within 12 hours, you can't change the return policy details. If the listing is a GTC listing that has sales or ends within 12 hours (one or the other, but not both), you can add a return policy to the GTC listing (but you can't change return policy details if already present). If the listing has no bids or sales and more than 12 hours remain before the listing ends, you can add or change the return policy. When you revise your return policy, you only need to specify the fields you want to add or change. You don't need to specify all the other ReturnPolicy fields again. The other fields will retain their existing settings.

For the GetItem family of calls: Only returned if the site you sent the request to supports the seller's return policy. Typically, the return policy details are only returned when the request is sent to the listing site.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Offering a Clear Return Policy
    (GetCategoryFeatures) Category.ReturnPolicyEnabled for categories that require a return policy
    (GeteBayDetails) ReturnPolicyDetails for return policy fields that each site reports

Item.ReturnPolicy.Description string Conditionally A detailed explanation of the seller's return policy.

eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML, and avoid character entity references (such as &pound; or &#163;). If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. £).

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but does not specify this field when listing the item, GetItem returns this as an empty node

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.
Max length: 5000.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See (GeteBayDetails) ReturnPolicyDetails.Description for sites that support this field.

Item.ReturnPolicy.EAN string Conditionally The European Article Number (EAN) associated with the item, if any. To determine if your site supports this field, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for a 'true' value in the ReturnPolicyDetails.EAN field. Only returned if the seller has specified this value in their return policy.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See (GeteBayDetails) ReturnPolicyDetails.EAN.

Item.ReturnPolicy
  .ExtendedHolidayReturns
boolean Conditionally Note: This field is available for Sandbox testing on the eBay US and UK sites as of version 873, and on the eBay CA/CAFR, DE, AT and AU sites as of version 881. It will be available for Production use on the eBay US and UK sites as of early September 2014, and approximately one year later for the eBay CA/CAFR, DE, AT and AU sites. When you list an item by using the AddItem, ReviseItem and RelistItem families of calls, use this field to enable a holiday returns policy for the item. A value of true indicates the seller is offering the item with an extended holiday returns period.

The extended holiday returns period is defined by three dates:
  • The start date - November 3, 2014.
  • The purchase cutoff date - December 31, 2014.
  • The end date - January 31, 2015.
Note: These dates may vary by a few days each year. Sellers will be notified of the current dates on their eBay site before the holiday period starts. Sellers can specify Extended Holiday Returns (as well as their regular non-holiday returns period) for chosen listings at any time during the year. The Extended Holiday Returns offer is not visible in the listings until the current year's holiday returns period start date, at which point it overrides the non-holiday returns policy. Buyers will see and be subject to the Extended Holiday Returns offer in listings purchased through the purchase cutoff date, and will be able to return those purchases through the end date.

After the purchase cutoff date, the Extended Holiday Returns offer automatically disappears from the listings, and the seller's non-holiday returns period reappears. Purchases made from that point on are subject to the non-holiday returns period, while purchases made before the cutoff date still have until the end date to be returned.

If the value of ExtendedHolidayReturns is false for an item, the returns period specified by the ReturnsWithinOption field applies, regardless of the purchase date. If the item is listed with a policy of no returns, ExtendedHolidayReturns is automatically reset to false.

For the AddItem family of calls, the value of ExtendedHolidayReturns is false by default.

For the ReviseItem family of calls, you can omit ExtendedHolidayReturns from the input if its value does not need to change. If the item being revised has bids or orders, you can add the extended holiday returns option to the listing, but you can't remove it. If the item does not have bids or orders, you can add or remove the extended holiday returns option; however, this is a significant revision, triggering a version change in the listing.

For the RelistItem family of calls, you can omit ExtendedHolidayReturns from the input if its value does not need to change.

For the GetItem call, ExtendedHolidayReturns is returned only if the site you sent the request to supports the seller's return policy. Typically, this is only when the request is sent to the listing site.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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.

Not applicable as input to the AddItem family of calls. (Use RefundOption instead.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReturnPolicy.RefundOption token Conditionally Indicates how the seller will compensate the buyer for a returned item. Use the ReturnPolicy.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details.).

The RefundOption field is not supported by any of the European sites.

Applicable values: To get the applicable RefundOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.Refund.RefundOption fields in the response.

For Add/Revise/Relist/VerifyAdd API calls): If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this RefundOption field when listing the item, some eBay sites may set a default value (like 'MoneyBack'), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For Revise calls only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

Note: As of version 771, listings created, revised, or relisted on the US site with deprecated RefundOption and/or ReturnsWithinOption values (using Add/Revise/Relist API calls) will be blocked.

For RefundOption, the deprecated values for the US site are MerchandiseCredit and Exchange. Instead of these deprecated values, the seller must offer a MoneyBack or a MoneyBackOrExchange refund option. Consider using the MoneyBackOrExchange option when you have the depth of inventory to support an exchange for a different size, color, or undamaged unit. Otherwise, use the MoneyBack option if you have limited inventory.


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See (GeteBayDetails) RefundOption.



Applicable values: See RefundOptionsCodeType
Item.ReturnPolicy
  .RestockingFeeValue
token Conditionally Display string that indicates the restocking fee charged by the seller for returned items. This value is directly related to the RestockingFeeValueOption value, with the difference being that applications can use RestockingFeeValue to present the RestockingFeeValueOption value in a more user-friendly format when used in a GUI features such as option buttons or drop-down lists.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReturnPolicy
  .RestockingFeeValueOption
token Conditionally This enumeration value indicates the restocking fee charged by the seller for returned items. In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy.

For Add/Revise/Relist calls: To obtain the list of applicable values, call GeteBayDetails with DetailName set to ReturnPolicyDetails. Then look for the list of restocking fee value options in the ReturnPolicyDetails.RestockingFeeValue container in the response.

For Get calls: The RestockingFeeValue field is directly related to RestockingFeeValueOption, and gives a user-friendly description of the restocking fee policy.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See GeteBayDetails.ReturnPolicyDetails for applicable values for RestockingFeeValueOption.



Applicable values: See RestockingFeeCodeType
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 Indicates whether the seller allows the buyer to return the item. This field is required when ReturnPolicy is specified. (If you specify ReturnsNotAccepted, the View Item page may initially show the return policy as unspecified. In a future release, the View Item page will be updated to indicate that returns are not accepted instead.)

All sites support the ability for a seller to not accept returns. If the seller doesn't accept returns, the item must specifically indicate ReturnsNotAccepted. (The return policy cannot be omitted from the item.)

On the eBay UK and Ireland sites, business sellers must accept returns for fixed price items (including auction items with Buy It Now, and any other fixed price formats) when the category requires a return policy. On some European sites (such as eBay Germany (DE)), registered business sellers are required to accept returns. Your application can call GetUser to determine a user's current business seller status.

Note: In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, returns must be accepted for the item (ReturnsAcceptedOption=ReturnsAccepted) and handling time should be set to one day (or zero days when same-day shipping becomes available in late May). The handling time is set through the Item.DispatchTimeMax field. Top-Rated listings qualify for the greatest average boost in Best Match and for the 20 percent Final Value Fee discount. For more information on changes to eBay's Top-Rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page.
Applicable values: To get the applicable ReturnsAcceptedOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ReturnsAccepted.Description fields in the response. ReturnsAcceptedOptionsCodeType defines all the possible values.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    (GeteBayDetails) ReturnsAcceptedOption
    Returns and the Law (UK)



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 The buyer can return the item within this period of time from the day they receive the item. Use the ReturnPolicy.Description field to explain the policy details.

Applicable values: To get the applicable ReturnsWithinOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption fields in the response. ReturnsWithinOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this ReturnsWithinOption field when listing the item, some eBay sites may set a default value (like Days_14), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

Note: As of version 771, listings created, revised, or relisted with deprecated RefundOption and/or ReturnsWithinOption values (using Add/Revise/Relist API calls) will be blocked.

For ReturnsWithinOption, the deprecated values are Days_3 and Days_7. Instead of these deprecated values, the seller must offer a 14-day, 30-day, or 60-day return window.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See (GeteBayDetails) ReturnsWithinOption.



Applicable values: See ReturnsWithinOptionsCodeType
Item.ReturnPolicy
  .ShippingCostPaidBy
string Conditionally 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 The party who pays the shipping cost for a returned item. Use the ReturnPolicy.Description field to explain any additional details.

Applicable values: To get the applicable ShippingCostPaidByOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.ShippingCostPaidBy.ShippingCostPaidByOption fields in the response. ShippingCostPaidByOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this ShippingCostPaidByOption field when listing the item, some eBay sites may set a default value (like Buyer), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See (GeteBayDetails) ShippingCostPaidByOption for sites that support this field, and applicable values.



Applicable values: See ShippingCostPaidByOptionsCodeType
Item.ReturnPolicy
  .WarrantyDuration
string Conditionally Display string that buyer applications can use to present WarrantyDurationOption in a more user-friendly format to buyers. For example, 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 WarrantyDuration.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use WarrantyDurationOption instead.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReturnPolicy
  .WarrantyDurationOption
token Conditionally The warranty period.

Applicable values: To get the applicable WarrantyDurationOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyDuration. WarrantyDurationOption fields in the response. WarrantyDurationOptionsCodeType defines all the possible values.

For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyDurationOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See (GeteBayDetails) WarrantyDurationOption.



Applicable values: See WarrantyDurationOptionsCodeType
Item.ReturnPolicy
  .WarrantyOffered
string Conditionally Display string that buyer applications can use to present WarrantyOfferedOption 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 WarrantyOffered.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use WarrantyOfferedOption instead.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReturnPolicy
  .WarrantyOfferedOption
token Conditionally Indicates whether a warranty is offered for the item.

Applicable values: To get the applicable WarrantyOfferedOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyOffered.WarrantyOfferedOption fields in the response. WarrantyOfferedCodeType defines all the possible values.
Note: Only the eBay India site supports this field.
For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyOfferedOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

Note: For the US eBay Motors limited warranty (Short-Term Service Agreement) option, use Item.LimitedWarrantyEligible instead.

For the US eBay Motors "Is There an Existing Warranty?" option, use Item.AttributeSetArray instead.


For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Warranties (eBay India)
    Guidelines for Creating Legally Compliant Listings (eBay India)
    (GeteBayDetails) WarrantyOfferedOption
    (AddItem) Item.LimitedWarrantyEligible for US eBay Motors Short-Term Service Agreement
    (AddItem) Item.AttributeSetArray for US eBay Motors existing warranty option



Applicable values: See WarrantyOfferedCodeType
Item.ReturnPolicy.WarrantyType string Conditionally Display string that buyer applications can use to present WarrantyTypeOption 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 WarrantyType.Description options returned by GeteBayDetails.

Not applicable as input to the AddItem family of calls. (Use WarrantyTypeOption instead.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReturnPolicy
  .WarrantyTypeOption
token Conditionally Indicates the source or type of the warranty, if any.

Applicable values: To get the applicable WarrantyTypeOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyType.WarrantyTypeOption fields in the response. WarrantyTypeOptionsCodeType defines all the possible values.
Note: Only the eBay India site supports this field.
For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyTypeOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field.

For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See (GeteBayDetails) WarrantyTypeOption for sites that support this field, and applicable values.



Applicable values: See WarrantyTypeOptionsCodeType
Item.ReviseStatus ReviseStatusType Always An output value only, indicates whether an item has been revised since the listing became active and, if so, which among a subset of properties have been changed by the revision.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReviseStatus
  .BuyItNowAdded
boolean Always If true, indicates that a Buy It Now Price was added for the item. Only applicable to US eBay Motors items. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReviseStatus
  .BuyItNowLowered
boolean Always If true, indicates that the item's Buy It Now price was lowered. Only applicable to US eBay Motors items. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReviseStatus.ItemRevised boolean Always If true, indicates the item was revised since the listing became active. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReviseStatus
  .ReserveLowered
boolean Always If true, indicates that the reserve price was lowered for the item. Only applicable to US eBay Motors items. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ReviseStatus
  .ReserveRemoved
boolean Always If true, indicates that the reserve price was removed from the item. Only applicable to US eBay Motors items. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SecondaryCategory CategoryType Conditionally ID for second category in which the item is listed (also see Item.PrimaryCategory).

For the AddItem family of calls: Listing an item in a second category is optional. Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill.

Not applicable to Half.com.

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 category as a value category (see ValueCategory in GetCategoryFeatures), items in that category cannot be listed in two categories. For example, if your AddItem request includes a primary or secondary category that is a value category, then eBay drops SecondaryCategory and lists the item with only the PrimaryCategory you selected. Also, if the listing request includes item specifics (in ItemSpecifics or AttributeSetArray) that are associated with SecondaryCategory, eBay drops those values when we drop SecondaryCategory. (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, you can add or change the secondary category only if the listing has no bids (or no items have sold) and it does not end within 12 hours. If you change the secondary category, any corresponding Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the category. See Item.AttributeSetArray.

Note: For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. When you revise an item, you can change the secondary category from a Motors Parts & Accessories category to an eBay category or vice versa if the listing has no bids (or no items have sold) and it does not end within 12 hours.

For GetItemRecommendations only: For GetItemRecommendations, use this to control the category that will be searched for recommendations. Specify the category in which the item will be listed. See the Trading API Guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Applying Categories.

Item.SecondaryCategory
  .CategoryID
string Conditionally Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID.

For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories.
Max length: 10.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SecondaryCategory
  .CategoryName
string Conditionally Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).

In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings.
Max length: 30.

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.

Not applicable to Half.com.

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 If true, indicates that the user has set up an About Me page.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.eBayGoodStanding boolean Always If true, indicates that the user is in good standing with eBay.

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 order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
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.

See:
    Working with Anonymous User Information
    Static Email Addresses in Trading API Calls

Item.Seller.FeedbackPrivate boolean Always Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that 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.

See Working with Anonymous User Information.

Item.Seller.FeedbackRatingStar FeedbackRatingStarCodeType Always Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Item.Seller.IDVerified boolean Always Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.MotorsDealer boolean Conditionally Indicates if item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.NewUser boolean Always If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).

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.
Item.Seller
  .RegistrationAddress
AddressType Conditionally This container consists of the Registration address for the eBay user making the call.

GetUser: eBay returns complete RegistrationAddress details (including Phone), as applicable to the registration site for the eBay user making the call. The RegistrationAddress container will only be returned if the Detail

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.)

DetailLevel: ReturnAll.
Item.Seller
  .RegistrationAddress.CityName
string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. 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.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.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller
  .RegistrationAddress
  .CountryName
string Conditionally The name of the user's country. Also applicable to Half.com (for GetOrders).
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 is set to '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 User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. 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.Phone
string Conditionally User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number.

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
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.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

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 for RegistrationAddress. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller
  .RegistrationAddress.Street1
string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller
  .RegistrationAddress.Street2
string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

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.

See Working with Anonymous User Information.

Item.Seller.SellerInfo SellerType Always Contains information about a seller, including listing settings, listing preferences, seller rankings, and seller type.

This field is replaced by the SellerBusinessType field if the user is a business seller with a site ID of 77 (Germany), ID of 3 (UK), ID of 205 (Ireland) or ID of 0 (US Motors).

See SellerType or SellerBusinessCodeType for the child elements.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .AllowPaymentEdit
boolean Always Indicates whether the user as a seller by default allows buyers to edit the total cost of an item (while in checkout). (Sellers enable this property in their My eBay user preferences on the eBay site.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .CheckoutEnabled
boolean Always This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .CIPBankAccountStored
boolean Always If true, this flag indicates that the seller has stored bank account information on file with eBay. A seller must have stored bank account information on file with eBay in order to use 'CashOnPickup' as a payment method (known as 'Pay upon Pickup' on the site). This field is applicable to all eBay sites that support 'CashOnPickup' as a payment method.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .GoodStanding
boolean Always If true, indicates that the user is in good standing with eBay. (One of the requirements for listing a new item with Immediate Payment.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .MerchandizingPref
MerchandizingPrefCodeType (token) Always Indicates whether the seller participates in the Merchandising Manager feature. If so, the seller can set up rules for cross-promoting items from the seller's store. If not, eBay cross-promotes items as the seller's items are being viewed or purchased.

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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SafePaymentExempt
boolean Always If true, the user is currently exempt from the requirement to offer at least one safe payment method (PayPal/PaisaPay or one of the credit cards specified in Item.PaymentMethods) when listing items. This value should only return true for sellers who registered before January 17, 2007. Otherwise, it should return false. This setting overrides both the site and category values for SafePaymentRequired.
Default: false.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellerBusinessType
SellerBusinessCodeType Conditionally Type of seller account. This value is returned if the German (ID 77), UK (ID 3), Ireland (ID 205), or US eBay Motors (ID 0) sites are specified.

Applicable values:

•   Commercial

(out) Commercial seller account.

•   CustomCode

(out) Reserved for internal or future use.

•   Private

(out) Private seller account.

•   Undefined

(out) Type of seller account not defined.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessConsent
SellereBayPaymentProcessConsentCodeType Conditionally This container is returned to all DE and AT sellers and consists of details of the seller's account status regarding the new eBay payment process. This information includes the seller's payout preferences and whether or not the seller has accepted the supplemental user agreement for the new eBay payment process.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .PayoutMethod
PayoutMethodType Conditionally Enumeration value that indicates the account type that the DE or AT seller has selected as their default seller payout account. Once a DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, that seller must set the default payout account in My eBay preferences. eBay will distribute seller payouts to this account. This field will not be returned if PayoutMethodSet='false'.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

Applicable values:

•   EFT

(out) This value indicates that the seller wants eBay to distribute payouts to their bank account via EFT (Electronic Funds Transfer).

•   MONEYBOOKERS

(out) This value indicates that the seller wants eBay to distribute payouts to their Moneybookers (Skrill) account.

•   PAYPAL

(out) This value indicates that the seller wants eBay to distribute payouts to their PayPal account.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .PayoutMethodSet
boolean Conditionally Flag to indicate whether or not a DE or AT seller has set the payout method type on the account. This field is always returned with the SellereBayPaymentProcessConsent container.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
UserAgreementInfoType Conditionally,
repeatable: [0..*]
Container consisting of details related to the current status of a DE or AT seller signing the required supplemental user agreement for the new eBay payment process. This container will always be returned to DE and AT sellers and the child values that are returned will be dependent on the current SellereBayPaymentProcessStatus value for the seller's account.

If the seller lists items on both the DE and AT sites, a UserAgreementInfo container will be returned for each site, with the sites being distinguished by the UserAgreementInfo.Site value (either 'Germany' or 'Austria').

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .AcceptedTime
dateTime Conditionally This timestamp indicates the date on which the DE or AT seller accepted the supplemental user agreement for the new payment process. Unless the UserAgreementInfo.SellereBayPaymentProcessStatus value is 'MustAcceptUA', this value is always returned with UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .SellereBayPaymentProcessEnableTime
dateTime Conditionally This timestamp indicates the date on which the new eBay payment process was fully enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='eBayPaymentProcessEnabled') or scheduled to be enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='AcceptedUA' or 'MustAcceptUA', and the enable date is known by eBay). Unless the eBay payment process enable date is not known for the seller, this value is always returned with UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .SellereBayPaymentProcessStatus
SellereBayPaymentProcessStatusCodeType Conditionally Enumeration value that indicates whether or not a new DE or AT seller has accepted the supplement user agreement for the new payment process for that site (indicated by the UserAgreementInfo.site value). This value is always returned with the UserAgreementInfo container.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values:

•   AcceptedUA

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use

•   eBayPaymentProcessEnabled

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   MustAcceptUA

(out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo.Site
SiteCodeType Conditionally String value that indicates the site to which the supplemental user agreement information pertains. This value is always returned with the UserAgreementInfo container.

Although this value is based on SiteCodeType (which contains many values), the only values that will be returned here are 'Germany' or 'Austria'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


Applicable values: See Site.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessConsent
  .UserAgreementInfo
  .UserAgreementURL
anyURI Conditionally This is the URL for new eBay payment process supplemental user agreement. This URL is only returned if the UserAgreementInfo.SellereBayPaymentProcessStatus='MustAcceptUA'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellereBayPaymentProcessStatus
SellereBayPaymentProcessStatusCodeType Conditionally This enumeration value indicates the current status of a DE or AT seller's account related to the new eBay payment process.

'AcceptedUA' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, but that same seller's account is not yet ramped up in the new eBay payment process.

'eBayPaymentProcessEnabled' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, and that same seller's account is ramped up in the new eBay payment process.

'MustAcceptUA' is returned if the DE or AT seller has not accepted the supplemental user agreement for the new eBay payment process. If this is the case, the seller can find the URL to the supplemental user agreement in the SellereBayPaymentProcessConsent.UserAgreementInfo.UserAgreementURL field.

Applicable values:

•   AcceptedUA

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   CustomCode

(out) Reserved for internal or future use

•   eBayPaymentProcessEnabled

(out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.

•   MustAcceptUA

(out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted.

Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Seller.SellerInfo
  .SellerLevel
SellerLevelCodeType Always The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list. SellerInfo.SellerLevel is no longer returned in the GetUser, GetBidderList, GetSellerList, GetItem, and GetItemTransactions responses for the US, DE/AT/CH, and UK/IE sites, for version 629 and later. If you are using a version older than 629, SellerInfo.SellerLevel will still be returned. Developers should note that SellerInfo.SellerLevel could potentially be removed from other sites as well.

Applicable values:

•   Bronze

(out) Bronze (lowest tier)

•   CustomCode

(out) Reserved for internal or future use

•   Gold

(out) Gold (between Silver and Platinum)

•   None

(out) Not a PowerSeller (eBay has not yet evaluated your PowerSeller status, or you have not chosen to be a member of the PowerSeller program, or you lost your PowerSeller status due to a policy violation.)

•   Platinum

(out) Platinum (between Gold and Titanium)

•   Silver

(out) Silver (between Bronze and Gold)

•   Titanium

(out) Titanium (highest tier)




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.

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. To determine if a seller is a Store owner, check for the User.SellerInfo.StoreOwner and a value of true. The eBay Stores domain that is returned in this field is based on the SITEID header that is passed in the request, and not on the user's registration address, as was the case prior to version 757. So, if the seller's registration county is the UK, but a SITEID value of 71 (France) is passed into the call, the eBay Stores domain that is returned would be stores.ebay.fr.

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. To qualify as a Top Rated Seller, a seller must meet the following requirements:
  • 100 or more selling transactions in a one-year period
  • Shipment tracking information provided to the buyer within the specified handling time for at least 90 percent of their listings
This field is returned for the following sites only: US (EBAY-US), Motors (EBAY-MOTOR), AT (EBAY-AT), CH (EBAY-CH), DE (EBAY-DE), IE (EBAY-IE) and UK (EBAY-GB).

On the eBay US site, Top Rated Sellers are eligible to receive a Top Rated Plus seal for their listings. For a Top Rated Seller's listing to qualify as a Top Rated Plus listing, that listing must accept returns and the handling time must be set to one day (DispatchTimeMax=1). Top Rated Plus listings get increased visibility in fixed-price searches and receive a Final Value Fee discount.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Top Rated Seller Resource Center for more information about how to become a Top Rated Seller and qualify for Top Rated Plus on the eBay US site
    Seller Help Page for more information about how to qualify as a Top Rated Seller on the eBay US, AT, CH, DE, IE and UK sites

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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Item.Seller.Status UserStatusCodeType Always Indicates the user's registration/user status.

Applicable values:

•   AccountOnHold

(out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items

•   Confirmed

(out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category

•   CreditCardVerify

(out) User has completed registration and confirmation, but needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CreditCardVerifyHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CustomCode

(out) Reserved for internal or future use

•   Deleted

(out) Records for the specified user have been deleted

•   Ghost

(out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay

•   Guest

(out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow.

•   InMaintenance

(out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status

•   Merged

(out) User record has been merged with another account record for the same user

•   RegistrationCodeMailOut

(out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email

•   Suspended

(out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement

•   TermPending

(out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user

•   Unconfirmed

(out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   UnconfirmedHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending

•   Unknown

(out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem


(Not all values in UserStatusCodeType apply to this field.)


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".

Note that 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 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.

See Working with Anonymous User Information.

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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Item.Seller.UserIDLastChanged dateTime Always Date and time the user's data was last changed (in GMT).

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.

See Working with Anonymous User Information.

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:

•   CustomCode

(out) Reserved for internal or future use

•   NoVATTax

(out) VAT is not applicable

•   VATExempt

(out) Residence in a country with VAT and user is registered as VAT-exempt

•   VATTax

(out) Residence in a country with VAT and user is not registered as VAT-exempt




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Value-Added Tax (VAT).

Item.SellerContactDetails AddressType Conditionally Contact information for sellers using the Classified Ad format for eBay Motors vehicles categories. To remove seller contact information when revising or relisting an item, use DeletedField. The seller contact details for the primary and secondary phone numbers cannot be deleted individually.

To provide City, State, and Zip code information in SellerContactDetails use the following field:
Item.SellerContactDetails.Street2

To delete the secondary phone number, for example, you must delete all of the secondary phone fields:
Item.SellerContactDetails.Phone2AreaOrCityCode
Item.SellerContactDetails.Phone2CountryCode
Item.SellerContactDetails.Phone2CountryPrefix
Item.SellerContactDetails.Phone2LocalNumber

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Classified Ad Listings.

Item.SellerContactDetails
  .CompanyName
string Conditionally User's company name. Only returned if available. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerContactDetails
  .County
string Conditionally County information for the user. This field applies to Classified Ad format listings and to the UK only. Not applicable to Half.com.

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 is set to '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
  .Phone2AreaOrCityCode
string Conditionally Area or City Code of a user's secondary phone number. This field applies to Classified Ad format listings only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerContactDetails
  .Phone2CountryCode
CountryCodeType Conditionally Standard ISO code for the country of a user's secondary telephone phone number. For Classifed Ad format 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 format listings only.

Applicable values: See Phone2CountryCode.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerContactDetails
  .Phone2CountryPrefix
string Conditionally Country prefix of a user's secondary phone number. This value is derived from inputs supplied for Phone2CountryCode. This field applies to Classified Ad format listings only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerContactDetails
  .Phone2LocalNumber
string Conditionally The local number portion of the user's secondary phone number. This field applies to Classified Ad format listings only.
Note: The full secondary phone number is constructed by combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix. Starting with API release 497, the full phone number can be entered in Phone2LocalNumber. Refer to the release notes for additional information.
Max length: 30.

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 format 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 primay telephone phone number. For Classifed Ad format 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 format listings only.

Applicable values: See PhoneCountryCode.

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 format 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 format listings only.
Note: The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix. Starting with API release 497, the full phone number can be entered in PhoneLocalNumber. Refer to the release notes for additional information.
Max length: 30.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerContactDetails
  .Street1
string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerContactDetails
  .Street2
string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerProfiles SellerProfilesType Conditionally Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing.
Item.SellerProfiles
  .SellerPaymentProfile
SellerPaymentProfileType Conditionally The SellerPaymentProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.

Business Policies payment profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileID
long Conditionally The unique identifier of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies payment profile. 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 the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileName
string Conditionally The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies payment profile. 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 the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile.

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 Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option, how many days the buyer has to return the item for a refund, warranty information, and restocking fee (if any).

Business Policies return policy profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileID
long Conditionally The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileName
string Conditionally The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the return policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile.

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 Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information.

Business Policies shipping profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID
long Conditionally The unique identifier of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileName
string Conditionally The name of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerProvidedTitle string Conditionally A descriptive free-text title for a US or CA eBay Motors vehicle listing. This title appears below eBay's pre-filled listing title on the View Item page (not at the top of the View Item page). It's also appended to the listing title in search results (like a subtitle) on the US eBay Motors site. Keywords in this title help buyers find or distinguish your listing.

Applicable to listings in US eBay Motors Cars and Trucks, Motorcycle, and some of the Powersport, Boats and RV campers categories; or to Cars and Trucks listings on CA eBay Motors.

This replaces the older US and Canada eBay Motors Subtitle attribute (attribute ID 10246).

Not applicable to Half.com.
Max length: 80.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellerVacationNote string Conditionally The seller is on vacation (as determined by the seller has chosen to add a message to listed items while on vacation.

Not applicable to Half.com.

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 and the current high bidder.

Not applicable to Half.com.

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 that GetItem returns an error (invalid item ID) in the response if Item.SellingStatus.AdminEnded is 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 If true, indicates that the user has set up an About Me page.

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.

See Working with Anonymous User Information.

Item.SellingStatus.HighBidder
  .BuyerInfo.ShippingAddress
AddressType Conditionally Contains the shipping address of the buyer. See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.

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.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

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 is set to '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.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellingStatus.HighBidder
  .eBayGoodStanding
boolean Conditionally If true, indicates that the user is in good standing with eBay.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellingStatus.HighBidder
  .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 order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
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.

See:
    Working with Anonymous User Information
    Static Email Addresses in Trading API Calls

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). Note that 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.

See Working with Anonymous User Information.

Item.SellingStatus.HighBidder
  .FeedbackRatingStar
FeedbackRatingStarCodeType Conditionally Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

Applicable values:

•   Blue

(out) Blue Star, feedback score 50-99.

•   CustomCode

(out) Reserved for internal or future use.

•   Green

(out) Green Star, feedback score 5,000-9,999.

•   GreenShooting

(out) Green Shooting Star, feedback score 500,000-999,999.

•   None

(out) No graphic displayed, feedback score 0-9.

•   Purple

(out) Purple Star, feedback score 500-999.

•   PurpleShooting

(out) Purple Shooting Star, feedback score 50,000-99,999.

•   Red

(out) Red Star, feedback score 1,000-4,999

•   RedShooting

(out) Red Shooting Star, feedback score 100,000-499,999.

•   SilverShooting

(out) Silver Shooting Star, feedback score 1,000,000 and above.

•   Turquoise

(out) Turquoise Star, feedback score 100-499.

•   TurquoiseShooting

(out) Turquoise Shooting Star, feedback score 25,000-49,999.

•   Yellow

(out) Yellow Star, feedback score 10-49.

•   YellowShooting

(out) Yellow Shooting Star, feedback score 10,000-24,999.




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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Item.SellingStatus.HighBidder
  .IDVerified
boolean Conditionally Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellingStatus.HighBidder
  .NewUser
boolean Conditionally If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).

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.
Item.SellingStatus.HighBidder
  .RegistrationAddress
AddressType Conditionally This container consists of the Registration address for the eBay user making the call.

GetUser: eBay returns complete RegistrationAddress details (including Phone), as applicable to the registration site for the eBay user making the call. The RegistrationAddress container will only be returned if the Detail

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.)

DetailLevel: ReturnAll.
Item.SellingStatus.HighBidder
  .RegistrationAddress.CityName
string Conditionally The name of the user's city. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. 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.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.

For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider.

Also applicable to Half.com (for GetOrders).

Applicable values: See Country.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellingStatus.HighBidder
  .RegistrationAddress
  .CountryName
string Conditionally The name of the user's country. Also applicable to Half.com (for GetOrders).
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 is set to '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 User's name for the address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. 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.Phone
string Conditionally User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number.

In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components.

Also applicable to Half.com (for GetOrders).
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.

For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider.

Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. .

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 for RegistrationAddress. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellingStatus.HighBidder
  .RegistrationAddress.Street1
string Conditionally Line 1 of the user's street address. Also applicable to Half.com (for GetOrders).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SellingStatus.HighBidder
  .RegistrationAddress.Street2
string Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .

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.

See Working with Anonymous User Information.

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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Item.SellingStatus.HighBidder
  .Status
UserStatusCodeType Conditionally Indicates the user's registration/user status.

Applicable values:

•   AccountOnHold

(out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items

•   Confirmed

(out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category

•   CreditCardVerify

(out) User has completed registration and confirmation, but needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CreditCardVerifyHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   CustomCode

(out) Reserved for internal or future use

•   Deleted

(out) Records for the specified user have been deleted

•   Ghost

(out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay

•   Guest

(out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow.

•   InMaintenance

(out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status

•   Merged

(out) User record has been merged with another account record for the same user

•   RegistrationCodeMailOut

(out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email

•   Suspended

(out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement

•   TermPending

(out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user

•   Unconfirmed

(out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.)

•   UnconfirmedHalfOptIn

(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending

•   Unknown

(out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem


(Not all values in UserStatusCodeType apply to this field.)


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.

See Working with Anonymous User Information.

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".

Note that 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 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.

See Working with Anonymous User Information.

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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Working with Anonymous User Information.

Item.SellingStatus.HighBidder
  .UserIDLastChanged
dateTime Conditionally Date and time the user's data was last changed (in GMT).

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.

See Working with Anonymous User Information.

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:

•   CustomCode

(out) Reserved for internal or future use

•   NoVATTax

(out) VAT is not applicable

•   VATExempt

(out) Residence in a country with VAT and user is registered as VAT-exempt

•   VATTax

(out) Residence in a country with VAT and user is not registered as VAT-exempt




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Value-Added Tax (VAT).

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
  .ListingStatus
ListingStatusCodeType Always Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.

Applicable values:

•   Active

(out) The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing.

•   Completed

(out) The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding Buy It Now purchases) require the listing status to be Completed before the Final Value Fee is returned.

•   Custom

(out) Reserved for internal or future use.

•   CustomCode

(out) Reserved for internal or future use.

•   Ended

(out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available.




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 This field 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 will only be returned 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. Sellers who are eligible for the In-Store Pickup feature can start listing items in Production with the In-Store Pickup option beginning in late September 2013.

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 and shipping insurance costs.

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 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.

IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing.
Shipping details are not applicable to Real Estate listings and Half.com.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Determining Shipping Costs for a Listing
    Revising a Listing for restrictions on changing item properties with ReviseItem

Item.ShippingDetails
  .AllowPaymentEdit
boolean Conditionally This field is no longer returned and has been replaced by the ShippingDetails.PaymentEdited field.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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.

See Other Shipping Features.

Item.ShippingDetails
  .CalculatedShippingDiscount
  .DiscountName
DiscountNameCodeType Conditionally The type of discount or "rule" that is being used by the profile. Only WeightOff is a "variable" rule, as defined in the documentation on shipping discount profiles.

Applicable values:

•   CombinedItemWeight

(in/out) Shipping cost is based on the total weight of all individual items. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only.

•   IndividualItemWeight

(in/out) Shipping cost is the total of what it would cost to ship each item individually. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only.

•   WeightOff

(in/out) 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. For calculated shipping discount profile only.


(Not all values in DiscountNameCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

Item.ShippingDetails
  .CalculatedShippingDiscount
  .DiscountProfile
DiscountProfileType Conditionally,
repeatable: [0..*]
Details of this particular calculated shipping discount profile. If 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. Restrictions of how many profiles you can have for a given discount rule are discussed in the documentation on shipping discount profiles.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

Item.ShippingDetails
  .CalculatedShippingDiscount
  .DiscountProfile
  .DiscountProfileID
string Conditionally The unique eBay-created ID for the shipping discount, assigned when the profile is created. On input, if ModifyActionCode is Add, this is ignored if provided. If 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
  .CalculatedShippingDiscount
  .DiscountProfile
  .DiscountProfileName
string Conditionally The user's title for this profile. On input, if ModifyActionCode is Add, this is ignored (if provided) if this is the first profile being created and required if there is more than one profile of that type (flat rate versus calculated) already. To modify the name, set ModifyActionCode to Update and provide all details for the profile. On output, DiscountProfileName is only returned if the user defined more than one profile.

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 Delete, any listings currently using the profile identified by DiscountProfileID will have that profile removed. For SetShippingDiscountProfiles and GetItem, this is the intended discount profile mapping.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .CalculatedShippingDiscount
  .DiscountProfile.WeightOff
MeasureType (decimal) Conditionally The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .CalculatedShippingDiscount
  .DiscountProfile.WeightOff
  [ attribute unit ]
token Conditionally The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only.
Item.ShippingDetails
  .CalculatedShippingDiscount
  .DiscountProfile.WeightOff
  [ attribute measurementSystem ]
MeasurementSystemCodeType Conditionally The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only.

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.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
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.) 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 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.) For international calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .CalculatedShippingRate
  .OriginatingPostalCode
string Conditionally Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .CalculatedShippingRate
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

Item.ShippingDetails
  .CalculatedShippingRate
  .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.
Item.ShippingDetails
  .CalculatedShippingRate
  .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.

For a list of possible enumeration values, see MeasurementSystemCodeType.
Item.ShippingDetails
  .CalculatedShippingRate
  .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.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

Item.ShippingDetails
  .CalculatedShippingRate
  .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.)
Item.ShippingDetails
  .CalculatedShippingRate
  .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.)

For a list of possible enumeration values, see MeasurementSystemCodeType.
Item.ShippingDetails
  .CalculatedShippingRate
  .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.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

Item.ShippingDetails
  .CalculatedShippingRate
  .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.)
Item.ShippingDetails
  .CalculatedShippingRate
  .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.)

For a list of possible enumeration values, see MeasurementSystemCodeType.
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. For calculated shipping only.

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. For calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .CalculatedShippingRate
  .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.ShippingDetails
  .CalculatedShippingRate
  .ShippingPackage
ShippingPackageCodeType Conditionally The nature of the package used to ship the item(s). This is required for calculated shipping only. To get the applicable ShippingPackage values for your site, call GeteBayDetails with DetailName set to ShippingPackageDetails, and then look for the ShippingPackageDetails.ShippingPackage fields in the response.

Applicable values: See ShippingPackage.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .CalculatedShippingRate
  .WeightMajor
MeasureType (decimal) Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor>
See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Managing Rate Tables with the API for flat rate shipping that requires this field.

Item.ShippingDetails
  .CalculatedShippingRate
  .WeightMajor
  [ attribute unit ]
token Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor>
See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.
Item.ShippingDetails
  .CalculatedShippingRate
  .WeightMajor
  [ attribute measurementSystem ]
MeasurementSystemCodeType Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor>
See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

For a list of possible enumeration values, see MeasurementSystemCodeType.
Item.ShippingDetails
  .CalculatedShippingRate
  .WeightMinor
MeasureType (decimal) Conditionally See the definition of WeightMajor.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

Note: When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Managing Rate Tables with the API for flat rate shipping that requires this field.

Item.ShippingDetails
  .CalculatedShippingRate
  .WeightMinor
  [ attribute unit ]
token Conditionally See the definition of WeightMajor.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

Note: When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs).
Item.ShippingDetails
  .CalculatedShippingRate
  .WeightMinor
  [ attribute measurementSystem ]
MeasurementSystemCodeType Conditionally See the definition of WeightMajor.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

Note: When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs).

For a list of possible enumeration values, see MeasurementSystemCodeType.
Item.ShippingDetails.CODCost AmountType (double) Conditionally This dollar value indicates the money due from the buyer upon delivery of the item.

This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request.

This field is only returned if set for the listing.

To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to 'PaymentOptionDetails'. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

Item.ShippingDetails.CODCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally This dollar value indicates the money due from the buyer upon delivery of the item.

This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request.

This field is only returned if set for the listing.

To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to 'PaymentOptionDetails'. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .ExcludeShipToLocation
string Conditionally,
repeatable: [0..*]
Use this field 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.

Set ShipToRegistrationCountry to true to have your ExcludeShipToLocation settings applied to your listing. The locations you have excluded display in the Shipping and Handling section of your item listing.

If a buyer's primary ship-to location is a location that you have listed as an excluded ship-to location (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on 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.

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: To enable your default Exclude Ship-To List, you must enable Exclude Shipping Locations and Buyer Requirements in your My eBay Site Preferences. For details, see the KnowledgeBase Article HowTo: ExcludeShipToLocation.

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.

See Other Shipping Features.

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. All are "variable" rules, as defined in the documentation on shipping discount profiles.

Applicable values:

•   EachAdditionalAmount

(in/out) 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 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. For flat shipping discount profile only.

•   EachAdditionalAmountOff

(in/out) 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. For flat shipping discount profile only.

•   EachAdditionalPercentOff

(in/out) 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. For flat rate shipping discount profile only.


(Not all values in DiscountNameCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

Item.ShippingDetails
  .FlatShippingDiscount
  .DiscountProfile
DiscountProfileType Conditionally,
repeatable: [0..*]
Details of this particular flat rate shipping discount profile. If 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. Restrictions of how many profiles you can have for a given discount rule are discussed in the documentation on shipping discount profiles.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

Item.ShippingDetails
  .FlatShippingDiscount
  .DiscountProfile
  .DiscountProfileID
string Conditionally The unique eBay-created ID for the shipping discount, assigned when the profile is created. On input, if ModifyActionCode is Add, this is ignored if provided. If 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
  .DiscountProfileName
string Conditionally The user's title for this profile. On input, if ModifyActionCode is Add, this is ignored (if provided) if this is the first profile being created and required if there is more than one profile of that type (flat rate versus calculated) already. To modify the name, set ModifyActionCode to Update and provide all details for the profile. On output, DiscountProfileName is only returned if the user defined more than one profile.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .FlatShippingDiscount
  .DiscountProfile
  .EachAdditionalAmount
AmountType (double) Conditionally The amount, if the seller specified EachAdditionalAmount as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .FlatShippingDiscount
  .DiscountProfile
  .EachAdditionalAmount
  [ attribute currencyID ]
CurrencyCodeType Conditionally The amount, if the seller specified EachAdditionalAmount as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .FlatShippingDiscount
  .DiscountProfile
  .EachAdditionalAmountOff
AmountType (double) Conditionally The amount, if the seller specified EachAdditionalAmountOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .FlatShippingDiscount
  .DiscountProfile
  .EachAdditionalAmountOff
  [ attribute currencyID ]
CurrencyCodeType Conditionally The amount, if the seller specified EachAdditionalAmountOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .FlatShippingDiscount
  .DiscountProfile
  .EachAdditionalPercentOff
float Conditionally The percent (expressed in decimal, as in .5 for 50%), if the seller specified EachAdditionalPercentOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails.GetItFast boolean Conditionally Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day.

Applicable to Half.com for GetOrders.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .GlobalShipping
boolean Conditionally Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is False, the seller is responsible for specifying an international shipping service for the listing if desired.

When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change.

Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Introduction to Shipping for information about Global Shipping Program eligibility.

Item.ShippingDetails
  .InsuranceDetails
InsuranceDetailsType Always Container for domestic insurance information.

Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details. If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, depending on which subfields are used.

Valid only on the following sites: FR and IT

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InsuranceDetails.InsuranceFee
AmountType (double) Conditionally Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InsuranceDetails.InsuranceFee
  [ attribute currencyID ]
CurrencyCodeType Conditionally Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InsuranceDetails
  .InsuranceOption
InsuranceOptionCodeType Conditionally Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   IncludedInShippingHandling

(in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.

•   NotOffered

(in/out) The seller does not offer shipping insurance to the buyer.

•   NotOfferedOnSite

(out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites.

•   Optional

(in/out) The seller offers the buyer the choice of paying for shipping insurance or not.

•   Required

(in/out) The seller requires that the buyer pay for shipping insurance.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InsuranceFee
AmountType (double) Conditionally Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request.

Valid only on the following sites: FR and IT
Applicable to Half.com for GetOrders.
Default: 0.00.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InsuranceFee
  [ attribute currencyID ]
CurrencyCodeType Conditionally Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request.

Valid only on the following sites: FR and IT
Applicable to Half.com for GetOrders.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InsuranceOption
InsuranceOptionCodeType Conditionally Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored.

Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged.
This field is only returned if the value is other than NotOffered.

Valid only on the following sites: FR and IT
If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing.

Applicable to Half.com

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   IncludedInShippingHandling

(in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.

•   NotOffered

(in/out) The seller does not offer shipping insurance to the buyer.

•   NotOfferedOnSite

(out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites.

•   Optional

(in/out) The seller offers the buyer the choice of paying for shipping insurance or not.

•   Required

(in/out) The seller requires that the buyer pay for shipping insurance.




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.

See Other Shipping Features.

Item.ShippingDetails
  .InternationalCalculatedShippingDiscount
  .DiscountName
DiscountNameCodeType Conditionally The type of discount or "rule" that is being used by the profile. Only WeightOff is a "variable" rule, as defined in the documentation on shipping discount profiles.

Applicable values:

•   CombinedItemWeight

(in/out) Shipping cost is based on the total weight of all individual items. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only.

•   IndividualItemWeight

(in/out) Shipping cost is the total of what it would cost to ship each item individually. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only.

•   WeightOff

(in/out) 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. For calculated shipping discount profile only.


(Not all values in DiscountNameCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

Item.ShippingDetails
  .InternationalCalculatedShippingDiscount
  .DiscountProfile
DiscountProfileType Conditionally,
repeatable: [0..*]
Details of this particular calculated shipping discount profile. If 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. Restrictions of how many profiles you can have for a given discount rule are discussed in the documentation on shipping discount profiles.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

Item.ShippingDetails
  .InternationalCalculatedShippingDiscount
  .DiscountProfile
  .DiscountProfileID
string Conditionally The unique eBay-created ID for the shipping discount, assigned when the profile is created. On input, if ModifyActionCode is Add, this is ignored if provided. If 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
  .InternationalCalculatedShippingDiscount
  .DiscountProfile
  .DiscountProfileName
string Conditionally The user's title for this profile. On input, if ModifyActionCode is Add, this is ignored (if provided) if this is the first profile being created and required if there is more than one profile of that type (flat rate versus calculated) already. To modify the name, set ModifyActionCode to Update and provide all details for the profile. On output, DiscountProfileName is only returned if the user defined more than one profile.

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 Delete, any listings currently using the profile identified by DiscountProfileID will have that profile removed. For SetShippingDiscountProfiles and GetItem, this is the intended discount profile mapping.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InternationalCalculatedShippingDiscount
  .DiscountProfile.WeightOff
MeasureType (decimal) Conditionally The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InternationalCalculatedShippingDiscount
  .DiscountProfile.WeightOff
  [ attribute unit ]
token Conditionally The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only.
Item.ShippingDetails
  .InternationalCalculatedShippingDiscount
  .DiscountProfile.WeightOff
  [ attribute measurementSystem ]
MeasurementSystemCodeType Conditionally The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only.

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.

See Other Shipping Features.

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. All are "variable" rules, as defined in the documentation on shipping discount profiles.

Applicable values:

•   EachAdditionalAmount

(in/out) 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 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. For flat shipping discount profile only.

•   EachAdditionalAmountOff

(in/out) 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. For flat shipping discount profile only.

•   EachAdditionalPercentOff

(in/out) 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. For flat rate shipping discount profile only.


(Not all values in DiscountNameCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

Item.ShippingDetails
  .InternationalFlatShippingDiscount
  .DiscountProfile
DiscountProfileType Conditionally,
repeatable: [0..*]
Details of this particular flat rate shipping discount profile. If 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. Restrictions of how many profiles you can have for a given discount rule are discussed in the documentation on shipping discount profiles.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Other Shipping Features.

Item.ShippingDetails
  .InternationalFlatShippingDiscount
  .DiscountProfile
  .DiscountProfileID
string Conditionally The unique eBay-created ID for the shipping discount, assigned when the profile is created. On input, if ModifyActionCode is Add, this is ignored if provided. If 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
  .DiscountProfileName
string Conditionally The user's title for this profile. On input, if ModifyActionCode is Add, this is ignored (if provided) if this is the first profile being created and required if there is more than one profile of that type (flat rate versus calculated) already. To modify the name, set ModifyActionCode to Update and provide all details for the profile. On output, DiscountProfileName is only returned if the user defined more than one profile.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InternationalFlatShippingDiscount
  .DiscountProfile
  .EachAdditionalAmount
AmountType (double) Conditionally The amount, if the seller specified EachAdditionalAmount as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InternationalFlatShippingDiscount
  .DiscountProfile
  .EachAdditionalAmount
  [ attribute currencyID ]
CurrencyCodeType Conditionally The amount, if the seller specified EachAdditionalAmount as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InternationalFlatShippingDiscount
  .DiscountProfile
  .EachAdditionalAmountOff
AmountType (double) Conditionally The amount, if the seller specified EachAdditionalAmountOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InternationalFlatShippingDiscount
  .DiscountProfile
  .EachAdditionalAmountOff
  [ attribute currencyID ]
CurrencyCodeType Conditionally The amount, if the seller specified EachAdditionalAmountOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InternationalFlatShippingDiscount
  .DiscountProfile
  .EachAdditionalPercentOff
float Conditionally The percent (expressed in decimal, as in .5 for 50%), if the seller specified EachAdditionalPercentOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InternationalInsuranceDetails
InsuranceDetailsType Always Container for international insurance information.

Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details. If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) are set to for flat and calculated shipping, depending on which subfields are used.

Valid only on the following sites: FR and IT

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InternationalInsuranceDetails
  .InsuranceFee
AmountType (double) Conditionally Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .InternationalInsuranceDetails
  .InsuranceFee
  [ attribute currencyID ]
CurrencyCodeType Conditionally Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InternationalInsuranceDetails
  .InsuranceOption
InsuranceOptionCodeType Conditionally Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use

•   IncludedInShippingHandling

(in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.

•   NotOffered

(in/out) The seller does not offer shipping insurance to the buyer.

•   NotOfferedOnSite

(out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites.

•   Optional

(in/out) The seller offers the buyer the choice of paying for shipping insurance or not.

•   Required

(in/out) The seller requires that the buyer pay for shipping insurance.




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.

See Other Shipping Features.

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.

See Other Shipping Features.

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, only four other international shipping services may be offered (regardless of whether or not Global 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) 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.

Not applicable to Half.com or eBay Motors vehicle listings.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Overview of the API Schema 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 beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only.

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 beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified, GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Shipping.

Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified, GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

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.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.

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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Locations to Where You Ship.



Applicable values: See CountryCodeType, ShippingRegionCodeType
Item.ShippingDetails
  .PaymentInstructions
string Conditionally Payment instructions (or message) from the seller to the buyer. These instructions appear on eBay's View Item page and on eBay's checkout page when the buyer pays for the item.

Sellers usually use this field to specify payment instructions, how soon the item will shipped, feedback instructions, and other reminders that the buyer should be aware of when they bid on or buy an item. This field can be specified regardless of the shipping type eBay only allows 500 characters as input, but due to the way the eBay Web site UI treats characters, this field can return more than 500 characters in the response. Characters like & and ' (apostrophe/single quote) count as 5 characters each. Use DeletedField to remove this value when revising or relisting an item.

Applicable to eBay Motors (usually used to elaborate on the return policy).
Not applicable to Half.com.
Max length: 1000.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Offering a Clear Return Policy
    (AddItem) Item.AttributeSetArray
    (GetItem) Item.AttributeSetArray

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.

See Other Shipping Features.

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.

See Other Shipping Features.

Item.ShippingDetails
  .PromotionalShippingDiscountDetails
  .DiscountName
DiscountNameCodeType Conditionally The type of promotional shipping discount that is detailed in the profile. If MaximumShippingCostPerOrder, see ShippingCost. If ShippingCostXForAmountY, see ShippingCost and OrderAmount. If ShippingCostXForItemCountN, see ShippingCost and ItemCount.

Applicable values:

•   MaximumShippingCostPerOrder

(in/out) The shipping cost will not exceed this. For promotional discount only.

•   ShippingCostXForAmountY

(in/out) Shipping cost X applies if the total cost of items purchased is Y. For promotional discount only.

•   ShippingCostXForItemCountN

(in/out) Shipping cost X applies if the total number of items purchased is N. For promotional discount only.


(Not all values in DiscountNameCodeType apply to this field.)


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 specifies the shipping rate tables that are to be applied to this listing. Shipping rate tables enable sellers to tailor the flat shipping rates offered for an item to fit the shipping destination. They can specify a shipping rate for a large base region, then define alternative rates or surcharges for shipping to other extended regions within the base region.

Prerequisites for applying shipping rate tables:
  • The shipping type for the listing must be Flat.
  • The seller must have previously configured a shipping rate table in My eBay site preferences.
In a domestic shipping rate table, sellers can specify an alternative shipping rate for each shipping service category, for each of several extended domestic regions within their country. For example, in the US the shipping categories are Economy, Standard, Expedited and One-day. The extended regions are Alaska and Hawaii, US Protectorates, and Army/Fleet Post Offices.

In an international shipping rate table, sellers can specify an alternative shipping rate for each shipping service category, for each country in a given base region. The international rate table has nine base regions: Africa, Asia, Central America and Caribbean, Europe, Middle East, North America, Oceania, Southeast Asia, and South America. You can use the GetUser call to determine if the seller has configured a shipping rate table. If the domestic shipping rate table is available for this seller, the User.SellerInfo.DomesticRateTable field will be true. If the international shipping rate table is available for this seller, the User.SellerInfo.InternationalTable field will be true.

Note: You can use RateTableDetails to apply a shipping rate table to a listing or remove it from a listing. However, the details of a shipping rate table configuration can only be viewed and modified on the eBay website, not by using the API. Sellers use a dropdown list to specify the alternative shipping rate applied by the rate table as one of the following:
  • A flat amount per item
  • A flat surcharge (domestic rate tables only)
  • A surcharge by weight
This selection applies to the entire table; there is no mixing and matching by region or shipping category.

If you are applying a shipping rate table that specifies a surcharge by weight, you must specify the item weight in the ShippingDetails.CalculatedShippingRate container's WeightMajor and WeightMinor fields, even though this is a flat rate listing. Do not use any other fields in the CalculatedShippingRate container because those are not supported in this scenario.

Note: There is currently no way to determine through the API whether a seller's rate table specifies a surcharge by weight, so your application must make it clear to the seller that item weight must be supplied if the seller has specified a surcharge by weight. If the required weight values are not supplied, a default weight of one unit (1 lb or 1 kg, depending on locale) is used as the basis for the surcharge. This container is returned from the GetItem family of calls only for the seller who listed the item.

You can find more information about using shipping rate tables in the Shipping chapter of the Trading API User's Guide.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

Item.ShippingDetails
  .RateTableDetails
  .DomesticRateTable
string Conditionally This field specifies which domestic shipping rate table to apply to a listing. Domestic rate tables can be used only for items listed on the eBay US, UK, DE, AU and Motors Parts and Accessories websites.

Currently, sellers can configure only one domestic shipping rate table, so set DomesticRateTable = Default to apply that table. The rates assigned to the various domestic regions are applied depending on the location of the buyer. If only one shipping service category and rate has been set for a given domestic region in the domestic rate table, buyers in that region will see only one shipping cost. If several service levels and rates are set up in the domestic shipping rate table for a given domestic region, buyers in that region will see the different shipping levels and rates and can choose one of them.

If you are modifying or relisting an item (using the Revise or Relist family of calls), you can delete the existing rate table setting applied to the listing by using the empty tag: <DomesticRateTable />

This field is returned from the GetItem family of calls only for the seller who listed the item.

You can find more information about using shipping rate tables in the Shipping chapter of the Trading API User's Guide.
Max length: 50.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

Item.ShippingDetails
  .RateTableDetails
  .InternationalRateTable
string Conditionally This field specifies which international shipping rate table to apply to a listing. International rate tables can be used only for items listed on the DE or UK site.

Currently, sellers can configure only one international shipping rate table, so set InternationalRateTable = Default to apply that table. The rates assigned to the various countries are applied depending on the location of the buyer. If only one shipping service category and rate has been set for a given country in the international rate table, buyers in that country will see only one shipping cost. If several service levels and rates are set up in the international shipping rate table for a given country, buyers in that country will see the different shipping levels and rates and can choose one of them.

If you are modifying or relisting an item (using the Revise or Relist family of calls), you can delete the existing rate table setting applied to the listing by using the empty tag: <InternationalRateTable />

This field is returned from the GetItem family of calls only for the seller who listed the item.

You can find more information about using shipping rate tables in the Shipping chapter of the Trading API User's Guide.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

Item.ShippingDetails.SalesTax SalesTaxType Conditionally Sales tax details. US and US Motors (site 0) sites only, excluding vehicle listings. Flat and calculated shipping.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Enabling Multi-jurisdiction Sales Tax.

Item.ShippingDetails.SalesTax
  .SalesTaxPercent
float Conditionally Percent of an item's price to be charged as the sales tax for the order. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails.SalesTax
  .SalesTaxState
string Conditionally State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value.

To see the valid values for your site, call GeteBayDetails with DetailName set to TaxJurisdiction, and then look for the TaxJurisdiction.JurisdictionID fields in the response.

Applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails.SalesTax
  .ShippingIncludedInTax
boolean Conditionally (US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping.

Applicable to Half.com (for GetOrders).

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.

See Other Shipping Features.

Item.ShippingDetails
  .ShippingServiceOptions
ShippingServiceOptionsType Always,
repeatable: [1..*]
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified.

For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs.

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>
<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>

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. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

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.

Not applicable to Half.com or eBay Motors vehicle listings.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Overview of the API Schema 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 Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .ShippingServiceOptions
  .FreeShipping
boolean Conditionally A seller offers free shipping by setting FreeShipping to true. This free shipping applies only to the first specified domestic shipping service. (It is ignored if set for any other shipping service.) If the seller has required shipping insurance as part of shipping (the seller set InsuranceOption to Required) and then the seller specified FreeShipping, eBay sets the insurance cost to 0.00. However, if the seller made shipping insurance optional, eBay preserves the cost of shipping insurance; it is up to the buyer whether to buy shipping insurance, regardless of whether the seller specified FreeShipping.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Services.

Item.ShippingDetails
  .ShippingServiceOptions
  .LogisticPlanType
string Conditionally Reserved for internal or future use.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingService
token Conditionally A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, 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.

For flat and calculated shipping. Also applicable to Half.com (for GetOrders).

If there are two or more services and one is "pickup", "pickup" must not be specified as the first 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 beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Determining Shipping Costs for a Listing.

Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) 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 GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

Also applicable to Half.com (for GetOrders).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Determining Shipping Costs for a Listing.

Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) 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 GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse).

Also applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .ShippingServiceOptions
  .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 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.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
AmountType (double) Conditionally An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMax
int Conditionally The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingTimeMin
int Conditionally The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.

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 as 'Worldwide' for an item, but has not specified any international shipping service options, 'NotSpecified' is returned as the ShippingType value.

Not applicable to Half.com.

Applicable values:

•   Calculated

(in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.

•   CalculatedDomesticFlatInternational

(in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.

•   CustomCode

(in/out) Reserved for future use.

•   Flat

(in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.

•   FlatDomesticCalculatedInternational

(in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.

•   FreightFlat

(in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item.

Currently, FreightFlat is available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. On the US site, FreightFlat applies to shipping with carriers that are not affiliated with eBay. For details about freight shipping, see "Specifying Freight Shipping" in the Shipping chapter of the User's Guide.

•   NotSpecified

(in/out) The seller did not specify the shipping type.


(Not all values in ShippingTypeCodeType apply to this field.)


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 is set to ReturnAll or ItemReturnDescription (in this case, the value of IncludeTaxTable does not matter).
- IncludeTaxTable is set to true and DetailLevel is not set or it is set to ItemReturnAttributes.

Not applicable to Half.com.

DetailLevel: ItemReturnDescription, ReturnAll.
Item.ShippingDetails.TaxTable
  .TaxJurisdiction
TaxJurisdictionType Conditionally,
repeatable: [0..*]
Sales tax details for zero or more jurisdictions (states, provinces, etc).

For GetTaxTable: If DetailLevel is not specified, information is returned only for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned, but are empty.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails.TaxTable
  .TaxJurisdiction
  .JurisdictionID
string Conditionally Representative identifier for the jurisdiction. Typically an abbreviation (for example, CA for California).

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails.TaxTable
  .TaxJurisdiction
  .SalesTaxPercent
float Conditionally The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).
For GetTaxTable: this tag has no value if the user's tax table has not been set.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails.TaxTable
  .TaxJurisdiction
  .ShippingIncludedInTax
boolean Conditionally Whether shipping costs are to be part of the base amount that is taxed.
For GetTaxTable: This tag is empty if the user did not previously provide information.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingDetails
  .ThirdPartyCheckout
boolean Always Deprecated as of version 729. No longer functional.
As of July 1, 2011, third-party applications can no longer be used for checkout. All purchased items must go through the eBay Checkout flow.

This field can no longer be passed into the Add Item family of calls.

This field will be returned in some calls (that return the ShippingDetails container) if it was set to True at listing time (for listings created before July 1, 2011). If this field was set to True at listing time, the user must include this field and set it to False in the Relist and Revise Item family of calls. Otherwise, the caller may get an error.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Deprecation version: 729. See also Deprecated Objects.
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.
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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

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.
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.

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.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

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.)
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.)

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.)

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Specifying Shipping Types and Costs.

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.)
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.)

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.

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. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Required on input when calculated shipping is used.

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. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Required on input when calculated shipping is used.
Item.ShippingPackageDetails
  .WeightMajor
  [ attribute measurementSystem ]
MeasurementSystemCodeType Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Required on input when calculated shipping is used.

For a list of possible enumeration values, see MeasurementSystemCodeType.
Item.ShippingPackageDetails
  .WeightMinor
MeasureType (decimal) Conditionally See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.)

Required on input when calculated shipping is used.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.ShippingPackageDetails
  .WeightMinor
  [ attribute unit ]
token Conditionally See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.)

Required on input when calculated shipping is used.
Item.ShippingPackageDetails
  .WeightMinor
  [ attribute measurementSystem ]
MeasurementSystemCodeType Conditionally See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.)

Required on input when calculated shipping is used.

For a list of possible enumeration values, see MeasurementSystemCodeType.
Item
  .ShippingTermsInDescription
boolean Conditionally Indicates whether details about shipping costs and arrangements are specified in the item description.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Search Results and Shipping Costs.

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. Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which international locations are valid for the site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields.

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.

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).

Not applicable to Half.com.
Max length: length of longest name in ShippingRegionCodeType and CountryCodeType.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    ShipToLocations
    GeteBayDetails



Applicable values: See CountryCodeType, ShippingRegionCodeType
Item.Site SiteCodeType Always The name of the site on which the item is listed. 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 Web 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 Web site, the visibility of the item in some types of searches, 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).

Not applicable to Half.com.

Applicable values: See Site.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    The US and International eBay Sites
    Specifying the Target Site
    Field Differences for eBay Sites

Item.SKU SKUType (string) Conditionally 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. 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.)

A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.

If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method.

If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing.

For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier.

Note: The eBay Web site UI 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 GetMyeBaySelling, this is only returned if set.
Not applicable to Half.com.
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.SkypeContactOption SkypeContactOptionCodeType Conditionally,
repeatable: [0..*]
Indicates the Skype contact option that the seller and buyer can use to communicate about the listing. For Skype communication to be possible, the SkypeEnabled flag must be included and set to 'true'. The seller must also have a Skype account that is linked with his or her eBay account.

More than one Skype contact option may be specified.

Applicable values:

•   Chat

(in/out) The seller can communicate with the buyer by Skype Chat.

•   CustomCode

(in/out) Reserved for internal or future use.

•   Voice

(in/out) The seller can communicate with the buyer by Skype Voice.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SkypeEnabled boolean Conditionally Specifies that Skype-related information is included with an item listing, including, for example, Skype Voice. Skype-related information provides buttons that enable potential buyers to contact sellers through Skype. Information about Skype is available at www.Skype.com. If all of the prerequisites for adding Skype buttons to listings are met (see the eBay Web Services Guide), you can make communication through Skype available in listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are specified.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.SkypeID string Conditionally The Skype name of the seller. Requires that SkypeEnabled is set to true. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.StartPrice AmountType (double) Always This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. 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.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Seller Limits
    GeteBayDetails

Item.StartPrice
  [ attribute currencyID ]
CurrencyCodeType Conditionally This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted.

For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For fixed-price listings: This is the fixed-price at which a buyer may purchase the item.

For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types.

Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. 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.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.

For a list of possible enumeration values, see CurrencyCodeType.
Item.Storefront StorefrontType Conditionally Contains information related to the item in the context of a seller's eBay Store. Applicable for auction and fixed-price listings listed by eBay Stores sellers.

Not applicable to Half.com.

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).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
Max length: 55.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Removing/Changing a Field When Relisting an Item
    (RelistItem) DeletedField
    Specifying a Subtitle for a Motors Vehicle Listing

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). Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Title string Always Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

For the AddItem family of calls: Not applicable to Half.com.

For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours.

Note: For some large merchants, there are no limitations on when the Item Title for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations.
Max length: 80.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.TopRatedListing boolean Conditionally This field applies only to the US site, and will be returned only if the US seller qualifies as a Top-Rated Seller.

If this flag is returned for a listing, it indicates that the listing meets the new requirements for a Top-Rated Plus listing. A Top-Rated Plus listing must meet the following requirements:
  • 14-day (or longer) return policy with Money Back option
  • 1-day Handling Time or better

A Top-Rated Plus seal appears on the View Item page for qualifying listings. Top-Rated Sellers get a 20 percent discount on their Final Value Fee for all listings that qualify as Top-Rated Plus.

See eBay's Top Rated Seller Resource Center for more information about how to qualify as a Top-Rated Seller.
Item.UnitInfo UnitInfoType Conditionally Contains 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 UnitInfo data and the item's listed price to calculate and display the per-unit price on eBay EU sites.

With GetItem, this container is returned only when you provide IncludeItemSpecifics in the request and set it to true.

Note: This information is currently required only for EU business sellers, and only for listings with a Buy It Now option.
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 Unit 

With GetItem, this field is returned only when you provide IncludeItemSpecifics in the request and set it to true.
Item.UUID UUIDType (string) Conditionally Universally unique constraint tag. Use UUID to ensure that you only list a particular item once, particularly if you are listing many items at once. If you add an item and do not get a response, resend the request with the same UUID. If the item was successfully listed the first time, you will receive an error message for trying to use a UUID that you have already used. The error will also include the item ID for the duplicated item and a boolean value indicating whether the duplicate UUID was sent by the same application.

We recommend you use Item.UUID with calls that add item objects (for example, AddItem and RelistItem). For calls that modify an existing item, such as ReviseItem, use InvocationID instead.

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 item listings on all sites.

Also applicable as input to AddItem and related calls when you list items to Half.com.
Max length: 32.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Variations VariationsType Conditionally Variations are multiple similar (but not identical) items in a single 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). 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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Configuring Variations for a Listing.

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.

See Describing Variations in a Listing.

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). However, only one picture may be used if that picture is hosted outside of eBay. 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.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
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.

On sites with free gallery, if you use a self-hosted picture for a variation, eBay copies the picture and hosts it in eBay Picture Services (EPS). In eBay's View Item page, the variation shows the EPS-hosted picture. GetItem returns the EPS picture in VariationSpecificPictureSet.PictureURL, and it returns the self-hosted picture in VariationSpecificPictureSet.ExternalPictureURL. (If the copying process fails, the original (self-hosted) picture is returned in both ExternalPictureURL and PictureURL.)

Note: All images must comply to the

This is returned only when the seller used a self-hosted picture for the variation.
Max length: 150.

outputSelector: Variations.

See Working with Pictures in an Item Listing.

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 images hosted by eBay Picture Services (EPS). However, only one picture may be used if that picture is hosted outside of eBay. eBay Picture Services and self-hosted images can never be combined into the same variation specific picture set. To specify multiple eBay Picture Services images, use multiple PictureURL fields, passing in a distinct URL in each of those fields. If specified, this field cannot have an empty/null value.

The picture located at the URL 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: All images must comply to the

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 URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name. Variation pictures can not 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 variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes.

When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers.

When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0.

Variation, Pictures, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Multi-Variation Listings.

Item.Variations.Variation
  .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, UK, and German (DE) sites, while MAP is available only on the US site.

Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a "special account flag" (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. Sellers should contact their account manager or Customer Service to see if they qualify for the Strikethrough Pricing program.

As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing. The following link details your legal obligations when you utilize Discount Pricing to sell items: Strikethrough Pricing Requirements

For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem: If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Displaying Discount Pricing Information to Buyers.

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.
Item.Variations.Variation
  .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.Variations.Variation
  .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.Variations.Variation
  .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:

•   CustomCode

(in/out) Reserved for future use.

•   DuringCheckout

(in/out) DuringCheckout specifies that the discounted price must be shown on the eBay checkout flow page.

•   None

(in/out) None means the discount price is not shown via either PreCheckout nor DuringCheckout.

•   PreCheckout

(in/out) PreCheckout specifies that the buyer must click a link (or a button) to navigate to a separate page (or window) that displays the discount price. eBay displays the discounted item price in a pop-up window.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Variations.Variation
  .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.Variations.Variation
  .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.Variations.Variation
  .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:

•   CustomCode

(out) Reserved for future use.

•   MAP

(out) MAP stands for MinimumAdvertisedPrice

•   MFO

(out) MFO means stands for MadeForOutletComparisonPrice.

•   None

(out) None means neither STP nor MinimumAdvertisedPrice.

•   STP

(out) STP stands for Strike Through Pricing.




DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Variations.Variation
  .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, SoldOneBay takes precedence.
Default: false.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
Item.Variations.Variation
  .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.Variations.Variation
  .Quantity
int Conditionally This value indicates the quantity of items in the specific variation that are available for purchase. If you set Variation.Quantity to '0' when you create, revise, or relist an item listing, the variation is dropped from the listing.

For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total number of items associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract SellingStatus.QuantitySold from this value.

For RelistFixedPriceItem: Previously in RelistFixedPriceItem, the Variation.Quantity field retained its value from the previous listing unless you specifically changed it by including the field in a relist call and giving it a new value. And this value was often not accurate with the variation quantity that was really still available for purchase. As of March 13, 2014, this behavior has been changed in the following manner:
  • For an item variation that had an available quantity greater than zero when the listing ended, the Quantity value of the item variation for the newly relisted item is set to the actual quantity available. For item variations, there is actually no QuantityAvailable field, but this value may be derived if you look at the corresponding item variation in a GetMyeBaySelling) response and subtract the Variation.QuantitySold value from the Variation.Quantity value, which represents the original Variation.Quantity value at creation time of the previous listing.
  • For item variations with an available quantity of zero when the listing ended, the relisted item will retain the Variaton.Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had one or more item variations with an available quantity of zero when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings).

For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing.


You can set the Quantity to 0 (zero) and keep the listing active if OutOfStockControl is set to 'true'.
For GetSellerTransactions: See Item.Quantity instead.

See the Trading API Guide for more details about setting and modifying a variation's quantity.
Min: 0.

DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.

See Describing Variations in a Listing.

Item.Variations.Variation
  .SellingStatus
SellingStatusType Conditionally Contains the variation's quantity sold. Always returned when variations are present.
Item.Variations.Variation
  .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 that GetItem returns an error (invalid item ID) in the response if Item.SellingStatus.AdminEnded is true and the requesting user is not the seller of the item.
Item.Variations.Variation
  .SellingStatus.BidCount
int Always Number of bids placed so far against the auction item.
Item.Variations.Variation
  .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.
Item.Variations.Variation
  .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.Variations.Variation
  .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.
Item.Variations.Variation
  .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.Variations.Variation
  .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.
Item.Variations.Variation
  .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.Variations.Variation
  .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).
Item.Variations.Variation
  .SellingStatus.HighBidder
  .AboutMePage
boolean