ReviseSellingManagerTemplate

Revises a Selling Manager template. A Selling Manager template contains the data needed to list an item. You can list items from templates, including through the use of automation rules. To use this call, you must be a Selling Manager Pro subscriber.

Note: Seller-level call rate limits were introduced in Version 793 for Add and Revise Listing calls. Each user is allowed 1200 Add Listing calls and 1200 Revise Listing calls per 30 seconds, which equates to about 3.5 million calls per 24-hour period. Add Listing calls include AddItem, AddFixedPriceItem, AddItems, AddSellingManagerTemplate, VerifyAddItem, and VerifyAddFixedPriceItem. Revise Listing calls include ReviseItem, ReviseFixedPriceItem, and ReviseSellingManagerTemplate.

There is also a call frequency limit on revising a single listing. Sellers are not allowed more than 150 revisions per day per listing.

Users who exceed these call frequency limits will be temporarily blocked from listing, and an error message (ErrorCode 21919144) will alert them to this fact. These call frequency limits are subject to change without notice.
Note: 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. However, if the ThirdPartyCheckout and/or ThirdPartyCheckoutIntegration fields were set to True at listing time, then these fields must be included and set to false in ReviseSellingManagerTemplate. Otherwise, the caller may get an error.

To test this call, first call AddSellingManagerTemplate. Use the SalesTemplateID output field from the response as input to the SaleTemplateID field in the ReviseSellingManagerTemplate call.

Note: This call is subject to change without notice; the deprecation process is inapplicable to this call.

See:
    Using Selling Manager Calls in the Trading API
    Selling Manager page on the eBay Site
    Selling Manager Pro page on the eBay Site

See also the reference documentation for these calls:



Back to top

Input Output Detail Controls Samples Change History Top Errors for ReviseSellingManagerTemplate User Notes

ReviseSellingManagerTemplate 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"?>
<ReviseSellingManagerTemplateRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <DeletedField> string </DeletedField>
  <!-- ... more DeletedField values allowed here ... -->
  <Item> ItemType
    <ApplicationData> string </ApplicationData>
    <AttributeSetArray> AttributeSetArrayType
      <AttributeSet attributeSetID="int" attributeSetVersion="string"> AttributeSetType
        <Attribute attributeID="int"> AttributeType
          <Value> ValType
            <ValueID> int </ValueID>
            <ValueLiteral> string </ValueLiteral>
          </Value>
          <!-- ... more Value nodes allowed here ... -->
        </Attribute>
        <!-- ... more Attribute nodes allowed here ... -->
      </AttributeSet>
      <!-- ... more AttributeSet nodes allowed here ... -->
    </AttributeSetArray>
    <AutoPay> boolean </AutoPay>
    <BestOfferDetails> BestOfferDetailsType
      <BestOfferEnabled> boolean </BestOfferEnabled>
    </BestOfferDetails>
    <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>
    <CategoryBasedAttributesPrefill> boolean </CategoryBasedAttributesPrefill>
    <CategoryMappingAllowed> boolean </CategoryMappingAllowed>
    <Charity> CharityType
      <CharityID> string </CharityID>
      <CharityNumber> int </CharityNumber>
      <DonationPercent> float </DonationPercent>
    </Charity>
    <ConditionDescription> string </ConditionDescription>
    <ConditionID> int </ConditionID>
    <Country> CountryCodeType </Country>
    <CrossBorderTrade> string </CrossBorderTrade>
    <!-- ... more CrossBorderTrade values allowed here ... -->
    <Description> string </Description>
    <DescriptionReviseMode> DescriptionReviseModeCodeType </DescriptionReviseMode>
    <DisableBuyerRequirements> boolean </DisableBuyerRequirements>
    <DispatchTimeMax> int </DispatchTimeMax>
    <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>
    <GetItFast> boolean </GetItFast>
    <GiftIcon> int </GiftIcon>
    <GiftServices> GiftServicesCodeType </GiftServices>
    <!-- ... more GiftServices values allowed here ... -->
    <HitCounter> HitCounterCodeType </HitCounter>
    <ItemCompatibilityList> ItemCompatibilityListType
      <Compatibility> ItemCompatibilityType
        <CompatibilityNotes> string </CompatibilityNotes>
        <Delete> boolean </Delete>
        <NameValueList> NameValueListType
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value values allowed here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes allowed here ... -->
      </Compatibility>
      <!-- ... more Compatibility nodes allowed here ... -->
    </ItemCompatibilityList>
    <ItemSpecifics> NameValueListArrayType
      <NameValueList> NameValueListType
        <Name> string </Name>
        <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
      <BestOfferAutoAcceptPrice currencyID="CurrencyCodeType"> AmountType (double) </BestOfferAutoAcceptPrice>
      <MinimumBestOfferPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumBestOfferPrice>
    </ListingDetails>
    <ListingDuration> token </ListingDuration>
    <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
    <!-- ... more ListingEnhancement values allowed here ... -->
    <ListingSubtype2> ListingSubtypeCodeType </ListingSubtype2>
    <ListingType> ListingTypeCodeType </ListingType>
    <Location> string </Location>
    <LotSize> int </LotSize>
    <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
    <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>
    <PictureDetails> PictureDetailsType
      <GalleryDuration> token </GalleryDuration>
      <GalleryType> GalleryTypeCodeType </GalleryType>
      <GalleryURL> anyURI </GalleryURL>
      <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
      <PictureURL> anyURI </PictureURL>
      <!-- ... more PictureURL values allowed here ... -->
    </PictureDetails>
    <PostalCode> string </PostalCode>
    <PostCheckoutExperienceEnabled> boolean </PostCheckoutExperienceEnabled>
    <PrimaryCategory> CategoryType
      <CategoryID> string </CategoryID>
    </PrimaryCategory>
    <PrivateListing> boolean </PrivateListing>
    <ProductListingDetails> ProductListingDetailsType
      <BrandMPN> BrandMPNType
        <Brand> string </Brand>
        <MPN> string </MPN>
      </BrandMPN>
      <EAN> string </EAN>
      <GTIN> string </GTIN>
      <IncludePrefilledItemInformation> boolean </IncludePrefilledItemInformation>
      <IncludeStockPhotoURL> boolean </IncludeStockPhotoURL>
      <ISBN> string </ISBN>
      <ListIfNoProduct> boolean </ListIfNoProduct>
      <ProductID> string </ProductID>
      <ProductReferenceID> string </ProductReferenceID>
      <ReturnSearchResultOnDuplicates> boolean </ReturnSearchResultOnDuplicates>
      <TicketListingDetails> TicketListingDetailsType
        <EventTitle> string </EventTitle>
        <PrintedDate> string </PrintedDate>
        <PrintedTime> string </PrintedTime>
        <Venue> string </Venue>
      </TicketListingDetails>
      <UPC> string </UPC>
      <UseFirstProduct> boolean </UseFirstProduct>
      <UseStockPhotoURLAsGallery> boolean </UseStockPhotoURLAsGallery>
    </ProductListingDetails>
    <Quantity> int </Quantity>
    <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
    <ReturnPolicy> ReturnPolicyType
      <Description> string </Description>
      <EAN> string </EAN>
      <RefundOption> token </RefundOption>
      <RestockingFeeValueOption> token </RestockingFeeValueOption>
      <ReturnsAcceptedOption> token </ReturnsAcceptedOption>
      <ReturnsWithinOption> token </ReturnsWithinOption>
      <ShippingCostPaidByOption> token </ShippingCostPaidByOption>
      <WarrantyDurationOption> token </WarrantyDurationOption>
      <WarrantyOfferedOption> token </WarrantyOfferedOption>
      <WarrantyTypeOption> token </WarrantyTypeOption>
    </ReturnPolicy>
    <ScheduleTime> dateTime </ScheduleTime>
    <SecondaryCategory> CategoryType
      <CategoryID> string </CategoryID>
    </SecondaryCategory>
    <Seller> UserType
      <MotorsDealer> boolean </MotorsDealer>
    </Seller>
    <SellerContactDetails> AddressType
      <CompanyName> string </CompanyName>
      <County> string </County>
      <Phone2AreaOrCityCode> string </Phone2AreaOrCityCode>
      <Phone2CountryCode> CountryCodeType </Phone2CountryCode>
      <Phone2LocalNumber> string </Phone2LocalNumber>
      <PhoneAreaOrCityCode> string </PhoneAreaOrCityCode>
      <PhoneCountryCode> CountryCodeType </PhoneCountryCode>
      <PhoneLocalNumber> string </PhoneLocalNumber>
      <Street> string </Street>
      <Street2> string </Street2>
    </SellerContactDetails>
    <SellerInventoryID> string </SellerInventoryID>
    <SellerProvidedTitle> string </SellerProvidedTitle>
    <ShippingDetails> ShippingDetailsType
      <CalculatedShippingRate> CalculatedShippingRateType
        <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
        <MeasurementUnit> MeasurementSystemCodeType </MeasurementUnit>
        <OriginatingPostalCode> string </OriginatingPostalCode>
        <PackageDepth> MeasureType (decimal) </PackageDepth>
        <PackageLength> MeasureType (decimal) </PackageLength>
        <PackageWidth> MeasureType (decimal) </PackageWidth>
        <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
        <ShippingIrregular> boolean </ShippingIrregular>
        <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
        <WeightMajor> MeasureType (decimal) </WeightMajor>
        <WeightMinor> MeasureType (decimal) </WeightMinor>
      </CalculatedShippingRate>
      <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
      <InsuranceDetails> InsuranceDetailsType
        <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
      </InsuranceDetails>
      <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
      <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
      <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>
      <RateTableDetails> RateTableDetailsType
        <DomesticRateTable> string </DomesticRateTable>
        <InternationalRateTable> string </InternationalRateTable>
      </RateTableDetails>
      <SalesTax> SalesTaxType
        <SalesTaxPercent> float </SalesTaxPercent>
        <SalesTaxState> string </SalesTaxState>
        <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
      </SalesTax>
      <ShippingDiscountProfileID> string </ShippingDiscountProfileID>
      <ShippingServiceOptions> ShippingServiceOptionsType
        <FreeShipping> boolean </FreeShipping>
        <ShippingService> token </ShippingService>
        <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
        <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
      </ShippingServiceOptions>
      <!-- ... more ShippingServiceOptions nodes allowed here ... -->
      <ShippingType> ShippingTypeCodeType </ShippingType>
    </ShippingDetails>
    <ShippingPackageDetails> ShipPackageDetailsType
      <MeasurementUnit> MeasurementSystemCodeType </MeasurementUnit>
      <PackageDepth> MeasureType (decimal) </PackageDepth>
      <PackageLength> MeasureType (decimal) </PackageLength>
      <PackageWidth> MeasureType (decimal) </PackageWidth>
      <ShippingIrregular> boolean </ShippingIrregular>
      <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
      <WeightMajor> MeasureType (decimal) </WeightMajor>
      <WeightMinor> MeasureType (decimal) </WeightMinor>
    </ShippingPackageDetails>
    <ShippingTermsInDescription> boolean </ShippingTermsInDescription>
    <ShipToLocations> string </ShipToLocations>
    <!-- ... more ShipToLocations values allowed here ... -->
    <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>
    </Storefront>
    <SubTitle> string </SubTitle>
    <ThirdPartyCheckout> boolean </ThirdPartyCheckout>
    <ThirdPartyCheckoutIntegration> boolean </ThirdPartyCheckoutIntegration>
    <Title> string </Title>
    <UpdateReturnPolicy> boolean </UpdateReturnPolicy>
    <UpdateSellerInfo> boolean </UpdateSellerInfo>
    <UseTaxTable> boolean </UseTaxTable>
    <Variations> VariationsType
      <Pictures> PicturesType
        <VariationSpecificName> string </VariationSpecificName>
        <VariationSpecificPictureSet> VariationSpecificPictureSetType
          <PictureURL> anyURI </PictureURL>
          <!-- ... more PictureURL values allowed here ... -->
          <VariationSpecificValue> string </VariationSpecificValue>
        </VariationSpecificPictureSet>
        <!-- ... more VariationSpecificPictureSet nodes allowed here ... -->
      </Pictures>
      <Variation> VariationType
        <Quantity> int </Quantity>
        <SKU> SKUType (string) </SKU>
        <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
        <VariationSpecifics> NameValueListArrayType
          <NameValueList> NameValueListType
            <Name> string </Name>
            <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>
          <Value> string </Value>
          <!-- ... more Value values allowed here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes allowed here ... -->
      </VariationSpecificsSet>
    </Variations>
    <VATDetails> VATDetailsType
      <BusinessSeller> boolean </BusinessSeller>
      <RestrictedToBusiness> boolean </RestrictedToBusiness>
      <VATPercent> float </VATPercent>
    </VATDetails>
    <VIN> string </VIN>
    <VRM> string </VRM>
  </Item>
  <SaleTemplateID> long </SaleTemplateID>
  <SaleTemplateName> string </SaleTemplateName>
  <VerifyOnly> boolean </VerifyOnly>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</ReviseSellingManagerTemplateRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
DeletedField string Conditional,
repeatable: [0..*]		 Specifies the name of a field to remove from a template. See the eBay Web Services guide for rules on removing values when revising items. Also see the relevant field descriptions to determine when to use DeletedField (and potential consequences). The request can contain zero, one, or many instances of DeletedField (one for each field to be removed). DeletedField accepts the following path names, which remove the corresponding fields:

Item.ApplicationData
Item.AttributeSetArray
Item.ConditionID
Item.ItemSpecifics
Item.ListingCheckoutRedirectPreference.ProStoresStoreName
Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername
Item.ListingDesigner.LayoutID
Item.ListingDesigner.ThemeID
Item.ListingEnhancement[Value]
Item.PayPalEmailAddress
Item.PictureDetails.GalleryURL
Item.PictureDetails.PictureURL
Item.PostalCode
Item.ProductListingDetails
item.ShippingDetails.PaymentInstructions
item.SKU
Item.SubTitle

These values are case-sensitive. Use values that match the case of the schema element names (Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL). However, do not change the case of letters in the middle of a field name (e.g., item.picturedetails.galleryUrl is not allowed).

Depending on how you have configured your pictures, you cannot necessarily delete both GalleryURL and PictureURL from an existing listing. If GalleryType was already set for the item you are revising, you cannot remove it. This means you still need to include either a first picture or a gallery URL in your revised listing.
Item ItemType Required Required. In Item.ItemID, specify the same value as the value you specified in SaleTemplateID. Other child elements hold the values for properties that are being changed. Set values in the Item object only for those properties that are changing. Use DeletedField to remove a property.
Item.ApplicationData string Optional 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.
Item.AttributeSetArray AttributeSetArrayType Optional Deprecated as of version 773. Currently ignored. Use Item.ItemSpecifics instead.
No longer applicable to any categories.
Deprecation version: 773. See also Deprecated Objects.
Item.AttributeSetArray
  .AttributeSet 		AttributeSetType Optional,
repeatable: [0..*]		 Deprecated as of version 773. Currently ignored. Use Item.ItemSpecifics instead.
Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way.

For the AddItem family of calls and GetItem, an AttributeSetArray can contain a maximum of 2 full attribute sets (one for each category in which the item is listed) if the primary and secondary categories are mapped to different characteristic sets. If they are mapped to the same characteristic set, the AttributeSetArray can contain one full attribute set.

An AttributeSetArray can also contain any number of additional site-wide attribute sets. In item-listing requests, AttributeSet is required if the category is mapped to a characteristic set with required attributes. On the US site, attributes are usually required for Tickets, eBay Motors vehicles, and Real Estate listings. See GetCategory2CS and GetAttributesCS. See the Developer's Guide for information about attribute meta-data and validation rules that are applicable when listing items.

In GetItem, the Half.com item condition may be returned once in an AttributeSet node with Half.com IDs and values, and once in a separate AttributeSet node with a site-wide eBay item condition. The Half.com IDs are not necessarily returned in GetAttributesCS, so you can use the eBay.com data instead. Half.com listings may also return an AttributeSet node with other eBay attributes.
Deprecation version: 773. See also Deprecated Objects.
Item.AttributeSetArray
  .AttributeSet
  [ attribute attributeSetID ]		 int Optional Deprecated as of version 773. Currently ignored. Use Item.ItemSpecifics instead. Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristics set ID. Call GetCategory2CS to determine valid characteristics set IDs. Not applicable to Half.com.
Item.AttributeSetArray
  .AttributeSet
  [ attribute attributeSetVersion ]		 string Optional Deprecated as of version 773. Currently ignored. Use Item.ItemSpecifics instead. Version of the attribute set being specified (in requests) or that is currently on the site. This value changes each time changes are made to the category-to-characteristic set mappings or characteristic set data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed.

In listing requests, if you do not specify this value, eBay assumes you are using the current attribute set version. If you specify the version number of the attribute meta-data that you have stored locally, eBay will compare it to the current version on the site and return a warning if the versions do not match. If an error occurs due to invalid attribute data, this warning can be useful to help you determine if you might be sending outdated data. Not applicable to Half.com.
Item.AttributeSetArray
  .AttributeSet.Attribute 		AttributeType Optional,
repeatable: [0..*]		 Deprecated as of version 773. Currently ignored. Use Item.ItemSpecifics instead.
A salient aspect or feature of an item in a given category. Attributes are known as "Item Specifics" in the eBay Web site. Use attributes to describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard attribute for books. In item-listing requests, multiple attributes can be specified. Some categories (e.g., Tickets) always require certain attributes to be specified. Therefore, in item-listing requests you need to at least specify "editable" attributes (EditType 0 and EditType 2 attributes) if they are identified as required in the attribute meta-data. See the eBay Web Services guide for information about attribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required.

If you are revising or relisting an item, you don't need to pass in attributes that were already specified in the original listing. To remove an optional attribute, set all its value IDs to "-100". If the item has bids (or items have been sold) but there are more than 12 hours remaining until the listing ends, you can add Attribute nodes but you cannot remove or modify data in previously specified Attribute nodes. If the item has bids and the listing ends within 12 hours, you cannot add or remove Attribute nodes or modify the contents of previously specified Attribute nodes.

Not applicable to Half.com.
Deprecation version: 773. See also Deprecated Objects.
Item.AttributeSetArray
  .AttributeSet.Attribute
  [ attribute attributeID ]		 int Optional Deprecated as of version 773. Constant value that identifies the attribute in a language-independent way. Unique within the attribute set. See the Developer's Guide topics on Item Specifics and Pre-filled Item Information for information about determining valid attribute IDs. Not applicable to Half.com.
Item.AttributeSetArray
  .AttributeSet.Attribute.Value 		ValType Optional,
repeatable: [0..*]		 Deprecated as of version 773.
A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values.

For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings.
Deprecation version: 773. See also Deprecated Objects.
Item.AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueID 		int Conditional Deprecated as of version 773.
Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristic set.

In item-listing requests, if the ID is defined as -3 or -6 (Other) in GetAttributesCS or GetProductSellingPages, use ValueLiteral to specify the string value that the user entered. Otherwise, use ValueID to specify the ID that is pre-defined in GetAttributesCS or GetProductSellingPages. In item-listing requests and product searches, the possible ID values are:
-3 = User entered an arbitrary value (not an "Other" field)
-6 = User entered a value in an "Other" field
-100 = Value not specified (null)
#### (integer) = Identifier for a pre-defined value that the user selected (e.g., -14 or 1001)
For eBay.com, required if ValueList is specified. Not applicable to Half.com.
Deprecation version: 773. See also Deprecated Objects.
Item.AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueLiteral 		string Conditional Deprecated as of version 773.
For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings.
Max length: see description.
Deprecation version: 773. See also Deprecated Objects.
Item.AutoPay boolean Conditional To create a requirement that a buyer pays immediately (through PayPal) 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/VerifyAdd 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, and the buyer's funds are transferred instantly to the seller's PayPal 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;
  • the Buy It Now price (if applicable) cannot be higher than $10,000 USD;
  • the listing site supports PayPal payments;
  • the category supports PayPal 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;
  • seller must offer PayPal as the only payment method;
  • 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.
Default: false.

See:
    Requiring Immediate Payment
    Listing US and CA eBay Motors Items

Item.BestOfferDetails BestOfferDetailsType Optional 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.
Item.BestOfferDetails
  .BestOfferEnabled 		boolean Optional 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. If a listing has no active Best Offers, you can change this value (true to false, and vice versa). If a listing does have an active Best Offer, you cannot change the value to false.
Item.BuyerRequirementDetails BuyerRequirementDetailsType Optional 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.

See Selecting Buyer Requirements (eBay Web site help).
Item.BuyerRequirementDetails
  .LinkedPayPalAccount 		boolean Optional 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.
Item.BuyerRequirementDetails
  .MaximumBuyerPolicyViolations 		MaximumBuyerPolicyViolationsType Optional 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.
Item.BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .Count 		int Optional 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.
Item.BuyerRequirementDetails
  .MaximumBuyerPolicyViolations
  .Period 		PeriodCodeType Optional 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_30

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

•   Days_180

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


(Not all values in PeriodCodeType apply to this field.)
Item.BuyerRequirementDetails
  .MaximumItemRequirements 		MaximumItemRequirementsType Optional 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.
Item.BuyerRequirementDetails
  .MaximumItemRequirements
  .MaximumItemCount 		int Conditional 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, 75, and 100.

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.

See Buyers Who May Bid on Several of My Items and Not Pay.
Item.BuyerRequirementDetails
  .MaximumItemRequirements
  .MinimumFeedbackScore 		int Optional 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.
Item.BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo 		MaximumUnpaidItemStrikesInfoType Optional 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.
Item.BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .Count 		int Conditional 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.
Item.BuyerRequirementDetails
  .MaximumUnpaidItemStrikesInfo
  .Period 		PeriodCodeType Conditional 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_30

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

•   Days_180

(in/out) This value indicates that the evaluation period is set back 180 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.)
Item.BuyerRequirementDetails
  .MinimumFeedbackScore 		int Optional 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.
Item.BuyerRequirementDetails
  .ShipToRegistrationCountry 		boolean Optional 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.
Item.BuyerRequirementDetails
  .VerifiedUserRequirements 		VerifiedUserRequirementsType Optional The seller uses this container as a mechanism to block prospective buyers who do not pass a verified user check.

This container is only applicable to the following eBay sites:
  • Australia
  • France
  • India
  • Ireland
  • Spain
  • UK
Item.BuyerRequirementDetails
  .VerifiedUserRequirements
  .MinimumFeedbackScore 		int Optional 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.

To see the valid values for your site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.VerifiedUserRequirements.FeedbackScore fields.
Default: 5.
Item.BuyerRequirementDetails
  .VerifiedUserRequirements
  .VerifiedUser 		boolean Optional To block non-verified users from buying/bidding on their items, the seller should include this field and set its value to 'true'. The default value of this field is 'false', so, if it is not included, non-verified users on the Australia, France, India, Ireland, Spain, and UK will be able to buy/bid on the seller's items.
Default: false.

See Field Differences for eBay Sites.
Item.BuyerRequirementDetails
  .ZeroFeedbackScore 		boolean Optional 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.
Item
  .BuyerResponsibleForShipping 		boolean Optional 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.
Item.BuyItNowPrice AmountType (double) Optional 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.

See:
    Listing Policies
    Revising Items

Item.BuyItNowPrice
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item
  .CategoryBasedAttributesPrefill 		boolean Optional If this field is included in the request and set to 'true', eBay will auto-fill some of a listing's Item Specifics values based on the listing's category (or categories). Auto-filling Item Specifics based on a category is not the same as using Pre-filled Item Information based on a catalog product (see ProductListingDetails). If you set CategoryBasedAttributesPrefill to 'true', it is recommended that you also include and set the Item.CategoryMappingAllowed value to 'true', so you can be assured that your item will pick up the Item Specifics values from the correct category (categories). This field will be ignored if the category does not support auto-filling attributes.

If you also pass in Item Specifics through the Item.ItemSpecifics container in the request, these values will override any auto-filled values for the same Item Specifics. Once you have overridden the value of an auto-filled Item Specifics for a given listing, eBay will not auto-fill it on subsequent ReviseItem requests (even if you remove the overridden value from the Item Specific in the ItemSpecifics container).

Not applicable to Half.com.
Item.CategoryMappingAllowed boolean Optional Controls how eBay handles cases in which an ID specified in PrimaryCategory and/or SecondaryCategory no longer exists in the current category structure: If you pass a value of 'true' in CategoryMappingAllowed, eBay will look up the current category ID that is mapped to the same category and use the new category ID for the listing (if any). The new category ID will be returned in the response as CategoryID (for the primary category) or Category2ID (for the secondary category). If CategoryMappingAllowed is not set or contains a value of 'false' (the default), an error will be returned if a selected category ID no longer exists.

Not applicable to Half.com.

See Maintaining Category Data.
Item.Charity CharityType Optional 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.

See:
    Miscellaneous Item Field Differences
    Identifying Listings that Benefit Nonprofits

Item.Charity.CharityID string Conditional A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items.
Item.Charity.CharityNumber int Optional 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.
Item.Charity.DonationPercent float Conditional 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.
Item.ConditionDescription string Optional 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 only on the eBay US, UK and Motors 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.
Item.ConditionID int Conditional 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.

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

Item.Country CountryCodeType Optional 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.
Item.CrossBorderTrade string Optional,
repeatable: [0..*]		 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.

See Making Listings Available by Default on Another Site.
Item.Description string Conditional The seller's description of the item. In listing requests, you can submit your description using CDATA if you want to use HTML or XML-reserved characters in the description. 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.

Required for all listings, except listings that include eBay catalog product details. Optional when you list with product details and Item.ProductListingDetails.IncludePrefilledItemInformation is true.

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 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 attributeLabel="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).

See IncludePrefilledItemInformation.
Item.DescriptionReviseMode DescriptionReviseModeCodeType Optional This field is applicable if you are modifying the item description. The value selected for this field will determine if the new text entered into the Item.Description field is added before (Prepend) or after (Append) the current text in the item description, or if the new text completely replaces the current text in the item description.

Applicable values:

•   Append

(in) Use this value in the Item.DescriptionReviseMode field if you want to append text to the item description of the active listing.

•   CustomCode

(in) This value is reserved for internal or future use.

•   Prepend

(in) Use this value in the Item.DescriptionReviseMode field if you want to prepend text to the item description of the active listing.

•   Replace

(in) Use this value in the Item.DescriptionReviseMode field if you want to completely replace (overwrite) the item description of the active listing.
Item.DisableBuyerRequirements boolean Optional 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.
Item.DispatchTimeMax int Conditional 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.

See:
    (GetCategoryFeatures) SiteDefaults.HandlingTimeEnabled
    Specifying Shipping Services for details about same day handling

Item
  .ExtendedSellerContactDetails 		ExtendedContactDetailsType Optional 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.
Item
  .ExtendedSellerContactDetails
  .ClassifiedAdContactByEmailEnabled 		boolean Optional 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.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails 		ContactHoursDetailsType Optional All fields related to contact hours including time ranges and user-designated time zone.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours1AnyTime 		boolean Optional 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.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours1Days 		DaysCodeType Optional 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.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours1From 		time Optional 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.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails.Hours1To 		time Optional 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.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours2AnyTime 		boolean Optional 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.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours2Days 		DaysCodeType Optional 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.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours2From 		time Optional 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.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails.Hours2To 		time Optional 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.
Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .TimeZoneID 		string Optional 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.
Item.GetItFast boolean Optional 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 supported for UK Store Inventory format items.
Not applicable to Half.com.

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

Item.GiftIcon int Conditional 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.
Item.GiftServices GiftServicesCodeType Optional,
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.
Item.HitCounter HitCounterCodeType Optional 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.
Item.ItemCompatibilityList ItemCompatibilityListType Optional 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 only returned if the seller included item compatibility in the listing and IncludeItemCompatibilityList is set to true in the GetItem request.

See:
    Product Metadata API Call Reference for information on retrieving compatibility search names and corresponding values needed to specify compatibility by application manually
    Listing Items with Parts Compatibility

Item.ItemCompatibilityList
  .Compatibility 		ItemCompatibilityType Conditional,
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.
Item.ItemCompatibilityList
  .Compatibility
  .CompatibilityNotes 		string Conditional 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.Delete 		boolean Conditional Removes individual parts compatibility nodes from the compatibility list. Set to true within the compatibility to delete.

This field can only be used when revising an item or template.
If the listing has bids or ends within 12 hours, you cannot delete item compatibilities.
Default: false.
Item.ItemCompatibilityList
  .Compatibility.NameValueList 		NameValueListType Conditional,
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.

See Product Metadata API Call Reference for information on retrieving compatibility search names and corresponding values needed to specify compatibility by application manually.
Item.ItemCompatibilityList
  .Compatibility.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.
Item.ItemCompatibilityList
  .Compatibility.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.
Item.ItemSpecifics NameValueListArrayType Optional 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.)

See:
    Working with Custom Item Specifics
    Seller Central: Changes to Item Specifics

Item.ItemSpecifics
  .NameValueList 		NameValueListType Conditional,
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.
Item.ItemSpecifics
  .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.
Item.ItemSpecifics
  .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.
Item
  .ListingCheckoutRedirectPreference 		ListingCheckoutRedirectPreferenceType Conditional Container consisting of the ProStores store name and user name.
Item
  .ListingCheckoutRedirectPreference
  .ProStoresStoreName 		string Conditional The name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.
Item
  .ListingCheckoutRedirectPreference
  .SellerThirdPartyUsername 		string Conditional The user name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.
Item.ListingDesigner ListingDesignerType Optional 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.
Item.ListingDesigner.LayoutID int Optional 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.
Item.ListingDesigner
  .OptimalPictureSize 		boolean Optional If true, indicates that the item's picture will be enlarged to fit description of the item.
Item.ListingDesigner.ThemeID int Optional 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.
Item.ListingDetails ListingDetailsType Optional 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.
Item.ListingDetails
  .BestOfferAutoAcceptPrice 		AmountType (double) Optional 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 100), you cannot use the API to add a minimum Best Offer price. For a ReviseItem call with site ID 100, prior use of a minimum Best Offer price on eBay.com is ignored.
Item.ListingDetails
  .BestOfferAutoAcceptPrice
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ListingDetails
  .MinimumBestOfferPrice 		AmountType (double) Optional 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.
Item.ListingDetails
  .MinimumBestOfferPrice
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ListingDuration token Optional 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).

See:
    GetCategoryFeatures
    Fees per Site



Applicable values: See ListingDurationCodeType
Item.ListingEnhancement ListingEnhancementsCodeType Optional,
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. Formerly, a feature pack applicable to the Australia site (site ID 15, abbreviation AU) only. Contained the Gallery and Subtitle features.

•   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 (SiteID 100). 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 (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites (starting on the same production date), whenever ValuePackBundle is selected in a request, the basic Gallery feature included in the Value Pack bundle is now 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).


Item.ListingSubtype2 ListingSubtypeCodeType Optional 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.


See:
    About Local Market Listings
    Advertising with Classified Ads

Item.ListingType ListingTypeCodeType Conditional 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 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).

•   Half

(in/out) Half.com listing (item is listed on Half.com, not on eBay). You must be a registered Half.com seller to use this format.

•   LeadGeneration

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


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

See:
    Different Ways of Selling
    Basic Building Blocks
    GetCategoryFeatures
    Fees per Site

Item.Location string Conditional 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.
Item.LotSize int Optional 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.
Item.MotorsGermanySearchable boolean Optional Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany.

If 'true' in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site.

Not applicable to Half.com.

See Working with eBay Motors Germany Listings.
Item.PaymentDetails PaymentDetailsType Optional 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).

See Listing US and CA eBay Motors Items.
Item.PaymentDetails
  .DaysToFullPayment 		int Optional 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.
Item.PaymentDetails
  .DepositAmount 		AmountType (double) Conditional 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.
Item.PaymentDetails
  .DepositAmount
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.PaymentDetails
  .DepositType 		DepositTypeCodeType Conditional 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.
Item.PaymentDetails
  .HoursToDeposit 		int Optional 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.
Item.PaymentMethods BuyerPaymentMethodCodeType Conditional,
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.

See:
    Specifying a Payment Method
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema for rules regarding repeating nodes

Item.PayPalEmailAddress string Conditional 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.

See:
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences

Item.PictureDetails PictureDetailsType Required 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.

See Introduction to Pictures in Item Listings.
Item.PictureDetails
  .GalleryDuration 		token Optional Describes the number of days that "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.

Applicable values: See ListingEnhancementDurationCodeType
Item.PictureDetails
  .GalleryType 		GalleryTypeCodeType Conditional Indicates whether listing images are included in the search results (in the Picture Gallery and List Views) and, if so, which enhancements apply. Items that have pictures but no image-listing enhancements have a generic photo image in search results, but see the information below about sites with free Gallery.

If the GalleryType value is Gallery, Plus, or Featured, eBay checks the available image URLs in the following order to determine which URL to use (if more than one of these URLs is available):

a) Use the URL in GalleryURL, if it is specified.
b) Otherwise, if ProductListingDetails.UseStockPhotoURLAsGallery is true, use the eBay stock photo.
c) Otherwise, use the value of the first PictureURL in the array of PictureURL fields, if any.
d) Otherwise, if ProductListingDetails.ProductID is specified, use the eBay stock photo for that ProductID (eBay resets UseStockPhotoURLAsGallery to true in this case).
e) If eBay cannot find an image URL for the listing, an error is returned.

Note that you can use the Gallery Plus feature whether or not the image is hosted with eBay Picture Services (EPS). Selecting Gallery Plus does not incur a separate Gallery fee.

See "Describing Items in a Listing" in the eBay Web Services Guide for additional information about working with pictures and related validation rules.

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 (error code 219243). The Knowledge Base explains an edge 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 if 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.

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

On these sites, eBay will automatically create a Gallery thumbnail for the listing in search results by selecting a picture from one of the image URLs specified in the request (either Item.PictureDetails.PictureURL or Item.PictureDetails.GalleryURL) or from an available stock photo. Thus, a Gallery thumbnail will be created whenever Item.PictureDetails.GalleryType is None or is not specified in the request. A Gallery fee will apply whenever GalleryType specifies the Plus or Featured image enhancements (there will be no Gallery fee whenever GalleryType is Gallery, None or is not specified in the request).

eBay will select the image for the thumbnail depending on which of the image URLs above was specified in the request (there are selection rules for four cases). Note that the selected image will not necessarily be the image you have specified in Item.PictureDetails.GalleryURL. Note that a Gallery thumbnail will not be automatically created if PictureURL and GalleryURL are not supplied and UseStockPhotoURLAsGallery and IncludeStockURL are set to false.

The most common case occurs when both GalleryURL and PictureURL are specified in the request. eBay will use the image referenced by PictureURL as the Gallery thumbnail. As three other cases exist, please refer to "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information on how eBay selects an image for the gallery thumbnail on these sites.

You cannot remove Gallery 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. (This does not apply to Gallery Plus on sites with free Gallery; see Plus below for more information.)

Applicable values:

•   CustomCode

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

•   Featured

(in/out) Highlights the listing at the top of the search results. (No longer available for the US site; also, no longer available on the US eBay Motors site, in the Parts and Accessories category. In these cases, listings containing Featured First are listed, but Featured First is dropped and a warning is returned.)

Additionally, the listing gets the Gallery and Gallery Plus functionality. Note that "Gallery" and "Plus" do not need to be specified separately in a listing. Passing "Featured", "Plus", and "Gallery" in the same request causes an error.

For the eBay Motors site (site ID 100), passing "Featured" may put certain items on the eBay Motors home page. Note: "Gallery Featured" was replaced by "Featured First" on several eBay sites, including UK, IE, DE, AT, CH, and IT.

•   Gallery

(in/out) Listing image is included in the search results (in both Picture Gallery and List Views). Items that have pictures but do not have the Gallery feature will have a generic photo image shown in search results.

Some listing enhancements (for example, "Featured" and "Plus") automatically include the Gallery functionality, so "Gallery" does not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error.

•   None

(in/out) Listing image is not included in the search results (in either Picture Gallery or List Views), and no other image listing enhancements apply. Items that have pictures but do not have image listing enhancements display a generic photo image in search results.

Mainly useful for RelistItem use cases when you want to remove an existing gallery setting. However, not all image listing enhancements can be removed on revise or relist.

Note that specifying None is not necessarily the same as omitting GalleryType from a request. For example, specifying other item properties may cause the listing to be included in the search results Gallery by default if GalleryType is not specified.

•   Plus

(in/out) Listing image has Gallery Plus funtionality. That is, listing includes a Gallery Plus icon that, when moused over or clicked, displays a large (400 px x 400 px) preview image of the item. Clicking the image displays the View Item page for that listing.

Listing images that are originally smaller than 400 px x 400 px are centered in the preview frame. Images that are originally larger than 400 px x 400 px are scaled down to 400 px on their longest side (maintaining their original aspect ratio).

Note that you can use the Gallery Plus feature whether or not the image is hosted with eBay Picture Services (EPS). One EPS image is included at no cost with the Gallery Plus feature.

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. Passing "Featured", "Plus", and "Gallery" in the same request will return an error.

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

On these sites (starting on the same production date), whenever 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 now automatically includes a Gallery Showcase of all the listing's images at no extra cost. If Plus is selected and the request includes only one EPS image or any self-hosted images, regular Gallery Plus applies.

The Gallery Showcase displays when mousing over or clicking on the listing's Gallery Plus icon in the search results. The Showcase window displays a large (400 px x 400 px) preview image which is usually the first specified PictureURL, as well as up to four (64 px x 64 px) selectable thumbnails for the remaining EPS images (the Showcase window contains pagination controls for observing all EPS images in the request). Clicking on the preview image displays the item's listing page.

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.

Not applicable to eBay Stores Inventory listings.


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 Conditional Supported in Production only (not 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: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146).

On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs 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 for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.

(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 "Describing Items in a Listing" in the eBay Web Services 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 gallery URL 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.

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

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

Item.PictureDetails.PictureURL anyURI Conditional,
repeatable: [0..*]		 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. 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. See ExternalPictureURL above and see the link below titled "Copy of a Self-Hosted Picture To eBay Picture Services." On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL.

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

On 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 "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide.
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" in the eBay Web Services Guide 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, please 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.

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.

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 Optional 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.
Item
  .PostCheckoutExperienceEnabled 		boolean Conditional Reserved for future use.
Item.PrimaryCategory CategoryType Optional 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.

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. See Getting Recommendations to Improve a Listing in the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attribute engine.

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

Item.PrimaryCategory
  .CategoryID 		string Optional 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.
Item.PrivateListing boolean Optional 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.
Item.ProductListingDetails ProductListingDetailsType Optional Specifies stock product information to include in a listing. Only applicable when listing items with product details. See the eBay Trading API Guide for information on listing with product details.

As ProductID and ProductReferenceID are defined by eBay, they provide the most reliable means to identify a product. If you use 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.
Item.ProductListingDetails
  .BrandMPN 		BrandMPNType Conditional 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 Conditional 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 Conditional 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.EAN string Conditional 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
  .GTIN 		string Conditional A universal format for identifying products. GTIN is a unique 8, 12, 13, or 14-digit identifier that some external catalogs use instead of ISBN, UPC, EAN, or other values. When you pass in GTIN, eBay attempts to map the value to an ISBN, UPC, or EAN. When you know that a value is an ISBN, UPC, or EAN, we recommend that you use those fields directly instead of GTIN, for better performance and accuracy.

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. The GTIN is not stored.)
Max length: 14.
Item.ProductListingDetails
  .IncludePrefilledItemInformation 		boolean Optional If true, specifies that the listing should include additional information about the product, such as a publisher's description or film credits. Such information is hosted through the eBay site and cannot be edited. If true, Item.Description is optional in item-listing requests.

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

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

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

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

Not applicable to Half.com.
Default: true.

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 Conditional 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
  .ListIfNoProduct 		boolean Optional Indicates what eBay should do if no product match has been found. If no product match was found and ListIfNoProduct is true, the item is listed without product information. (By default, eBay attempts to list the item with product information.)

Note: If you omit PrimaryCategory and no product match is found, the listing will fail because eBay won't be able to determine a category without a product ID.
Default: false.
Item.ProductListingDetails
  .ProductID 		string Conditional eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter 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.
Item.ProductListingDetails
  .ProductReferenceID 		string Conditional eBay's short global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID" or "Product ID". This type of product ID is a fixed reference to a product (regardless of version). Multiple (versioned) ProductID values can be associated with a single product reference ID. You can find product reference IDs for products by using FindProducts in the Shopping API. You can also find the product ID on eBay's Web site (a numeric value prefixed with "EPID"). You can pass the value with or without the "EPID" prefix; for example "EPID228742" or "228742" (without quotes).

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

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 return an error if the product has been deleted.
Max length: 38 (42 with "EPID").

See Example of Product on eBay US Site with EPID.
Item.ProductListingDetails
  .ReturnSearchResultOnDuplicates 		boolean Optional Indicates what eBay should do if more than one product matches the external product ID (ISBN, UPC, EAN, BrandMPN, or TicketListingDetails). Also see UseFirstProduct as an alternative.

If true and more than one match is found, the call fails and the response returns an error and all matching ProductID values. This lets you choose one of the ProductIDs to pass in instead. If false and more than one match is found, the call fails and the response includes an error but does not return the matching ProductID values. (This flag has no effect when only one match is found.)
Default: false.
Item.ProductListingDetails
  .TicketListingDetails 		TicketListingDetailsType Conditional Only applicable when you are listing event tickets. Only used to match catalog products when creating listings (not for buy-side searching).

See Ticket Listings.
Item.ProductListingDetails
  .TicketListingDetails
  .EventTitle 		string Conditional The name of the event, as shown on the ticket. Typically the headliner. There is no maximum number of words or characters. However, the words in the name must be an exact match (or a subset consisting of complete words) to the words in the product title in the catalog. The words in the name are matched using OR logic (the order of the words does not matter). As with all strings, you need to escape reserved characters such as ampersand. See the eBay Trading API Guide for more information about how to specify this value.
Max length: 1024.

See Ticket Listings.
Item.ProductListingDetails
  .TicketListingDetails
  .PrintedDate 		string Conditional The date of the event, as shown on the ticket. Use the date shown on the ticket, without attempting to adjust it for a different time zone (such as Pacific time or GMT).

In most cases, you should be able to specify any numeric date format in month/day/year order. eBay supports m or mm for the month, d or dd for the day, and yy or yyyy for the year, in all combinations. The delimiters must be forward slashes (/).
Item.ProductListingDetails
  .TicketListingDetails
  .PrintedTime 		string Conditional The time of the event, as shown on the ticket. Use the time value shown on the ticket, without attempting to convert it to a different time zone (such as Pacific time or GMT). Do not round the value up or down (e.g., do not round 7:01 PM to 7:00 PM).

In most cases, you should be able to specify the time format exactly as shown on the ticket. For a list of formats that have been tested, see the eBay Trading API Guide.

See Ticket Listings.
Item.ProductListingDetails
  .TicketListingDetails.Venue 		string Conditional The name of the venue, as shown on the ticket. The validation rules are the same as the rules for the event name. In addition, eBay supports both US English and UK English spelling variations for typical words found on tickets (such as "theater" and "theatre"). As with all strings, you need to escape reserved characters such as ampersand.
Max length: 4000.
Item.ProductListingDetails.UPC string Conditional 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
  .UseFirstProduct 		boolean Optional Indicates what eBay should do if more than one product matches the external product ID (ISBN, UPC, EAN, BrandMPN, or TicketListingDetails). Also see ReturnSearchResultOnDuplicates as an alternative. If more than one product match was found and UseFirstProduct is true, item will be listed with first product information. If false, the rules for ReturnSearchResultOnDuplicates are used.
Default: false.
Item.ProductListingDetails
  .UseStockPhotoURLAsGallery 		boolean Optional If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. When listing an item, IncludeStockPhotoURL must also be true and Item.PictureDetails.GalleryType must be passed in with a value of Gallery or Gallery Featured (but not both). See the eBay Trading API guide for additional validation rules for pictures.

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

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

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

Default: true.

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.Quantity int Optional 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 and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and 3 items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.

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

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.

See:
    Listing Policies
    Selecting a Selling Format

Item.ReservePrice AmountType (double) Optional 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.

See:
    Revising Items
    Reserve Price (eBay Web site help)
    Fees Overview (eBay Web site help)

Item.ReservePrice
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ReturnPolicy ReturnPolicyType Optional 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.

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

See (GeteBayDetails) ReturnPolicyDetails.Description for sites that support this field.
Item.ReturnPolicy.EAN string Optional The European Article Number (EAN) associated with the item, if any. 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.

See (GeteBayDetails) ReturnPolicyDetails.EAN.
Item.ReturnPolicy.RefundOption token Optional Indicates how the seller will compensate the buyer for a returned item. Use the ReturnPolicy.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details.).

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.

See (GeteBayDetails) RefundOption.



Applicable values: See RefundOptionsCodeType
Item.ReturnPolicy
  .RestockingFeeValueOption 		token Optional 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.

See GeteBayDetails.ReturnPolicyDetails for applicable values for RestockingFeeValueOption.



Applicable values: See RestockingFeeCodeType
Item.ReturnPolicy
  .ReturnsAcceptedOption 		token Optional 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.

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



Applicable values: See ReturnsAcceptedOptionsCodeType
Item.ReturnPolicy
  .ReturnsWithinOption 		token Conditional The buyer can return the item within this period of time from the day they receive the item. Use the ReturnPolicy.Description field to explain the policy details.

Applicable values: 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.

See (GeteBayDetails) ReturnsWithinOption.



Applicable values: See ReturnsWithinOptionsCodeType
Item.ReturnPolicy
  .ShippingCostPaidByOption 		token Optional The party who pays the shipping cost for a returned item. Use the ReturnPolicy.Description field to explain any additional details.

Applicable values: 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.

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



Applicable values: See ShippingCostPaidByOptionsCodeType
Item.ReturnPolicy
  .WarrantyDurationOption 		token Optional The warranty period.

Applicable values: 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.

See (GeteBayDetails) WarrantyDurationOption.



Applicable values: See WarrantyDurationOptionsCodeType
Item.ReturnPolicy
  .WarrantyOfferedOption 		token Optional 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.

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
  .WarrantyTypeOption 		token Optional 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.

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



Applicable values: See WarrantyTypeOptionsCodeType
Item.ScheduleTime dateTime Optional Allows the user to specify the time that the listing becomes active on eBay. To schedule the listing start time, specify a time in the future in GMT format. In GetItem and related calls, the scheduled time is returned in StartTime. For ReviseItem, you can modify this value if the currently scheduled start time is in the future.

When you schedule a start time, the start time is randomized within 15-minute intervals. Randomized start times applies to the following sites:
AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK

Also see the following article in the Knowledge Base: Why scheduled time is sometimes getting reset.

Not applicable to Half.com.
Item.SecondaryCategory CategoryType Optional 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.

On the eBay UK, Ireland, Germany, Austria, Switzerland, and Italy sites you can list Store Inventory listings in two categories. On the eBay US and other sites, you cannot list Store Inventory listings in two categories.

You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. The Final Value Fee is based on the primary category in which the item is listed. Furthermore, you can list the same item in an eBay Motors Parts & Accessories category and in an eligible eBay category, as long as the primary category is associated with the site on which you are listing. That is, the two categories can be a mix of Motors Parts & Accessories and eBay site categories. (Real Estate, Mature Audience (adult), and Business & Industrial categories are not eligible for listing in two categories in this manner.) For example, if you list on Motors, the primary category could be 6750 (eBay Motors > Parts & Accessories > Apparel & Merchandise > Motorcycle > Jackets & Leathers), and the secondary category could be 57988 (eBay > Clothing, Shoes > Accessories > Men's Clothing > Outerwear). If you list on the main eBay site, the primary category could be 57988 and the secondary category could be 6750.

If eBay has designated a 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.

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.

See Categories.
Item.SecondaryCategory
  .CategoryID 		string Optional 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.
Item.Seller UserType Conditional Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.
Item.Seller.MotorsDealer boolean Conditional Indicates if item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only.
Item.SellerContactDetails AddressType Optional 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

See Classified Ad Listings.
Item.SellerContactDetails
  .CompanyName 		string Optional User's company name. Only returned if available. Not applicable to Half.com.
Item.SellerContactDetails
  .County 		string Optional County information for the user. This field applies to Classified Ad format listings and to the UK only. Not applicable to Half.com.
Item.SellerContactDetails
  .Phone2AreaOrCityCode 		string Optional Area or City Code of a user's secondary phone number. This field applies to Classified Ad format listings only.
Item.SellerContactDetails
  .Phone2CountryCode 		CountryCodeType Optional 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.
Item.SellerContactDetails
  .Phone2LocalNumber 		string Optional 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.
Item.SellerContactDetails
  .PhoneAreaOrCityCode 		string Optional Area or City Code of a user's primary phone number. This field applies to Classified Ad format listings only.
Item.SellerContactDetails
  .PhoneCountryCode 		CountryCodeType Optional 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.
Item.SellerContactDetails
  .PhoneLocalNumber 		string Optional 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.
Item.SellerContactDetails
  .Street 		string Optional A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com.
Item.SellerContactDetails
  .Street2 		string Optional 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. .
Item.SellerInventoryID string Optional Unique identifier for a Half.com item. Must be an alphanumeric value (with no symbols) that is unique across the seller's active (unsold) inventory on Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. Only returned from GetOrders if the seller specified a value when the item was listed. You cannot revise this field.

Not applicable to eBay.com listings.
Max length: 100.
Item.SellerProvidedTitle string Optional 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.
Item.ShippingDetails ShippingDetailsType Conditional 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 multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

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

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

Item.ShippingDetails
  .CalculatedShippingRate 		CalculatedShippingRateType Conditional 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.
Item.ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts 		AmountType (double) Optional 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.
Item.ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .CalculatedShippingRate
  .MeasurementUnit 		MeasurementSystemCodeType Conditional Specifies the unit type of the weight and dimensions of a shipping package. If MeasurementUnit is used, it overrides the system specified by measurementSystem. If MeasurementUnit and measurementSystem are not specified, the following defaults will be used:

English: US
Metric: CA, CAFR, AU

CA and CAFR supports both English and Metric, while other sites only support the site's default.

Use MeasurementUnit with weight and package dimensions. For example, to represent a 5 lbs 2 oz package:
<MeasurementUnit>English</MeasurementUnit>
<WeightMajor>5</WeightMajor>
<WeightMinor>2</WeightMinor>

Applicable values:

•   English

(in/out) English system of measurement.

•   Metric

(in/out) Metric system of measurement.


See Specifying Shipping Types and Costs.
Item.ShippingDetails
  .CalculatedShippingRate
  .OriginatingPostalCode 		string Conditional 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.
Item.ShippingDetails
  .CalculatedShippingRate
  .PackageDepth 		MeasureType (decimal) Conditional 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.

See Specifying Shipping Types and Costs.
Item.ShippingDetails
  .CalculatedShippingRate
  .PackageLength 		MeasureType (decimal) Conditional 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.)

See Specifying Shipping Types and Costs.
Item.ShippingDetails
  .CalculatedShippingRate
  .PackageWidth 		MeasureType (decimal) Conditional 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.)

See Specifying Shipping Types and Costs.
Item.ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts 		AmountType (double) Optional 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.
Item.ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .CalculatedShippingRate
  .ShippingIrregular 		boolean Optional 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.
Item.ShippingDetails
  .CalculatedShippingRate
  .ShippingPackage 		ShippingPackageCodeType Conditional 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.
Item.ShippingDetails
  .CalculatedShippingRate
  .WeightMajor 		MeasureType (decimal) Conditional 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.ShippingDetails
  .CalculatedShippingRate
  .WeightMinor 		MeasureType (decimal) Conditional 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.ShippingDetails.CODCost AmountType (double) Conditional 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.

See Other Shipping Features.
Item.ShippingDetails.CODCost
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InsuranceDetails 		InsuranceDetailsType Optional 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
Item.ShippingDetails
  .InsuranceDetails.InsuranceFee 		AmountType (double) Optional 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).
Item.ShippingDetails
  .InsuranceDetails.InsuranceFee
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InsuranceDetails
  .InsuranceOption 		InsuranceOptionCodeType Optional 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.

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


(Not all values in InsuranceOptionCodeType apply to this field.)
Item.ShippingDetails
  .InsuranceFee 		AmountType (double) Optional 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.
Item.ShippingDetails
  .InsuranceFee
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InsuranceOption 		InsuranceOptionCodeType Optional 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.

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


(Not all values in InsuranceOptionCodeType apply to this field.)
Item.ShippingDetails
  .InternationalInsuranceDetails 		InsuranceDetailsType Optional 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
Item.ShippingDetails
  .InternationalInsuranceDetails
  .InsuranceFee 		AmountType (double) Optional 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).
Item.ShippingDetails
  .InternationalInsuranceDetails
  .InsuranceFee
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InternationalInsuranceDetails
  .InsuranceOption 		InsuranceOptionCodeType Optional 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.

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


(Not all values in InsuranceOptionCodeType apply to this field.)
Item.ShippingDetails
  .InternationalPromotionalShippingDiscount 		boolean Conditional 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.

See Other Shipping Features.
Item.ShippingDetails
  .InternationalShippingDiscountProfileID 		string Conditional 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.

See Other Shipping Features.
Item.ShippingDetails
  .InternationalShippingServiceOption 		InternationalShippingServiceOptionsType Optional,
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.

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

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost 		AmountType (double) Conditional 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.
Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost 		AmountType (double) Conditional 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.

See Shipping.
Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority 		int Conditional 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.
Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShipToLocation 		string Conditional,
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.

See Specifying Locations to Where You Ship.



Applicable values: See CountryCodeType, ShippingRegionCodeType
Item.ShippingDetails
  .PaymentInstructions 		string Optional 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.

See:
    Offering a Clear Return Policy
    (AddItem) Item.AttributeSetArray
    (GetItem) Item.AttributeSetArray

Item.ShippingDetails
  .PromotionalShippingDiscount 		boolean Conditional 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.

See Other Shipping Features.
Item.ShippingDetails
  .RateTableDetails 		RateTableDetailsType Conditional 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.

See Specifying Shipping Types and Costs.
Item.ShippingDetails
  .RateTableDetails
  .DomesticRateTable 		string Conditional 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 DE, UK or US site.

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.

See Specifying Shipping Types and Costs.
Item.ShippingDetails
  .RateTableDetails
  .InternationalRateTable 		string Conditional 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.

See Specifying Shipping Types and Costs.
Item.ShippingDetails.SalesTax SalesTaxType Optional Sales tax details. US (site 0) and Motors (site 100) sites only, excluding vehicle listings. Flat and calculated shipping.

Applicable to Half.com (for GetOrders).

See Enabling Multi-jurisdiction Sales Tax.
Item.ShippingDetails.SalesTax
  .SalesTaxPercent 		float Optional 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).
Item.ShippingDetails.SalesTax
  .SalesTaxState 		string Optional 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).
Item.ShippingDetails.SalesTax
  .ShippingIncludedInTax 		boolean Optional (US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping.

Applicable to Half.com (for GetOrders).
Item.ShippingDetails
  .ShippingDiscountProfileID 		string Conditional 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.

See Other Shipping Features.
Item.ShippingDetails
  .ShippingServiceOptions 		ShippingServiceOptionsType Conditional,
repeatable: [0..*]		 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.

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
  .FreeShipping 		boolean Optional 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.

See Specifying Shipping Services.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingService 		token Conditional 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.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost 		AmountType (double) Conditional 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.

See Determining Shipping Costs for a Listing.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost 		AmountType (double) Conditional 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).

See Determining Shipping Costs for a Listing.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority 		int Conditional 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.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge 		AmountType (double) Conditional 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.
Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.ShippingDetails
  .ShippingType 		ShippingTypeCodeType Optional 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.

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.)
Item.ShippingPackageDetails ShipPackageDetailsType Optional 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
  .MeasurementUnit 		MeasurementSystemCodeType Conditional Specifies the unit type of the weight and dimensions of a shipping package. If MeasurementUnit is used, it overrides the system specified by measurementSystem. If MeasurementUnit and measurementSystem are not specified, the following defaults will be used:

English: US
Metric: CA, CAFR, AU

CA and CAFR supports both English and Metric, while other sites only support the site's default.

Use MeasurementUnit with weight and package dimensions. For example, to represent a 5 lbs 2 oz package:
<MeasurementUnit>English</MeasurementUnit>
<WeightMajor>5</WeightMajor>
<WeightMinor>2</WeightMinor>

Applicable values:

•   English

(in/out) English system of measurement.

•   Metric

(in/out) Metric system of measurement.


See Specifying Shipping Types and Costs.
Item.ShippingPackageDetails
  .PackageDepth 		MeasureType (decimal) Conditional 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.

See Specifying Shipping Types and Costs.
Item.ShippingPackageDetails
  .PackageLength 		MeasureType (decimal) Conditional 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.)

See Specifying Shipping Types and Costs.
Item.ShippingPackageDetails
  .PackageWidth 		MeasureType (decimal) Conditional 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.)

See Specifying Shipping Types and Costs.
Item.ShippingPackageDetails
  .ShippingIrregular 		boolean Optional 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.
Item.ShippingPackageDetails
  .ShippingPackage 		ShippingPackageCodeType Conditional The nature of the package used to ship the item(s). Required for calculated shipping only.

Applicable values: See ShippingPackage.
Item.ShippingPackageDetails
  .WeightMajor 		MeasureType (decimal) Conditional 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
  .WeightMinor 		MeasureType (decimal) Conditional 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
  .ShippingTermsInDescription 		boolean Optional Indicates whether details about shipping costs and arrangements are specified in the item description.

Not applicable to Half.com.

See Specifying Shipping Types and Costs.
Item.ShipToLocations string Optional,
repeatable: [0..*]		 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.

See:
    Specifying Locations to Where You Ship
    GeteBayDetails



Applicable values: See CountryCodeType, ShippingRegionCodeType
Item.SKU SKUType (string) Optional 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.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.
Item.SkypeContactOption SkypeContactOptionCodeType Optional,
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.
Item.SkypeEnabled boolean Optional 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.
Item.SkypeID string Optional 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.
Item.StartPrice AmountType (double) Optional 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.

See Listing Policies.
Item.StartPrice
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.Storefront StorefrontType Optional 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.
Item.Storefront
  .StoreCategory2ID 		long Optional Unique identifier for a second custom category that the seller created in their eBay Store. eBay Stores sellers can create up to 300 custom categories for their stores. (One additional Store category cannot be customized and retains the value of "Other").
If you specify an invalid value, the values are the same for both the primary and secondary store categories, or if the secondary store category is specified but the primary is left blank (or other), the system resets the value to 0 (None). In short, the primary store category must be set to something meaningful and different from the second store category in order to set the secondary store category to a value other than 0.
Item.Storefront
  .StoreCategoryID 		long Optional Unique identifier for a custom category that the seller created in their eBay Store. The value in this field indicates the primary category. eBay Stores sellers can create up to three levels of custom categories for their stores. Items can only be listed in root categories, or categories that have 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.
Item.SubTitle string Optional Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees).

Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle.

When you revise a item, you can add, change, or remove the subtitle.

Not applicable to Half.com.
Max length: 55.

See:
    Relisting Items
    (RelistItem) DeletedField
    Listing US and CA eBay Motors Items

Item.ThirdPartyCheckout boolean Optional Deprecated as of version 729. Currently ignored.
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 Item 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.
Deprecation version: 729. See also Deprecated Objects.
Item
  .ThirdPartyCheckoutIntegration 		boolean Optional Deprecated as of version 729. Currently ignored.
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 Item 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.

Be aware that you may need to use SetNotificationPreferences to change the ApplicationURL value if you were formerly having Checkout notifications sent to your third-party checkout application.

See Working with Platform Notifications.


Deprecation version: 729. See also Deprecated Objects.
Item.Title string Optional 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.

For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations.
Max length: 80.
Item.UpdateReturnPolicy boolean Optional Flag to indicate whether the item's Return Policy has been updated as part of the revised listing.
Item.UpdateSellerInfo boolean Optional Specifies whether the following Business Seller fields have been updated for the item specified in the request: First Name, Last Name, Fax, Email Address, Additional Contact Information, Trade Registration Number, VAT Identification Number.
Item.UseTaxTable boolean Optional Indicates whether the seller's tax table is to be used when applying and calculating sales tax for an order line item. A sales tax table can be created programmatically using the SetTaxTable call, or it can be created manually in My eBay's Selling Preferences. If UseTaxTable is set to true, the values contained in the seller's sales tax table will supersede the values contained in the Item.ShippingDetails.SalesTax container (if included in the request).

Not applicable to Half.com.

See Enabling Multi-jurisdiction Sales Tax.
Item.Variations VariationsType Optional 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.

See Multi-Variation Listings.
Item.Variations.Pictures PicturesType Optional 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.

See Describing Variations in a Listing.
Item.Variations.Pictures
  .VariationSpecificName 		string Optional 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.
Item.Variations.Pictures
  .VariationSpecificPictureSet 		VariationSpecificPictureSetType Optional,
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.
Item.Variations.Pictures
  .VariationSpecificPictureSet
  .PictureURL 		anyURI Optional,
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.

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.
Item.Variations.Pictures
  .VariationSpecificPictureSet
  .VariationSpecificValue 		string Optional A value that is associated with VariationSpecificName. For example, suppose this set of pictures is showing blue shirts, and some of the variations include Color=Blue in their variation specifics. If VariationSpecificName is "Color", then VariationSpecificValue would be "Blue".
Item.Variations.Variation VariationType Optional,
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.

See Multi-Variation Listings.
Item.Variations.Variation
  .Quantity 		int Optional This value indicates the quantity of items in the specific variation that are available for purchase. If you set Variation.Quantity to '0' when you create, revise, or relist an item listing, the variation is dropped from the listing.

For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total number of items associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract SellingStatus.QuantitySold from this value.

For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing.

For GetSellerTransactions: See Item.Quantity instead.

See the Trading API Guide for more details about setting and modifying a variation's quantity.

See Describing Variations in a Listing.
Item.Variations.Variation.SKU SKUType (string) Optional A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.)

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

If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings.

For GetItem and related calls: Only returned if the seller specified a SKU for the variation.
Max length: 80.

See Describing Variations in a Listing.
Item.Variations.Variation
  .StartPrice 		AmountType (double) Optional The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.

Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations.

You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity.

See Describing Variations in a Listing.
Item.Variations.Variation
  .StartPrice
  [ attribute currencyID ]		 CurrencyCodeType Optional Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
Item.Variations.Variation
  .VariationSpecifics 		NameValueListArrayType Optional,
repeatable: [2..5]		 A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values.

When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. You can also add, delete, or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has sales, then set the Quantity to 0.

For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned.

See:
    Describing Variations in a Listing
    Revising and Relisting with Variations

Item.Variations.Variation
  .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.
Item.Variations.Variation
  .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.
Item.Variations.Variation
  .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.
Item.Variations
  .VariationSpecificsSet 		NameValueListArrayType Optional The set of all variation specific names and values that can be applicable to the listing (at any time in its life cycle). This must include all names and values specified in the VariationSpecifics nodes.

Required when Variations are specified in a new listing, and when you modify the name of a variation by using ModifyNameList. When you modify variation specific names, VariationSpecificsSet must include the new names plus the names that are not changing (but omit the old names),

This set configures variation selection widgets that appear on eBay's View Item page. For example, if you specify Color and Size names in the set, eBay's View Item page displays Color and Size drop-down lists to enable a buyer to choose a variation of interest.

The order in which you specify the names and values also controls the order in which the selection widgets appear on the View Item page. For example, if you specify "Color", then "Size", and then "Sleeve Style" as names, the View Item page shows drop-down lists with those labels in that order. For "Size", if you specify "S", "M", and "L" as values, the View Item page shows the values in that order in the Size drop-down list.

Use GetCategorySpecifics to retrieve recommendations for names, values, and order.

Required when Variations are specified in a new listing (e.g., in AddFixedPriceItem). Also required when you change variation specific names or values in ReviseFixedPriceItem and RelistFixedPriceItem.

See Describing Variations in a Listing.
Item.Variations
  .VariationSpecificsSet
  .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.
Item.Variations
  .VariationSpecificsSet
  .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.
Item.Variations
  .VariationSpecificsSet
  .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.
Item.VATDetails VATDetailsType Conditional Container for eBay's VAT features. A business seller can choose to offer an item exclusively to bidders and buyers that also represent businesses. Only applicable when the item is listed in a B2B-enabled category (on a site that supports B2B business features).

Note: The India site (Global ID 203) does not accept VAT values in item listings. If you submit an item to the India site with a VAT value, eBay generates a warning message that indicates the listing was accepted, but the VAT value was removed. To include the VAT, relist the item with a Price value that includes the VAT. Sellers are solely responsible for compliance relating to tax legislation in India.

Not applicable to Half.com.

See:
    Working with Business Features and VAT
    Business Feature Field Differences

Item.VATDetails.BusinessSeller boolean Conditional 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.
Item.VATDetails
  .RestrictedToBusiness 		boolean Optional 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.
Item.VATDetails.VATPercent float Conditional 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.
Item.VIN string Optional Vehicle Identification Number, which is a unique serial number for a motor vehicle.

Applicable to listings in US eBay Motors Cars and Trucks (6001), Motorcycles (6024), Commercial Trucks (63732), RVs and Campers (50054), ATVs (6723), Snowmobiles (42595), and UTVs (173665); and to Cars and Trucks listings in CA, CAFR and AU eBay Motors. For vehicle categories that do not use VIN, call GetCategorySpecifics to determine applicable custom item specifics (such as "Hull ID Number" for Boats).

For the US, CA, and CAFR eBay Motors sites, required for cars and trucks from model year 1981 and later. (The US developed national standards for VIN values as of 1981.)

For the eBay Australia site, required for vehicles from model year 1989 or later. For the eBay Australia site, only appears on the View Item page if you also specify the date of first registration in the listing's item specifics.

Appears in the VIN field in the Item Specifics section of eBay's View Item page.

Not applicable to Half.com.
Max length: 17.
Item.VRM string Optional Vehicle Registration Mark, which is a unique identifier for a motor vehicle.

Applicable to listings in UK eBay Motors Cars and Trucks, Motorcycle, and some Powersport categories.

Appears as a VRM field in the Item Specifics section of eBay's View Item page. On the View Item page, the VRM value is masked (i.e., only a portion of the value is shown to users). In the GetItem response, the VRM is only returned if the call is made by the seller (i.e., the AuthToken is associated with the vehicle's seller).

Not applicable to Half.com.
Max length: 7.
SaleTemplateID long Required The ID of the sale template. You can obtain a SaleTemplateID by calling GetSellingManagerInventory or AddSellingManagerTemplate.
SaleTemplateName string Optional The name of the sale template.
VerifyOnly boolean Optional Use this field to verify the template instead of revising it.
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).
ID--- country
----- -----
de_AT Austria
de_CH Switzerland
de_DE Germany
en_AU Australia
en_CA Canada
en_GB United Kingdom
en_SG Singapore
en_US United States
es_ES Spain
fr_BE Belgium (French)
fr_CA Canada (French)
fr_FR France
it_IT Italy
nl_BE Belgium (Dutch)
nl_NL Netherlands
zh_CN China
en_IN India
en_IE Ireland
zh_HK Hong Kong

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

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

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

See:
    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 in your production code.

Applicable values:

•   High

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

•   Low

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


See Warning Level.



Back to top

Input Output Detail Controls Samples Change History Top Errors for ReviseSellingManagerTemplate User Notes

ReviseSellingManagerTemplate 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"?>
<ReviseSellingManagerTemplateResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <Category2ID> string </Category2ID>
  <CategoryID> string </CategoryID>
  <Fees> FeesType
    <Fee> FeeType
    </Fee>
    <!-- ... more Fee nodes allowed here ... -->
  </Fees>
  <SaleTemplateID> long </SaleTemplateID>
  <SaleTemplateName> string </SaleTemplateName>
  <SellingManagerProductDetails> SellingManagerProductDetailsType
    <CustomLabel> string </CustomLabel>
    <FolderID> long </FolderID>
    <Note> string </Note>
    <ProductID> long </ProductID>
    <ProductName> string </ProductName>
    <QuantityAvailable> int </QuantityAvailable>
    <RestockAlert> boolean </RestockAlert>
    <RestockThreshold> int </RestockThreshold>
    <UnitCost currencyID="CurrencyCodeType"> AmountType (double) </UnitCost>
    <VendorInfo> SellingManagerVendorDetailsType
      <VendorContactInfo> string </VendorContactInfo>
      <VendorName> string </VendorName>
    </VendorInfo>
  </SellingManagerProductDetails>
  <VerifyOnly> boolean </VerifyOnly>
  <!-- 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>
</ReviseSellingManagerTemplateResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
Category2ID string Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. Not applicable to Half.com.
CategoryID string Conditionally ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. Not applicable to Half.com.
Fees FeesType Always Child elements contain the estimated listing fees for the revised item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. Revising an item does not itself incur a fee. However, certain item properties are fee-based and result in the return of fees in the call's response. Not applicable to Half.com.
Fees.Fee FeeType Conditionally,
repeatable: [0..*]		 Contains the name, fee, and possible discount amount for an item listing feature. A Fee container is returned for each listing feature, even if the associated cost (Fee value) is 0.
SaleTemplateID long Always This sale template ID uniquely identifies the template that was revised in the request. This sale template ID should match the template ID specified in the request. specified for the call.
SaleTemplateName string Always The name of the sale template.
SellingManagerProductDetails SellingManagerProductDetailsType Always The details of the product that this template belongs to.
SellingManagerProductDetails
  .CustomLabel 		string Always Custom label of this product.
SellingManagerProductDetails
  .FolderID 		long Always ID of the inventory folder that contains the product. Value is initially returned in the AddSellingManagerInventoryFolder response.
SellingManagerProductDetails
  .Note 		string Always Seller's note about this product.
SellingManagerProductDetails
  .ProductID 		long Always The ID of a Selling Manager product. When you call AddSellingManagerProduct, a product ID is returned for the product created. When you use this ID to make subsequent calls, such as AddSellingManagerTemplate, the ProductID you provide on input is returned in the output.
SellingManagerProductDetails
  .ProductName 		string Always The name of a Selling Manager product. The AddSellingManagerProduct call is used to create a Selling Manager product.
SellingManagerProductDetails
  .QuantityAvailable 		int Always Quantity of items in the seller's inventory for this product.
SellingManagerProductDetails
  .RestockAlert 		boolean Always Specifies whether a restock alert is triggered for the product or not.
SellingManagerProductDetails
  .RestockThreshold 		int Conditionally Specifies the quantity at which a restock alert should be triggered.
SellingManagerProductDetails
  .UnitCost 		AmountType (double) Always Cost of each item of this product.
SellingManagerProductDetails
  .UnitCost
  [ attribute currencyID ]		 CurrencyCodeType Always Three-digit code representing the currency type being used.

In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated.

In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany.

For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerProductDetails
  .VendorInfo 		SellingManagerVendorDetailsType Conditionally Primary vendor information. Vendor information is returned only if it has been set.
SellingManagerProductDetails
  .VendorInfo.VendorContactInfo 		string Conditionally Contact information of vendor. Vendor information is returned only if it has been set.
SellingManagerProductDetails
  .VendorInfo.VendorName 		string Conditionally Primary vendor name. Vendor information is returned only if it has been set.
VerifyOnly boolean Always Instead of revising, only verifies the template.
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failure

(out) Request processing failed

•   Success

(out) Request processing succeeded

•   Warning

(out) Request processing completed with warning information being included in the response message


(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally 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.
Errors ErrorType Conditionally,
repeatable: [0..*]		 A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]		 This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]		 string Conditionally The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   Error

(out) Application-level error

•   Warning

(out) Warning or informational error
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.



Back to top

Input Output Detail Controls Samples Change History Top Errors for ReviseSellingManagerTemplate User Notes

ReviseSellingManagerTemplate Detail Controls


Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.



Back to top

Input Output Detail Controls Samples Change History Top Errors for ReviseSellingManagerTemplate User Notes

ReviseSellingManagerTemplate Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Revises an existing product template in Selling Manager.

Description

User magicalbookseller is making an addition to her item descriptions (in the Description field) that says a free bookmark will be provided with each item. User magicalbookseller modifies her SellingManager product template. Making a call to ReviseSellingManagerTemplate will allow her to change the template, so subsequent listings will include information about the free bookmark.

Input

The fields in the following ReviseSellingManagerTemplate request sample are the basic input needed to revise a Selling Manager product template.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<ReviseSellingManagerTemplateRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Item>
    <PostalCode>95125</PostalCode>
    <PrimaryCategory>
      <CategoryID>37905</CategoryID>
    </PrimaryCategory>
    <Country>US</Country>
    <Currency>USD</Currency>
    <Description><![CDATA[Harry Potter and the Prisoner of Azkaban
      <BR /><CENTER>This is a great brand new Harry Potter Book!
      <BR /><FONT FACE="Arial,Helvetica" SIZE="2">Powered by
      <A HREF="http://pages.ebay.com/turbo_lister/">eBay Turbo Lister</A></FONT></CENTER>]]></Description>
    <DispatchTimeMax>1</DispatchTimeMax>
    <ListingDuration>Days_7</ListingDuration>
    <GiftIcon>0</GiftIcon>
    <PaymentMethods>PayPal</PaymentMethods>
    <PayPalEmailAddress>PayPalEmail@ISP.net</PayPalEmailAddress>
    <PaymentMethods>VisaMC</PaymentMethods>
    <PrivateListing>0</PrivateListing>
    <Quantity>1</Quantity>
    <StartPrice currencyID="USD">15.00</StartPrice>
    <Storefront>
      <StoreCategoryID>1</StoreCategoryID>
    </Storefront>
    <Title>Harry Potter and the Prisoner of Azkaban</Title>
    <ListingType>FixedPriceItem</ListingType>
    <AttributeSetArray>
      <AttributeSet attributeSetID="2135" attributeSetVersion="54595">
        <Attribute attributeID="3806">
          <Value>
          </Value>
        </Attribute>
      </AttributeSet>
    </AttributeSetArray>
    <CategoryMappingAllowed>1</CategoryMappingAllowed>
    <CategoryBasedAttributesPrefill>1</CategoryBasedAttributesPrefill>
    <ShippingDetails>
      <ShippingType>Flat</ShippingType>
      <ShippingServiceOptions>
        <ShippingServicePriority>1</ShippingServicePriority>
        <ShippingService>UPS2ndDay</ShippingService>
        <ShippingServiceCost>5</ShippingServiceCost>
        <ShippingServiceAdditionalCost>1</ShippingServiceAdditionalCost>
        <ShippingSurcharge>1</ShippingSurcharge>
      </ShippingServiceOptions>
    </ShippingDetails>
    <ReturnPolicy>
      <Description>If its not in great shape, return it</Description>
      <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
    </ReturnPolicy>
  </Item>
  <Version>619</Version>
  <SaleTemplateID>6016918013</SaleTemplateID>
  <ModifiedFields>
    <Field>Item.Description</Field>
    <ModifyType>Modify</ModifyType>
  </ModifiedFields>
</ReviseSellingManagerTemplateRequest>

Output

The response includes the related Fees as well as template details.

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
 <ReviseSellingManagerTemplateResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2009-05-20T18:50:39.670Z</Timestamp>
   <Ack>Success</Ack>
   <Message>1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234<br/><font color="#BEBEBE" size="1">{e136367-111755-4}</font></Message>
   <Version>619</Version>
   <Build>e619__Bundled_8829789_R1</Build>
   <SaleTemplateID>6016918013</SaleTemplateID>
   <Fees>
     <Fee>
       <Name>AuctionLengthFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>BoldFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>BuyItNowFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>CategoryFeaturedFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>FeaturedFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>GalleryPlusFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>FeaturedGalleryFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>FixedPriceDurationFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>GalleryFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>GiftIconFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>HighLightFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>InsertionFee</Name>
       <Fee currencyID="USD">0.35</Fee>
     </Fee>
     <Fee>
       <Name>InternationalInsertionFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>ListingDesignerFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>ListingFee</Name>
       <Fee currencyID="USD">0.35</Fee>
     </Fee>
     <Fee>
       <Name>PhotoDisplayFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>PhotoFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>ReserveFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>SchedulingFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>SubtitleFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>BorderFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>ProPackBundleFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>BasicUpgradePackBundleFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>ValuePackBundleFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>PrivateListingFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>ExtendedDurationFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>ProPackPlusBundleFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
     <Fee>
       <Name>MotorsGermanySearchFee</Name>
       <Fee currencyID="USD">0.0</Fee>
     </Fee>
   </Fees>
   <SellingManagerProductDetails>
     <ProductID>6025559013</ProductID>
     <QuantityAvailable>-6</QuantityAvailable>
     <UnitCost>0.0</UnitCost>
   </SellingManagerProductDetails>
</ReviseSellingManagerTemplateResponse>



Back to top

Input Output Detail Controls Samples Change History Top Errors for ReviseSellingManagerTemplate User Notes

ReviseSellingManagerTemplate Change History

Version Description
817
2013-03-27
  • Item.ShippingPackageDetails (doc change): The ShippingPackageDetails container and its fields are available for this call, but were missing from the call reference. They are now shown in the input prototype and documented in the argument listings.
  • Item.DispatchTimeMax (modified): A DispatchTimeMax value of 0 indicates same day handling for an item, the timing of which depends on the order cut off time set in the seller's user preferences. 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).
807
2013-01-23
  • DispatchTimeMax (modified): A dispatch time value of '0' is not valid for use on eBay sites. 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.
801
2012-11-28
  • Item.PictureDetails.PictureURL, Item.PictureDetails.ExternalPictureURL (modified): The maximum length of PictureURL and ExternalPictureURL has been increased from 150 to 500 characters.
799
2012-11-07
  • ShippingDetailsType.InternationalShippingServiceOption (doc change): The description clarifies that 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).
795
2012-10-10
  • Item.ShippingDetails (doc change): Added a note to emphasize that when revising a listing, you must include all of the ShippingDetails fields that were originally provided, or their values will be discarded.
791
2012-09-12
  • InternationalShippingServiceOption.ShippingService (modified): New International shipping services added for UK and DE sites as part of the EU delivery estimate project. For UK, these new enumeration values are UK_ParcelForceIntlExpress, UK_ParcelForceIntlValue, and UK_ParcelForceIntlEconomy. For DE, these new enumeration values are DE_DeutschePostBriefIntlEcon and DE_DeutschePostBriefIntlPriority.
789
2012-08-29
  • Item.ConditionDescription (added): This string field is used by the seller to more clearly describe the condition of items that are not brand new.
  • Item.ListingSubtype2 (doc change): A note was added to clarify that 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.
787
2012-08-15
  • Item.ShippingDetails.RateTableDetails (doc change): Documentation for this container and its fields has been revised to be more accurate and easier to understand.
  • Item.ShippingDetails.RateTableDetails.InternationalRateTable (added): 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, and the seller must have previously configured a table in My eBay site preferences. Shipping rate tables enable sellers to tailor the flat shipping rates offered for an item to fit the shipping destination. They can specify a base rate for a large region, then define alternative rates or surcharges for shipping to individual countries within the region.
783
2012-07-18
  • ReturnPolicy.RestockingFeeValueOption (added): 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.
781
2012-07-04
  • ShippingServiceCodeType (modified): AU_StandardDeliveryFromOutsideAU added as a shipping service option. This option can be specified by sellers on the AU site if the item is being shipped from a location outside of Australia using standard delivery.
775
2012-05-23
  • ProductListingDetails.GTIN (added): New product identifier. Applicable only to listing requests.
757
2012-01-18
  • VIN, VRM (added): Fields for US, Canada, and UK eBay Motors vehicles (previously available as ID-based attributes).
743
2011-10-12
  • SellerProvidedTitle, PaymentDetails.DepositAmount, PaymentDetails.DepositType (added): Fields for US and Canada eBay Motors vehicles (previously available as ID-based attributes).
735
2011-08-17
  • ItemSpecifics, AttributeSetArray (modified): You can now use custom item specifics instead of ID-based attributes for ticket listings.
  • ReturnPolicy.RefundOption (modified): MoneyBackOrExchange value is now supported.
719
2011-04-27
  • ShippingServiceCodeType (modified): 15 new shipping services added for the Australia and Canada sites. The nine new Australia carrier-specific shipping services include AU_AusPostRegisteredPostInternationalPaddedBag1kg, AU_AusPostRegisteredPostInternationalPaddedBag500g, AU_AusPostRegisteredPostInternationalParcel, AU_AustralianAirExpressFlatRate1kg, AU_AustralianAirExpressFlatRate3kg, AU_AustralianAirExpressFlatRate5kg, AU_AustralianAirExpressMetro15kg, AU_eBayAusPost3kgFlatRateSatchel, and AU_eBayAusPost500gFlatRateSatchel. The nine new Australia generic service level shipping services include AU_EconomyDeliveryFromOutsideAU, AU_ExpeditedDeliveryFromOutsideAU, AU_ExpressDelivery, AU_Freight, and AU_StandardDelivery. The new Canada shipping service is CA_Freight.
  • Item.ShippingDetails.ShippingServiceOptions (modified): '4' has been added as a valid integer value to account for the additional international shipping service that may be specified by the seller.
  • Item.ShippingDetails.InternationalShippingServiceOption (modified): '4' and '5' have been added as valid integer values to account for the additional international shipping services that may be specified by the seller.
689
2010-09-20
  • Item.ApplyShippingDiscount (deprecated): As of version 689, Item.ApplyShippingDiscount is deprecated and removed from the schema.
  • Item.SecondaryCategory (modified): Items in value categories can't be listed in two categories. eBay drops SecondaryCategory in listings if either PrimaryCategory or SecondaryCategory is a value category (see ValueCategory in GetCategoryFeatures).
687
2010-09-15
  • ItemCompatibilityList (modified): Invalid item compatibility combinations will no longer cause the request to fail as long as ItemCompatibilityList contains at least one valid item compatibility.
685
2010-08-24
  • ShippingDetails.RateTableDetails (added): Sellers can now specify the use of domestic shipping rate tables, which are set up in eBay Site Preferences, to specify different rates for different special domestic locations. Applies to the following sites:
    DE, UK, US
  • ExcludeShipToLocation (modified): Sellers can now exclude special domestic locations from where they will ship items. Applies to the following sites:
    DE, UK, US
675
2010-06-23
  • Item.LimitedWarrantyEligible (deprecated): This feature is no longer supported and the field is ignored in listing requests. It will be removed from the schema soon.
663
2010-03-31
  • Item.ApplyShippingDiscount (deprecated): This tag is no longer being used. It will be officially deprecated later in 2010.
661
2010-03-17
  • ConditionID (added): ConditionID is supported in the Sandbox for a few categories. Starting in May 2010, it will be functional in production for most categories. Use ConditionID instead of AttributeSetArray or ItemSpecifics to specify the item's condition when GetCategoryFeatures shows ConditionEnabled=Enabled or Required for the listing's primary category.
  • DeletedField (modified): Deleted field can be used to delete ConditionID.
653
2010-01-20
  • Item.CompatibilityList (added): Specify a list of parts compatibility information specified as name and value pairs. Describes assemblies (e.g., year, make, model, trim, and engine values for specific vehicles) to which the part/item applies (i.e., compatiblity by application).
635
2009-09-16
  • InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites:
    BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US
    Insurance tags are returned only when the associated item has buyer-paid shipping insurance values.
619
2009-05-27
  • BrandMPN, EAN, ISBN, TicketListingDetails, UPC, ListIfNoProduct, UseFirstProduct, ReturnSearchResultsOnDuplicate (added): ProductListingDetails now supports more industry-standard values, plus more control over the product matching behavior. ExternalProductID will be deprecated in a future release.
615
2008-04-29
  • Variations (added): New node for describing variations in a multi-variation listing.
605
2009-02-18
  • NowAndNew (deprecated): Now & New (Sofort & Neu) has been retired as of this release.
599
2009-1-07
  • NowAndNew (doc change): eBay will retire Now & New (Sofort & Neu) by March 2009.
589
2008-10-30
  • (added) New call.



Back to top

Input Output Detail Controls Samples Change History Top Errors for ReviseSellingManagerTemplate User Notes

User-Contributed Notes

   
 
 
 

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.