eBay Trading APIVersion 1039

AddFixedPriceItem

Use this call to define and list a new fixed-price item. This call returns the item ID for the new listing, plus an estimation of the fees the seller will incur for posting the listing (not including the Final Value Fee, which cannot be calculated until the listing has ended).

Note: Sellers may be subject to call-rate limits for Add calls. The Add calls include AddItem, AddFixedPriceItem, AddItems, AddSellingManagerTemplate, VerifyAddItem, and VerifyAddFixedPriceItem.

Users who exceed these call frequency limits for Add calls 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.

A fixed-price listing can include multiple, identical items for sale by setting the Quantity to a value greater than 1.

AddFixedPriceItem is nearly identical to AddItem, with these differences:

To list multiple unrelated fixed-price items, call AddFixedPriceItem once for each type of item.

If needed, you can upload multiple AddFixedPriceItem requests in bulk (several thousand at once) using the Bulk Data Exchange API and the File Transfer API. Even though this does not reduce the number of calls you need to make, these APIs are optimized to let you to list a very large number of items more quickly than you can with the Trading API.

For Best Match information related to multi-variation listings, see Multi-quantity Fixed Price listings with variations. If you are considering an item's rank (placement) in search results, see Considering Best Match When Revising and Relisting Items.

Note to Large Merchant Services users: When you use AddFixedPriceItem within a Merchant Data file, your request must be enclosed within BulkDataExchangeRequest tags. In addition, this call returns a namespace in BulkDataExchangeResponse, a top-level container in the response. This container is not shown in the standard Input/Output sections for this call. However, you can see examples of this container in both the request and response in the Samples section below.

You can test this call in the Sandbox environment.

See:
    Listing an Item
    Listing Items
    Introduction to Pictures in Item Listings
    Multi-Variation Listings
    Considering Best Match When Revising and Relisting Items

See also the reference documentation for these calls:



Input

See also Samples.

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

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

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

<?xml version="1.0" encoding="utf-8"?>
<AddFixedPriceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <Item> ItemType
    <ApplicationData> string </ApplicationData>
    <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>
    <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 ... -->
    <Currency> CurrencyCodeType </Currency>
    <Description> string </Description>
    <DigitalGoodInfo> DigitalGoodInfoType
      <DigitalDelivery> boolean </DigitalDelivery>
    </DigitalGoodInfo>
    <DisableBuyerRequirements> boolean </DisableBuyerRequirements>
    <DiscountPriceInfo> DiscountPriceInfoType
      <MadeForOutletComparisonPrice> AmountType (double) </MadeForOutletComparisonPrice>
      <MinimumAdvertisedPrice> AmountType (double) </MinimumAdvertisedPrice>
      <MinimumAdvertisedPriceExposure> MinimumAdvertisedPriceExposureCodeType </MinimumAdvertisedPriceExposure>
      <OriginalRetailPrice> AmountType (double) </OriginalRetailPrice>
      <SoldOffeBay> boolean </SoldOffeBay>
      <SoldOneBay> boolean </SoldOneBay>
    </DiscountPriceInfo>
    <DispatchTimeMax> int </DispatchTimeMax>
    <eBayNowEligible> boolean </eBayNowEligible>
    <eBayPlus> boolean </eBayPlus>
    <HitCounter> HitCounterCodeType </HitCounter>
    <IncludeRecommendations> boolean </IncludeRecommendations>
    <InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod>
    <ItemCompatibilityList> ItemCompatibilityListType
      <Compatibility> ItemCompatibilityType
        <CompatibilityNotes> string </CompatibilityNotes>
        <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>
    <ListingDesigner> ListingDesignerType
      <LayoutID> int </LayoutID>
      <OptimalPictureSize> boolean </OptimalPictureSize>
      <ThemeID> int </ThemeID>
    </ListingDesigner>
    <ListingDetails> ListingDetailsType
      <BestOfferAutoAcceptPrice> AmountType (double) </BestOfferAutoAcceptPrice>
      <LocalListingDistance> string </LocalListingDistance>
      <MinimumBestOfferPrice> AmountType (double) </MinimumBestOfferPrice>
    </ListingDetails>
    <ListingDuration> token </ListingDuration>
    <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
    <!-- ... more ListingEnhancement values allowed here ... -->
    <ListingType> ListingTypeCodeType </ListingType>
    <Location> string </Location>
    <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
    <!-- ... more PaymentMethods values allowed here ... -->
    <PayPalEmailAddress> string </PayPalEmailAddress>
    <PickupInStoreDetails> PickupInStoreDetailsType
      <EligibleForPickupDropOff> boolean </EligibleForPickupDropOff>
      <EligibleForPickupInStore> boolean </EligibleForPickupInStore>
    </PickupInStoreDetails>
    <PictureDetails> PictureDetailsType
      <GalleryDuration> token </GalleryDuration>
      <GalleryType> GalleryTypeCodeType </GalleryType>
      <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
      <PictureSource> PictureSourceCodeType </PictureSource>
      <PictureURL> anyURI </PictureURL>
      <!-- ... more PictureURL values allowed here ... -->
    </PictureDetails>
    <PostalCode> string </PostalCode>
    <PrimaryCategory> CategoryType
      <CategoryID> string </CategoryID>
    </PrimaryCategory>
    <PrivateListing> boolean </PrivateListing>
    <PrivateNotes> string </PrivateNotes>
    <ProductListingDetails> ProductListingDetailsType
      <BrandMPN> BrandMPNType
        <Brand> string </Brand>
        <MPN> string </MPN>
      </BrandMPN>
      <EAN> string </EAN>
      <IncludeeBayProductDetails> boolean </IncludeeBayProductDetails>
      <IncludeStockPhotoURL> boolean </IncludeStockPhotoURL>
      <ISBN> string </ISBN>
      <NameValueList> NameValueListType
        <Name> string </Name>
        <Value> string </Value>
        <!-- ... more Value values allowed here ... -->
      </NameValueList>
      <!-- ... more NameValueList nodes allowed here ... -->
      <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>
    <QuantityInfo> QuantityInfoType
      <MinimumRemnantSet> int </MinimumRemnantSet>
    </QuantityInfo>
    <QuantityRestrictionPerBuyer> QuantityRestrictionPerBuyerInfoType
      <MaximumQuantity> int </MaximumQuantity>
    </QuantityRestrictionPerBuyer>
    <ReturnPolicy> ReturnPolicyType
      <Description> string </Description>
      <ExtendedHolidayReturns> boolean </ExtendedHolidayReturns>
      <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>
    <SellerProfiles> SellerProfilesType
      <SellerPaymentProfile> SellerPaymentProfileType
        <PaymentProfileID> long </PaymentProfileID>
        <PaymentProfileName> string </PaymentProfileName>
      </SellerPaymentProfile>
      <SellerReturnProfile> SellerReturnProfileType
        <ReturnProfileID> long </ReturnProfileID>
        <ReturnProfileName> string </ReturnProfileName>
      </SellerReturnProfile>
      <SellerShippingProfile> SellerShippingProfileType
        <ShippingProfileID> long </ShippingProfileID>
        <ShippingProfileName> string </ShippingProfileName>
      </SellerShippingProfile>
    </SellerProfiles>
    <SellerProvidedTitle> string </SellerProvidedTitle>
    <ShippingDetails> ShippingDetailsType
      <CalculatedShippingRate> CalculatedShippingRateType
        <InternationalPackagingHandlingCosts> AmountType (double) </InternationalPackagingHandlingCosts>
        <MeasurementUnit> MeasurementSystemCodeType </MeasurementUnit>
        <OriginatingPostalCode> string </OriginatingPostalCode>
        <PackagingHandlingCosts> AmountType (double) </PackagingHandlingCosts>
        <ShippingIrregular> boolean </ShippingIrregular>
      </CalculatedShippingRate>
      <CODCost> AmountType (double) </CODCost>
      <ExcludeShipToLocation> string </ExcludeShipToLocation>
      <!-- ... more ExcludeShipToLocation values allowed here ... -->
      <GlobalShipping> boolean </GlobalShipping>
      <InternationalPromotionalShippingDiscount> boolean </InternationalPromotionalShippingDiscount>
      <InternationalShippingDiscountProfileID> string </InternationalShippingDiscountProfileID>
      <InternationalShippingServiceOption> InternationalShippingServiceOptionsType
        <ShippingService> token </ShippingService>
        <ShippingServiceAdditionalCost> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost> 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>
        <DomesticRateTableId> string </DomesticRateTableId>
        <InternationalRateTable> string </InternationalRateTable>
        <InternationalRateTableId> string </InternationalRateTableId>
      </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> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
        <ShippingSurcharge> 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>
    <ShippingServiceCostOverrideList> ShippingServiceCostOverrideListType
      <ShippingServiceCostOverride> ShippingServiceCostOverrideType
        <ShippingServiceAdditionalCost> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
        <ShippingServiceType> ShippingServiceType </ShippingServiceType>
        <ShippingSurcharge> AmountType (double) </ShippingSurcharge>
      </ShippingServiceCostOverride>
      <!-- ... more ShippingServiceCostOverride nodes allowed here ... -->
    </ShippingServiceCostOverrideList>
    <ShippingTermsInDescription> boolean </ShippingTermsInDescription>
    <ShipToLocations> string </ShipToLocations>
    <!-- ... more ShipToLocations values allowed here ... -->
    <Site> SiteCodeType </Site>
    <SKU> SKUType (string) </SKU>
    <StartPrice> AmountType (double) </StartPrice>
    <Storefront> StorefrontType
      <StoreCategory2ID> long </StoreCategory2ID>
      <StoreCategory2Name> string </StoreCategory2Name>
      <StoreCategoryID> long </StoreCategoryID>
      <StoreCategoryName> string </StoreCategoryName>
    </Storefront>
    <SubTitle> string </SubTitle>
    <TaxCategory> string </TaxCategory>
    <Title> string </Title>
    <UseTaxTable> boolean </UseTaxTable>
    <UUID> UUIDType (string) </UUID>
    <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
        <DiscountPriceInfo> DiscountPriceInfoType
          <MadeForOutletComparisonPrice> AmountType (double) </MadeForOutletComparisonPrice>
          <MinimumAdvertisedPrice> AmountType (double) </MinimumAdvertisedPrice>
          <MinimumAdvertisedPriceExposure> MinimumAdvertisedPriceExposureCodeType </MinimumAdvertisedPriceExposure>
          <OriginalRetailPrice> AmountType (double) </OriginalRetailPrice>
          <SoldOffeBay> boolean </SoldOffeBay>
          <SoldOneBay> boolean </SoldOneBay>
        </DiscountPriceInfo>
        <Quantity> int </Quantity>
        <SKU> SKUType (string) </SKU>
        <StartPrice> AmountType (double) </StartPrice>
        <VariationProductListingDetails> VariationProductListingDetailsType
          <EAN> string </EAN>
          <ISBN> string </ISBN>
          <NameValueList> NameValueListType
            <Name> string </Name>
            <Value> string </Value>
            <!-- ... more Value values allowed here ... -->
          </NameValueList>
          <!-- ... more NameValueList nodes allowed here ... -->
          <UPC> string </UPC>
        </VariationProductListingDetails>
        <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>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</AddFixedPriceItemRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
Item ItemType Required This container is used to specify all of the values and settings that define a new fixed-price listing.
Item.ApplicationData string Optional Return custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField.
Max length: 32.
Item.AutoPay boolean Optional If true, the seller requests immediate payment for the item. If false or not specified, immediate payment is not requested. (In responses, does not indicate whether the item is actually still a candidate for purchase via immediate payment.)

Only applicable to items listed on PayPal-enabled sites in categories that support immediate payment (see AutoPayEnabled in GetCategories), when seller has a Premier or Business PayPal account (see PayPalAccountType in GetUser).

To create an Immediate Payment listing, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and the only included PaymentMethods value must be PayPal.

For a non-Immediate Payment listing, the AutoPay flag is not required.

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

Note: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. The seller can offer Buy It Now or Best Offer in an auction listing, but not both features.
Item.BestOfferDetails
  .BestOfferEnabled
boolean Optional This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a fixed-price or classified ad listing as long as the category supports the Best Offer feature. To see if an eBay category supports the Best Offer feature, run a GetCategoryFeatures call, including BestOfferEnabled as a FeatureID value in the call request payload.

A listing enabled with the Best Offer feature allows a buyer to bargain with the seller and make a lower-priced offer than the fixed price. The seller can then decide whether to accept the buyer's Best Offer price or propose a counter offer higher than the Best Offer price, but lower than the fixed price.

For a ReviseItem or ReviseFixedPriceItem call, this boolean value can only be changed (enable or disable) in a fixed-price listing if the listing has not had any sales (Best Offer or standard purchase), the listing does not have any Best Offer or counter offers pending, and the listing is not scheduled to end within 12 hours. Some large merchant accounts are enabled to revise this field through a Revise call even within 12 hours of the listing's scheduled end time, but these sellers are still subject to the other two rules - no sales of any kind for the listing, and no Best Offers or counter offers pending.

Note: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. The seller can offer Buy It Now or Best Offer in an auction listing, but not both features.
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.

See Selecting Buyer Requirements (eBay 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_180
(in/out) This value indicates that the evaluation period is set back 180 days from the present date.
Days_30
(in/out) This value indicates that the evaluation period is set back 30 days from the present date.

(Not all values in PeriodCodeType apply to this field.)
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 quantity of an order line item that a prospective buyer may purchase from the seller during any given 10-day period. The prospective buyer will be blocked from bidding/buying once this value is reached.

Valid values for the US site: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 25, 50, 75, and 100.
To see the valid values for your site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.MaximumItemRequirements.MaximumItemCount fields.

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.

Valid values for the US site: 0, 1, 2, 3, 4, and 5.
To see the valid values for your site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.MaximumItemRequirements.MinimumFeedbackScore fields.
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. A buyer receives an Unpaid Item Strike is a seller files an Unpaid Item case against the buyer, and eBay rules in favor of the seller.
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_180
(in/out) This value indicates that the evaluation period is set back 180 days from the present date.
Days_30
(in/out) This value indicates that the evaluation period is set back 30 days from the present date.
Days_360
(in/out) This value indicates that the evaluation period is set back 360 days from the present date.

(Not all values in PeriodCodeType apply to this field.)
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 are not verified users on PayPal, or in the case of eBay India, not verified users on PaisaPay.

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

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

Default: 5.
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 Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call GeteBayDetails with DetailName set to BuyerRequirementDetails, and then look for the BuyerRequirementDetails.VerifiedUserRequirements container.

Default: false.

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
  .CategoryBasedAttributesPrefill
boolean Optional Allows eBay to auto-fill some of a listing's Item Specifics values based on the listing's category. Auto-filling Item Specifics based on a category is not the same as using pre-filled product information based on a catalog product (see ProductListingDetails). If true, also specify Item.CategoryMappingAllowed with a value of true. This is ignored if the category does not support auto-filling Item Specifics.
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 ID that is mapped to the same category and use the new ID for the listing (if any). The new 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.

See Maintaining Category Data.

Item.Charity CharityType Optional This container identifies the nonprofit organization that will benefit with a percentage of the proceeds from the sale of an item through an auction or fixed-price listing. Charity names and IDs can be found by going to eBay for Charity page and doing a search for a charity registered with the PayPal Giving Fund. The donation percentage can be set in 5 percent increments from 10 percent to 100 percent. If a benefitting charity is specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

When it comes to revising an auction or fixed-price listing, you can add a benefitting charity (as long as there is at least 12 hours left before end of listing/close of auction), but you cannot remove or change a nonprofit company once one is already established in the original listing.

This container will only be returned in Get calls for listings that will benefit a nonprofit organization if the item sells.

See:
    Miscellaneous Item Field Differences
    Identifying Listings that Benefit Nonprofits

Item.Charity.CharityID string Conditional A unique identification number assigned by the PayPal Giving Fund to registered nonprofit charity organizations. This field is required when creating eBay for Charity listings.
Item.Charity.CharityNumber int Optional A unique identifier assigned to a nonprofit charity organization by the PayPal Giving Fund. 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 eBay for Charity listing. Possible values: 10.0 to 100.0. DonationPercent is required input when creating eBay for Charity listings.
Item.ConditionDescription string Conditional 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. ConditionDescription is currently supported on the eBay US and US eBay Motors (0), UK (3), CA (2), CAFR (210), AU (15), AT (16), BEFR (23), BENL (123), FR (71), DE (77), IT (101), NL (146), ES (186), CH (193), IE (205) and PL (212) sites.
The ConditionDescription field is returned by GetItem (and other related calls that return the Item object) if a condition description is specified in the listing.

Max length: 1000.
Item.ConditionID int Conditional This is a numeric identifier for an item's condition. All numeric Condition ID values map to item condition string value. For example, numeric identifer 1000 maps to New condition.

Most eBay categories require an item condition, but a few eBay categories do not. To verify if the listing category requires an item condition, and if so, what are the supported item condition and ConditionID values, you can call GetCategoryFeatures. In this GetCategoryFeatures call, you'd pass in the listing CategoryID value and two FeatureID fields - one of these fields set to ConditionEnabled, and the other field set to ConditionValues.

In the GetCategoryFeatures response, look at the Category.ConditionEnabled to see if item condition is required for the category. Then look at the Category.ConditionValues container in the response for the full list of Condition IDs that you can pass in through the ConditionID field of an Add/Revise/Relist/Verify call. Note that the Condition.DisplayName value in the response is the actual condition value that will appear in the actual eBay listing.

If you pass in a ConditionID value that is not valid for the category, or if you don't pass in a ConditionID value at all for a category that requires it, the listing request fails.

If you are listing in two categories (using a secondary category), it is the primary listing category that determines which ConditionID values are supported.

For Revise/Relist calls: In most cases, you can change the ConditionID value (if applicable/warranted), with the exception being an auction listing that has one or more bids, or any listing that is scheduled to end in 12 hours or less.

For GetItem: The ConditionID value is always returned if set for the listing. GetItem also returns the item condition string value in the ConditionDisplayName field.

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

Item.Country CountryCodeType Required This two-digit enumeration value indicates the country of the seller's registration address. CountryCodeType defines the supported values. The GeteBayDetails call can also be used (include the DetailName field and set its value to CountryDetails) to see the full list of supported country codes.

In an Add/Revise/Relist/Verify call, this field is required.

Applicable values: See Country.
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.Currency CurrencyCodeType Required In an Add/Revise/Relist/Verify call, this required three-digit enumeration value defines the currency associated with the listing site. The item price and all costs passed in the call request will be using this currency. Similarly, the listing fees and other cost-related data will be using this currency. Since the Trading API can only be used for a select number of eBay sites, only a subset of values are supporting when adding/revising/relisting an item. These supported values are discussed in the top section of CurrencyCodeType.

In 'Get' calls, it is possible that any of the values in CurrencyCodeType may appear, as some cost-related fields will show the buyer's currency type.

Applicable values: See Currency.

See Field Differences for eBay Sites.

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. However, seller can not use any active content in their listing description. Active content includes animation or video via JavaScript, Flash, plug-ins, or form actions. All active content will be blocked/removed from a listing. Removing/blocking active content will lead to faster load times of listings, make listings more mobile-friendly, improve SEO performance, and lead to a more secure eBay Marketplace. For more tips on creating listings that are even more mobile-friendly, see this Best practices document.

For more information about eBay phasing out active content, see this Seller Update page. For more information about eBay's JavaScript/Active Content policy, see the JavaScript policy page.

No seller contact information or links may be included in the listing description. If you embed pictures in the description (by using IMG tags) instead of using PictureURL, but you want a camera icon to appear in search and listing pages, specify the following null-image URL in the PictureURL field: https://pics.ebay.com/aw/pics/dot_clear.gif. See Working with Pictures in an Item Listing in the eBay Features Guide.

This field is conditionally required for all listings. The exception is when the seller specifies a product identifier through the ProductListingDetails container and a product match is found in the eBay product catalog. If a matching product is found in the eBay product catalog, the item description will be created automatically (as long as the ProductListingDetails.IncludeeBayProductDetails value is true).

Max length: 500000 (some sites may allow more, but the exact number may vary).

See IncludeeBayProductDetails.

Item.DigitalGoodInfo DigitalGoodInfoType Optional This container is used in Add/Revise/Relist/Verify listing calls to designate the listing as a digital gift card listing. It is also returned in GetItem to indicate that the listing contains a digital gift card.
Item.DigitalGoodInfo
  .DigitalDelivery
boolean Optional This field must be included in the request and set to true if the seller plans to list a digital gift card in a category that supports digital gift cards.

To verify if a specific category on a specific eBay site supports digital gift card listings, use the GetCategoryFeatures call, passing in a CategoryID value and a DigitalGoodDeliveryEnabled value in the FeatureID field. Look for a true value in the DigitalGoodDeliveryEnabled field of the corresponding Category node (match up the CategoryID values if more than one Category IDs were passed in the request).
Item.DisableBuyerRequirements boolean 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.DiscountPriceInfo DiscountPriceInfoType Optional This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites, while MAP is available only on the US site.

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

As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing.

For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem: If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation.
Item.DiscountPriceInfo
  .MadeForOutletComparisonPrice
AmountType (double) Conditional Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet).

The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet.

In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.)
Item.DiscountPriceInfo
  .MinimumAdvertisedPrice
AmountType (double) Conditional Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can offer prices below MAP by means of other discounts. This only applies to fixed-price listings and auction listings with the Buy It Now option.
Item.DiscountPriceInfo
  .MinimumAdvertisedPriceExposure
MinimumAdvertisedPriceExposureCodeType Conditional For MinimumAdvertisedPrice (MAP) listings only. A seller cannot show the actual discounted price on eBay's View Item page. Instead, the buyer can either click on a pop-up on eBay's View Item page, or the discount price will be shown during checkout.

Applicable values:

CustomCode
(in/out) Reserved for future use.
DuringCheckout
(in/out) DuringCheckout specifies that the discounted price must be shown on the eBay checkout flow page.
None
(in/out) None means the discount price is not shown via either PreCheckout nor DuringCheckout.
PreCheckout
(in/out) PreCheckout specifies that the buyer must click a link (or a button) to navigate to a separate page (or window) that displays the discount price. eBay displays the discounted item price in a pop-up window.
Item.DiscountPriceInfo
  .OriginalRetailPrice
AmountType (double) Conditional The actual retail price set by the manufacturer (OEM). eBay does not maintain or validate the OriginalRetailPrice supplied by the seller. OriginalRetailPrice should always be more than StartPrice. Compare the StartPrice/BuyItNowPrice to OriginalRetailPrice to determine the amount of savings to the buyer.
Item.DiscountPriceInfo
  .SoldOffeBay
boolean Conditional Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on a Web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the seller's own price for the item.

If this field is set to true, eBay displays 'Was*' in the UK and 'Ursprunglich*' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set to true, SoldOneBay takes precedence.

Default: false.
Item.DiscountPriceInfo
  .SoldOneBay
boolean Conditional Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on eBay within the previous 30 days. The discount price is always in reference to the seller's own price for the item.

If this field is set to true, eBay displays 'Was' in the UK and 'Ursprunglich' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set to true, SoldOneBay takes precedence.

Default: false.
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).

Note: If the seller opts into the eBay Guaranteed Delivery feature (becoming available in October 2017) and wants to make a listing eligible for eBay Guaranteed Delivery, the DispatchTimeMax value plus the maximum shipping time of the shipping service (returned in the ShippingServiceDetails.ShippingTimeMax field of GeteBayDetails must be 4 business days for the listing to be eligible for this feature.
For Add/Revise/Relist calls: Required for listings in certain categories when certain shipping services (with delivery) are offered. See HandlingTimeEnabled in GetCategoryFeatures.

The seller sets this to a positive integer value corresponding to the number of days. For a list of allowed values on each eBay site, use DispatchTimeMaxDetails in GeteBayDetails. (Typical values are 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 it is freight shipping. For example, when ShippingService = Pickup or ShipToLocations = None, then DispatchTimeMax is not required (or it can be 0).

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:
    Handling Time and Estimated Delivery Time
    (GetCategoryFeatures) SiteDefaults.HandlingTimeEnabled

Item.eBayNowEligible boolean Conditional Note: eBay Now has been officially retired in all US locations, so this field is no longer applicable for US listings. However, a feature similar to eBay Now, called 'eBay Scheduled Delivery', is available in some parts of London, so this field is still applicable on the eBay UK site. This boolean field is returned as true if the listing category supports eBay Scheduled Delivery. A true value does not necessarily mean that the seller has enabled the item with the eBay Scheduled Delivery feature. A listing is enabled with the eBay Scheduled Delivery feature if the eBayNowAvailable field is returned as true.

With eBay Scheduled Delivery, buyers in the London area are able to purchase an item, and then select a short time window (the same day or the following day) in which the item will be delivered.

For some eBay Scheduled Delivery listings, buyers may be able to select an 'As soon as possible' delivery option where a courier will deliver their item within two hours.
Item.eBayPlus boolean Optional If true, this item is being offered under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany (DE), but this program is scheduled to come to the Austria and Australia marketplaces in the near future.

See Offering eBay Plus for more details.

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.

Default: NoHitCounter.

Applicable values: See HitCounter.
Item.IncludeRecommendations boolean Optional This boolean field should be included and set to true if the seller wishes to see listing recommendations in the call response via the ListingRecommendations container. Listing recommendations provide one or more messages to the seller on recommendations on:
  • improving a listing
  • bringing a listing up to standard in regards to Top-Rated seller/listing requirements
  • mandated or recommended Item Specifics
  • picture quality requirements
  • pricing and/or listing format recommendations
  • recommended keywords and/or Item Specifics in a Title
  • offering fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge
Item.InventoryTrackingMethod InventoryTrackingMethodCodeType Optional Indicates whether you prefer to track your eBay listings by eBay Item ID or by your own SKU.

If a seller will be converting an existing eBay listing into the new Inventory model using the bulkMigrateListings call of the Inventory API, the InventoryTrackingMethod value must be set to ItemID (default value), but the item must also have a SKU value (Item.SKU or Variation.SKU) associated with it. For GetItem and related calls: Only returned when the value is SKU; not returned when the value is ItemID.
Default: ItemID.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
ItemID
(in/out) Indicates the seller prefers to track the listing by its eBay item ID. This is the default for all listings.
SKU
(in/out) Indicates the seller prefers to track the listing by their own SKU.

When you track by SKU, it means you can pass in your SKU instead of the eBay item ID in other calls that support SKU as an input field. If you choose SKU as your tracking preference for a listing, the value in Item.SKU must be unique across your active listings. You cannot create new listings with the same Item.SKU value while the listing is active (that is, until the existing listing with that SKU has ended).

However, you can use ReviseInventoryStatus to update the quantity and/or price for the existing SKU as needed. When revising a listing where the InventoryTrackingMethod was set to SKU, you must pass in both the InventoryTrackingMethod tag (with the value set to SKU) and the SKU tag with the SKU value from your original listing.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

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 describe the specific vehicle, such as a 2006 Honda Accord. Use the Product Metadata API to retrieve valid search names and corresponding values.

For the AddItem family of calls: Use this for specifying parts compatibility by application manually. This can only be used in categories that support parts compatibility by application. Use GetCategoryFeatures with the CompatibilityEnabled feature ID to determine which categories support parts compatibility by application.

For ReviseFixedPriceItem and ReviseItem: When you revise a listing, if the listing has bids and/or ends within 12 hours, item compatibilities cannot be deleted. You may add item compatibilities at any time.

For GetItem: ItemCompatibilityList is only returned if the seller included item compatibility in the listing and IncludeItemCompatibilityList is set to true in the GetItem request.

Parts Compatibility is supported in limited Parts & Accessories categories for the eBay Motors (US) site (site ID 100) only.

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 parts compatibility notes. When revising or relisting, the Delete field can be used to delete individual parts compatibility nodes.

Note: For the GetItem call, Compatibility includes only parts compatibility details that were specified manually; that is, they do not correspond to an eBay catalog product. To retrieve parts compatibility details that do correspond to eBay catalog products, use the eBay Product API's getProductCompatibilities call.
Item.ItemCompatibilityList
  .Compatibility
  .CompatibilityNotes
string Conditional The seller may optionally enter any notes pertaining to the parts compatibility being specified. Use this field to specify the placement of the part on a vehicle or the type of vehicle a part fits.
Item.ItemCompatibilityList
  .Compatibility.NameValueList
NameValueListType 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. For details and examples, see the Features Guide.

The DE, UK, and AU eBay sites support the use of K type vehicle numbers to specify vehicle parts compatibility. To use a K type number, set the Name field to "KType" and set the corresponding Value field to the appropriate K type number.

The DE and UK eBay sites also support the use of an eBay Product ID (or ePID) number/value pair to specify motorcycle and scooter parts compatibility (currently, only DE supports scooter parts compatibily). To use an ePID number to specify part compatibilities, set the Name field to "ePID" and the corresponding Value field to the ePID number that matches the motorcycle for the part(s) you are listing. Motorcycle ePID numbers are provided by the Master Motorcycle List (MML) file, which contains the ePID numbers and their associated vehicle mappings). For motorcycles, an ePID number contains the vehicle make, model, CCM, year, and submodel data. Please use the following links to obtain the DE and UK MML data files:

- DE seller help page: http://verkaeuferportal.ebay.de/fahrzeugteile-und-zubehoer-optimal-einstellen
- UK seller help page: http://pages.ebay.co.uk/help/sell/contextual/master-motorcycle-list-manually.html

See Product Metadata API Call Reference for information on retrieving parts compatibility search names and corresponding values needed to specify compatibility by application manually.

Item.ItemCompatibilityList
  .Compatibility.NameValueList
  .Name
string Conditional Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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.

Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.
Item.ItemCompatibilityList
  .Compatibility.NameValueList
  .Value
string Conditional,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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: 65.
Item.ItemSpecifics NameValueListArrayType Optional A list of item specific Name/Value pairs that the seller provided for the item. (To retrieve mandatory and recommended item specifics for a category, use GetCategorySpecifics.)

In the Add, Relist, Revise, and Verify families of calls, use this list to define custom item specifics.

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

If your item is in a catalog-enabled category, certain Name/Value pairs will be accepted as product identifying information. The Name can be Brand, MPN, or a Global Trade Item Number (GTIN). GTINs are a set of globally recognized identifiers, including EAN, ISBN, JAN, and UPC. However, the Values provided for these Names must comply with eBay's constraints or they will not be recognized as product identifiers. The Value for Brand must be an actual brand name (except that if the item is not branded, Value can be Unbranded.) The Value for Brand or MPN cannot contain only special characters (e.g. %$*#@). All GTINs must comply with international formatting standards. For more details, see Listing with Custom Item Specifics.

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.) For GetItem: This list is returned only when you specify IncludeItemSpecifics in the request (and the seller included custom item specifics in their listing).

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

See Working with Custom 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:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • 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.

For more details, see Requiring Product Identifiers Mandate
Item.ItemSpecifics
  .NameValueList.Name
string Conditional Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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.

Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.
Item.ItemSpecifics
  .NameValueList.Value
string Conditional,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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: 65.
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.
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.
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. This applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature.

Best Offer must be enabled for the item, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response. On the US eBay Motors site (site ID 0), you cannot use the API to add a minimum Best Offer price. For a ReviseItem call on US eBay Motors, prior use of a minimum Best Offer price on eBay.com is ignored.

If the price for a fixed-price item (set in the StartPrice field) is changed with a Revise call, the BestOfferAutoAcceptPrice and MinimumBestOfferPrice values will be dropped (if they were set for the listing before the Revise call). If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, scheduled to roll out the first week in August 2017, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. Once this new capability rolls out, the seller can offer Buy It Now or Best Offer in an auction listing, but not both.
Item.ListingDetails
  .LocalListingDistance
string Conditional Specifies a distance (in miles) used as the radius of the area about the supplied postal code that constitutes the local market.

Use GetCategoryFeatures to determine the local listing distances supported by a given site, category, and Local Market subscription level.
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. This 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. For a ReviseItem or ReviseFixedPriceItem call on US eBay Motors site, prior use of a minimum Best Offer price on eBay.com is ignored.

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

If the price for a fixed-price item (set in the StartPrice field) is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice values will be dropped (if they were set for the listing before the Revise call). If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, scheduled to roll out the first week in August 2017, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. Once this new capability rolls out, the seller can offer Buy It Now or Best Offer in an auction listing, but not both.
Item.ListingDuration token Required Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time.

The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable).

The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information.

When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours.

See:
    GetCategoryFeatures
    Fees per Site



Applicable values: See ListingDurationCodeType
Item.ListingEnhancement ListingEnhancementsCodeType Optional,
repeatable: [0..*]
Describes listing upgrades that sellers can select for a fee, such as the BoldTitle upgrade. Also includes feature packs for saving on listing upgrades. See Listing Upgrades in the eBay site help.

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

Applicable values:

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.
CustomCode
(in/out) Reserved for internal or future use.
HomePageFeatured
(in/out) Listing will have a chance to rotate into a special display on eBay's Home page. Your item is very likely to show up on the Home page, although eBay does not guarantee that your item will be highlighted in this way. This is the highest level of visibility on eBay.

Not applicable for eBay Motors. In order to feature the listing on eBay Motors home page, use PictureDetails.GalleryType.Featured instead. See GalleryTypeCodeType for more information.
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.

Whenever ValuePackBundle is selected in a request, the Value Pack bundle is automatically upgraded to the Gallery Plus feature at no extra cost (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus). The Gallery Plus upgrade will display on all sites and categories that support ValuePackBundle.
Item.ListingType ListingTypeCodeType Conditional The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value).

If this field is not included in an AddItem, AddItems, AddSellingManagerTemplate, or VerifyAddItem call, the listing type defaults to auction

For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings.

This field is not applicable to Revise calls because the selling format of active listings cannot be changed.

Applicable values:

AdType
(in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings.
Chinese
(in/out) This value indicates a single-quantity auction listing. In an auction listing, prospective buyers engage in a competitive bidding process, although Buy It Now may be offered as long as no bids have been placed. Auctions occur on the eBay marketplace site, and the auction listings will also appear in the seller's eBay Store (if the seller has an eBay Store).

Note: Historically, the Best Offer feature has not been available for auction listings, but beginning with Version 1027, sellers in the US, UK, and DE sites will be able to offer the Best Offer feature in auction listings. The seller can offer Buy It Now or Best Offer in an auction listing, but not both features.
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 eBay Features Guide for more information.

Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days).
LeadGeneration
(in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).

(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 the value in the Country field). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours.

If you do not specify Location, you must specify Item.PostalCode. If you specify a postal code, but do not specify a location, then the location is given a default value derived from the postal code.

For the Classified Ad format for motors vehicle listings, the value provided in the Location field is used as item location only if the SellerContactDetails.Street and the SellerContactDetails.Street2 are empty. Else, the SellerContactDetails.Street and the SellerContactDetails.Street2 will be used for item location.

Max length: 45.
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 Add/Revise/Relist calls, at least one payment method must be specified.

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 methods for a site.

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

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 API Schema in the eBay Features Guide.

Note: Required or allowed payment methods vary by site and category. Refer to Determining the Payment Methods Allowed for a Category in the eBay Features Guide to help you determine which payment methods you are required or allowed to specify.
Payment methods are not applicable to any classified ad listings, as any agreement and payment is handled off of the eBay platform.

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.

See:
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences

Item.PickupInStoreDetails PickupInStoreDetailsType Optional This container is used in Add/Revise/Relist/Verify listing calls by the seller to enable a listing with the 'In-Store Pickup' or 'Click and Collect' features. The 'In-Store Pickup' feature is only available on the eBay US site, and the 'Click and Collect' feature is only available on the eBay UK, Australia, and Germany sites. Both of these features are discussed in more detail in this container's child fields.

This container is also returned in the GetItem call.
Item.PickupInStoreDetails
  .EligibleForPickupDropOff
boolean Conditional This field is used in Add/Revise/Relist/Verify calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to true. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

In addition to setting the EligibleForPickupDropOff boolean field to true, the merchant must also perform the following actions in an Add/Revise/Relist/Verify call to enable the "Click and Collect" option on a listing:
  • Have inventory for the product at one or more physical stores tied to the merchant's account.
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the Item.AutoPay flag in the call request and set its value to true;
    • Include only one Item.PaymentMethods field in the call request and set its value to PayPal;
    • Include a valid PayPal payment address in the Item.PayPalEmailAddress field.
When a merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.

Default: false.
Item.PickupInStoreDetails
  .EligibleForPickupInStore
boolean Conditional This field is used in Add/Revise/Relist/Verify calls to enable the listing for In-Store Pickup. To enable the listing for In-Store Pickup, the seller includes this boolean field and sets its value to true. A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multiple-quantity, fixed-price listings.

In addition to setting the EligibleForPickupInStore boolean field to true, the merchant must also perform the following actions in an Add/Revise/Relist/Verify call to enable the In-Store Pickup option on a multiple-quantity, fixed-price listing:
  • Have inventory for the product at one or more physical stores tied to the seller's account. By using the REST-based Inventory API, sellers can associate physical stores to their account by using the Create Inventory Location call, and then, using the Create Inventory Item call, they can add inventory to specific stores;
  • Include the seller-defined SKU value of the product(s) in the call request. For a single-variation listing, the SKU value would be specified in the Item.SKU field, and for a multiple-variation listing, the SKU value(s) would be specified in the Item.Variations.Variation.SKU field(s);
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the Item.AutoPay flag in the call request and set its value to true;
    • Include only one Item.PaymentMethods field in the call request and set its value to 'PayPal;
    • Include a valid PayPal payment address in the Item.PayPalEmailAddress field.
When a seller is successful at listing an item with the In-Store Pickup feature enabled, prospective buyers within a reasonable distance (25 miles or so) from one of the seller's stores (that has stock available) will see the "Available for In-Store Pickup" option on the listing, along with information on the closest store that has the item.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multiple-quantity, fixed-price listings.
Default: false.
Item.PictureDetails PictureDetailsType Optional This container consists of the data associated with photos within the listing. With most eBay sites and categories, a seller can add up to 12 photos to their listings free of charge. These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol.

It is required that all listings have at least one picture. eBay Motors listings can have up to 24 pictures.

See:
    Introduction to Pictures in Item Listings
    Adding photos to your listing

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

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

Applicable values: See ListingEnhancementDurationCodeType
Item.PictureDetails
  .GalleryType
GalleryTypeCodeType Optional Specifies the Gallery enhancement type for the listing. All listings automatically get the Gallery enhancement at no cost, so you never need to set this field to Gallery.

Gallery types are accumulative. This means if you use Plus, you also get the features of Gallery and if you use Featured, you get all the features of Gallery and Plus. Passing the values Plus and Featured together in the same request will return an error.

The Gallery image will be the first PictureURL in the array of PictureURL fields.

When revising a listing, if you remove Plus or Featured, the original feature fee will not be credited. If you upgrade to Featured, the original feature fee is credited, and the new feature fee is charged.

Applicable values:

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

Sites That Support Featured: You can check if a site supports Featured by using the GeteBayDetails call and passing in ListingFeatureDetails in the DetailName field. In the response, check the ListingFeatureDetails container for FeaturedFirst.
Gallery
(in/out) This feature, which is free on all sites, adds a Gallery image in the search results. A Gallery image is an image that was uploaded and copied to EPS (eBay Picture Service). This copy is stored for 30 days or until the image is associated with a listing. Once the image is associated with a listing, the period is extended to 90 days after the item's sale_end date and is extended again if the item is relisted or used in subsequent listings. As part of storing a copy, EPS also makes additional sizes available (thumbnail, main image, supersize, popup, etc.), which are used by the various Gallery enhancements.

All images must comply to the Picture Requirements.
None
(in/out) Gallery is supported free on all sites. So this field is useful only for removing an existing feature setting when using RelistItem.
Plus
(in/out) Adds a Gallery Plus icon to the listing.

When Plus is selected in a request that specifies at least two images (using ItemType.PictureDetailsType.PictureURL), the Gallery Plus feature automatically includes a Gallery Showcase of all the listing's images.

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

If Plus is selected and the request includes only one EPS image or any self-hosted images, the listing includes a Gallery Plus icon that, when hovered over or clicked, displays a large (400px x 400px) preview image of the item. Clicking the image displays the View Item page for that listing.

When using RelistItem or ReviseItem (item has no bids and more than 12 hours before the listing's end), Plus can be unselected in the request. However, the Plus fee will still apply if a previous request selected Plus. There is at most one Plus fee per listing.

When "Plus" is included in an item listing, the listing also automatically gets the Gallery functionality at no extra cost. "Gallery" does not need to be specified separately in the listing.

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

See Introduction to Pictures in Item Listings.

Item.PictureDetails
  .PhotoDisplay
PhotoDisplayCodeType Optional 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 use only.
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.

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

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

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
EPS
(in/out) This value indicates that the image(s) specified in the PictureURL field(s) are hosted by eBay Picture Services.
Vendor
(in/out) This value indicates that the image(s) specified in the PictureURL field(s) are hosted by a third-party vendor.
Item.PictureDetails.PictureURL anyURI Conditional,
repeatable: [0..*]
Contains the URL for a picture of the item. The URL can be from the eBay Picture Services (images previously uploaded) or from a server outside of eBay (self-hosted). You can pass in up to 12 URLs but you cannot mix self-hosted and EPS-hosted URL in one listing.

On the US and Canada eBay Motors sites (for all vehicle listings) a listing can contain up to 24 pictures. The Gallery image will be the first PictureURL in the array of PictureURL fields.

Note: All images, whether they are hosted by EPS or self-hosted, must comply with the Picture Requirements. To specify multiple pictures, send each URL in a separate, PictureDetails.PictureURL element. The first URL passed in will be the Gallery image and appears on the View Item page.

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.

Note: Embedding pictures in the description (by using IMG tags) is discouraged. Studies show that shopper often do not look at the description. The recommended process is to specify the image URLs using PictureURL. If a listing uses a single self-hosted picture (except in the case of a multi-variation listing), the picture will be copied to eBay Picture Services (ESP) and the PictureDetails.PictureURL value returned by GetItem will be an EPS URL.

For VerifyAddItem only: You must include a picture even when using VerifyAddItem. If you don't have a image file, you can use the following fake eBay Picture Services URL (http://i2.ebayimg.com/abc/M28/dummy.jpg) with this call.

For ReviseItem and RelistItem only: To remove a picture when revising or relisting an item, specify PictureDetails with all the pictures that you want the listing to include. That is, you need to completely replace the original set of URLs with the revised set. You cannot remove all the PictureURL fields from a listing because each listing requires at least one picture.

Remember: The Gallery image will be the first PictureURL in the array of PictureURL fields. So if the first image passed in when relisting/revising is different from when the listing was created, the Gallery image will be changed.

Note: For some large merchants, there are no limitations on when pictures can be added or removed from a fixed-price listing, even when the listing has had transactions or is set to end within 12 hours.
Max length: 500.

See:
    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. If you do not specify PostalCode, you must specify Item.Location. If you specify PostalCode, but do not specify Item.Location, then Item.Location is given a default value derived from the postal code.
Item.PrimaryCategory CategoryType Required 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, GetCategoryFeatures, and GetCategorySpecifics to determine valid metadata values for the site on which you are listing (see Maintaining Category Data 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.

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

For ReviseItem only: When revising a listing, you can change the primary category only if an auction listing has no bids or a multiple-quantity, fixed-price listing has no sales, and the listing does not end within 12 hours.

If you change the listing category, any Item Specifics that were previously specified may be dropped from the listing if they aren't valid for the new category. For the eBay US site, we suggest that you avoid including a category ID when you list with an Global Trade Item Number (GTIN) through the ProductListingDetails container.

When you list an event ticket on the US site, you must specify one of the leaf categories under the Tickets & Experiences meta category.

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

Item.PrimaryCategory
  .CategoryID
string Required This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories.

In an Add/Revise/Relist call, the PrimaryCategory.CategoryID is always required, and the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used.

Max length: 10.
Item.PrivateListing boolean Optional A true value in this field indicates the listing is private. In a private listing, a buyer's User ID will not appear in an auction listing's bid history. Sellers may want to use this option when they believe that potential bidders for an auction item would not want their User IDs exposed to others. This setting is only applicable to auction listings.
Item.PrivateNotes string Optional A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned to the user who created the note.

Not supported as input in ReviseItem. Use SetUserNotes instead.

For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site).

In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site).
Item.ProductListingDetails ProductListingDetailsType Conditional This container is used to provide one or more product identifiers for a product, and if the product is matched to a product in the eBay catalog, some of the product details will be prefilled for the listing, including the item title, product description, item specifics, and a link to the stock image of the product, if it exists.

Note: Currently, the BrandMPN container, and/or the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. If a product identifier type is required, the corresponding field must be used, even if the seller is not interested in finding an eBay catalog product match. Currently, a large number of eBay US categories require one or more product identifier types for new and refurbished items. A few eBay categories require a product identifier for used items as well. See the Structured Data - Product Identifiers help page for more information on which eBay US categories require which product identifier types. Currently, the NameValueList container is not enabled for use, but eBay will make an announcement when that container is enabled to start specifying any and all GTINs. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API once the ProductListingDetails.NameValueList container is enabled in listing calls, and the Recommendations.ProductIdentifiers container is returned in GetCategorySpecifics. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported after the ProductListingDetails.NameValueList container is enabled.
When you use ProductListingDetails, in an Add call, you must specify at least one GTIN, a ProductReferenceID (also known as an EPID), or TicketListingDetails. If you specify more than one of these values, eBay uses the first one that matches a product in eBay's catalog.

For ReviseItem and RelistItem only: When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product identifier and you cannot remove existing product listing details data. However, you can change or add preferences such as IncludeStockPhotoURL, UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all catalog data when you revise or relist an item, specify Item.ProductListingDetails in DeletedField and don't pass ProductListingDetails in the request.
Item.ProductListingDetails
  .BrandMPN
BrandMPNType Conditional The combination of Brand and MPN (manufacturer part number) can be used as a unique identifier for a product. If this container is used, both Brand and MPN must be specified.

It is a best practice to also specify the Brand/MPN values in two separate ItemSpecifics.NameValueList containers. The values in the BrandMPN container are used to look for an eBay catalog product match, but if a match is not found, these Brand and MPN values are dropped from the listing. By also specifying these Brand and MPN values in Item Specifics, these values are retained in the listing. If the Brand and MPN values in the BrandMPN container and ItemSpecifics.NameValueList containers differ, the values in the ItemSpecifics.NameValueList containers will overwrite the values of the BrandMPN container.

Note: The BrandMPN container (and eBay catalog product lookup) is not supported for multiple-variation listings. For multiple-variation listings that use MPNs, the Brand value should be specified through an ItemSpecifics.NameValueList container, and the Manufacturer Part Numbers (MPNs) for each product variation should be specified through a VariationSpecifics.NameValueList container.
Note: Currently, the BrandMPN container, and/or the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 ( dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018.
Item.ProductListingDetails
  .BrandMPN.Brand
string Conditional The brand of the product. eBay searches against the names that are publicly available in eBay's product catalogs. This means you can specify the well-known brand name that an average user would recognize. Both Brand and MPN must be specified if the BrandMPN container is used.

Note: The BrandMPN container (and eBay catalog product lookup) is not supported for multiple-variation listings. For multiple-variation listings that use MPNs, the Brand value should be specified through an ItemSpecifics.NameValueList container, and the Manufacturer Part Numbers (MPNs) for each product variation should be specified through a VariationSpecifics.NameValueList container.
Max length: 65.
Item.ProductListingDetails
  .BrandMPN.MPN
string 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.) eBay searches against the part numbers for products that are publicly available in eBay's product catalogs. Both Brand and MPN must be specified if the BrandMPN container is used.

Note: If the listing is being posted to a category that expects a MPN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request.
Note: The BrandMPN container (and eBay catalog product lookup) is not supported for multiple-variation listings. For multiple-variation listings that use MPNs, the Brand value should be specified through an ItemSpecifics.NameValueList container, and the Manufacturer Part Numbers (MPNs) for each product variation should be specified through a VariationSpecifics.NameValueList container.
Max length: 65.
Item.ProductListingDetails.EAN string Conditional This field is used if the seller wishes to identify each product variation within a multi-variation listing by an EAN (European Article Number) value. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products. Unlike single-variation listings where the EAN is specified in the ProductListingDetails container, eBay will attempt to match this EAN value to a product in the eBay catalog, but the product's item title, item description, item specifics, and stock photos are not automatically picked up for multiple-variation listings. If a secondary category is used, and the primary and secondary categories are both catalog-enabled, this EAN value should correspond to the primary category (not the secondary category).

Note: If the listing is being posted to a category that expects an EAN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, 'ProductDetails' should be included as a DetailName value in the call request.
Note: Currently, the BrandMPN container, and/or the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 ( dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018.
Max length: 13.
Item.ProductListingDetails
  .IncludeeBayProductDetails
boolean Optional This boolean field controls whether or not an eBay catalog product is used to help create or revise an item listing. If a product identifier value is provided through the ProductListingDetails container when adding, revising, or relisting an item, the default behavior is for eBay to try and find a match for the product in the eBay product catalog, and then automatically create the listing title, item specifics, item description, pictures (for "New" condition items), and assign a category.

If the seller wants to use the eBay product catalog to help create or revise the listing, the seller can include this field and set its value to true, or just omit this field, as it default value is true. If a seller doesn't want the eBay product catalog information in their listing, that seller would have to include this field and set its value to false. If the seller does this, they will also be required to pass in their own listing title and description, item specifics, and pictures, and select a listing category.

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. 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, using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. 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 no PictureURL elements are defined in request. In this case, eBay will not use a stock photo, even if it is available.

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 This field is used if the seller wishes to identify each product variation within a multi-variation listing by an ISBN (International Standard Book Number) value. An ISBN is a unique identifer for books. Both 10 and 13-character ISBNs are supported. When specifying a 13-character ISBN, the value must begin with either '978' or '979'. Unlike single-variation listings where the ISBN is specified in the ProductListingDetails container, eBay will attempt to match this ISBN value to a product in the eBay catalog, but the product's item title, item description, item specifics, and stock photos are not automatically picked up for multiple-variation listings. If a secondary category is used, and the primary and secondary categories are both catalog-enabled, this ISBN value should correspond to the primary category (not the secondary category).

Note: If the listing is being posted to a category that expects an ISBN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, ProductDetails should be included as a DetailName value in the call request.
Note: Currently, the BrandMPN container, and/or the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 ( dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018.
Max length: 13.
Item.ProductListingDetails
  .NameValueList
NameValueListType Conditional,
repeatable: [0..*]
Note: The NameValueList container was added in Version 997, but it is not yet available for use in Sandbox or Production environments. Currently, the BrandMPN container, and/or the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 ( dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018. This container is used to pass in a name-value pair that will identify the type of product identifier being used and its value. This product identifier, such as EAN, ISBN, or UPC, is then used by eBay to try and match the identifier to a product in the eBay catalog. If a Brand/MPN pair is going to be used to identify a product, the brand is specified in one NameValueList container, and its Manufacturer Part Number (MPN) is specified in another NameValueList container. Also, if a product has more than one product identifier, each can be specified through separate NameValueList containers.

The GetCategorySpecifics call can be used to see the product identifier type(s) that are required/supported for a particular eBay category. Each required/supported product identifier type will be shown in a separate ProductIdentifiers.NameRecommendation container in the GetCategorySpecifics call response. The product identifier type name will be shown in the NameRecommendation.Name field. By looking at the value in the corresponding ProductIdentifiers.ValidationRules.MinRequired field, the seller will know if one or more product identifiers are required at listing time. If two product identifier types are returned, and the MinRequired value is '2', the seller will be required to use both product identifier types at listing time. If the MinRequired value is '1', only one of the two product identifier types would be required, but the seller could use them both if they wanted. If the MinRequired value is 0, one or both of those product identifier types could be used, but they would not be required.

It is a best practice to also specify the Brand/MPN values in two separate ItemSpecifics.NameValueList containers. The values in the BrandMPN container are used to look for an eBay catalog product match, but if a match is not found, these Brand and MPN values are dropped from the listing. By also specifying these Brand and MPN values in Item Specifics, these values are retained in the listing. If the Brand and MPN values in the BrandMPN container and ItemSpecifics.NameValueList containers differ, the values in the ItemSpecifics.NameValueList containers will overwrite the values of the BrandMPN container.
Item.ProductListingDetails
  .NameValueList.Name
string Conditional Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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.

Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.
Item.ProductListingDetails
  .NameValueList.Value
string Conditional,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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: 65.
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 Applicable for listing use cases only (not buy-side searching). Indicates what eBay should do if more than one product matches the external product ID (ISBN, UPC, EAN, Brand-MPN combination) or event specified through 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 Product ID values. This lets you choose one of the Product IDs 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 Product ID values. (This flag has no effect when only one match is found.)

Default: false.
Item.ProductListingDetails
  .TicketListingDetails
TicketListingDetailsType Conditional Applicable for listing use cases only (not buy-side searching). Only applicable when you are listing event tickets. Please note that the US eBay site and other sites may also require you to specify additional Item Specifics by using AttributeSetArray. This may depend on the location of the event. See the eBay Features Guide for more information about how to specify and troubleshoot these values.
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.

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.

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 This field is used if the seller wishes to identify each product variation within a multi-variation listing by a UPC (Universal Product Code) value. A UPC is a commonly used identifer for many different products. Unlike single-variation listings where the UPC is specified in the ProductListingDetails container, eBay will attempt to match this UPC value to a product in the eBay catalog, but the product's item title, item description, item specifics, and stock photos are not automatically picked up for multiple-variation listings. If a secondary category is used, and the primary and secondary categories are both catalog-enabled, this UPC value should correspond to the primary category (not the secondary category).

Note: If the listing is being posted to a category that expects a UPC value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, 'ProductDetails' should be included as a DetailName value in the call request.
Note: Currently, the BrandMPN container, and/or the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 ( dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018.
Max length: 12.
Item.ProductListingDetails
  .UseFirstProduct
boolean Optional Applicable for listing use cases only (not buy-side searching). 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).

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, using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. 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 no PictureURL elements are defined in request. In this case, eBay will not use a stock photo, even if it is available.


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 Conditional For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations.

For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1.

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

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

For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1.

For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value.

For order line item calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold).

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.

See:
    Listing Policies
    Selecting a Selling Format

Item.QuantityInfo QuantityInfoType Optional This container is used to set the minimum number of event tickets that should remain available after a buyer makes a purchase. This functionality allows the seller to avoid the possibility of being left with just one event ticket after a sale.

This container can be used when adding, revising, or relisting event tickets, and it will only be returned in GetItem if set for the listing.
Item.QuantityInfo
  .MinimumRemnantSet
int Conditional Enables a seller to avoid being left with quanity of 1 in an event listing. A typical use case is event tickets in reserved, adjacent seats, or items that typically only sell if more than one can be purchased at once.

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

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

Applicable to multiple-quantity, fixed-price listings. Currently supported for US and CA event ticket listings.

Default: 1.
Item
  .QuantityRestrictionPerBuyer
QuantityRestrictionPerBuyerInfoType Optional This container is used by the seller to restrict the quantity of items that may be purchased by one buyer during the duration of a fixed-price listing (single or multi-variation). This is an optional container that can be used with an Add, Revise, or Relist call.

This container is not applicable to auction listings.
Item
  .QuantityRestrictionPerBuyer
  .MaximumQuantity
int Conditional This integer value indicates the maximum quantity of items that a single buyer may purchase during the duration of a fixed-price listing (single or multi-variation). The buyer is blocked from the purchase if that buyer is attempting to purchase a quantity of items that will exceed this value. Previous purchases made by the buyer are taken into account. For example, if MaximumQuantity is set to '5' for an item listing, and Buyer1 purchases a quantity of three, Buyer1 is only allowed to purchase an additional quantity of two in subsequent orders on the same item listing.

This field is required if the QuantityRestrictionPerBuyer container is used.

Min: 1.
Item.ReturnPolicy ReturnPolicyType Conditional Describes the seller's return policy. Most categories on most eBay sites require the seller to clearly specify whether or not returns are accepted (see ReturnsAcceptedOption).

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

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

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

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

See:
    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
  .ExtendedHolidayReturns
boolean Optional When you list an item by using the Add/Revise/Relist families of calls, use this field to enable an Extended Holiday Returns policy for the item. A value of true indicates the seller is offering the item with an extended holiday returns period.

IMPORTANT: Extended Holiday Returns is a seasonally available feature, but it might not be made available every year. To ensure that the feature is enabled in any given year, check the Returns on eBay page of the eBay Seller Center before the holiday season starts. If the feature is not enabled for the season, this field is ignored. The extended holiday returns period is defined by three dates:
  • The start date - start of November.
  • The purchase cutoff date - end of the year.
  • The end date - end of January.
Note: These dates may vary by a few days each year. Sellers will be notified of the current dates on their eBay site before the holiday period starts. Sellers can specify Extended Holiday Returns (as well as their regular non-holiday returns period) for chosen listings at any time during the year. The Extended Holiday Returns offer is not visible in the listings until the current year's holiday returns period start date, at which point it overrides the non-holiday returns policy. Buyers will see and be subject to the Extended Holiday Returns offer in listings purchased through the purchase cutoff date, and will be able to return those purchases through the end date.

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

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

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

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

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

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

Note: Top-Rated Sellers offering Extended Holiday Returns on a listing will get an additional 5 percent discount on the Final Value Fees on top of the 20 percent discount they get for creating Top-Rated Plus qualifying listings. See the Becoming a Top Rated Seller and qualifying for Top Rated Plus help topic for more information on Top-Rated Seller, Top-Rated Plus requirements, and the 5 percent bonus discount for Extended Holiday Returns.
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: The RefundOption values supported on the US site are MoneyBack and MoneyBackOrReplacement. If a seller has the depth of inventory to support an exchange for an identical item, MoneyBackOrReplacement can be used. A seller with limited inventory of an item should use the MoneyBack option.

See (GeteBayDetails) RefundOption.



Applicable values: See RefundOptionsCodeType
Item.ReturnPolicy
  .RestockingFeeValueOption
token Optional This enumeration value indicates the restocking fee percentage values that a seller can charge to a buyer who is returning an item due to buyer remorse and/or a purchasing mistake. A restocking fee is not applicable for an item that is being returned because it was not as described. Restocking fees are only applicable to the US and Canadian sellers who have opted into eBay Managed Returns.

In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value at listing time (either through the ReturnPolicy) or through a Return Business Policy that is applied to the listing.

To obtain the list of currently supported values, call GeteBayDetails with DetailName set to ReturnPolicyDetails. Then, look for the list of restocking fee percentage values in the ReturnPolicyDetails.RestockingFeeValue containers 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 Conditional Indicates whether the seller allows the buyer to return the item. This field is required when ReturnPolicy is specified. If you specify ReturnsNotAccepted, the View Item page will 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 zero days (same-day shipping) or one day. The handling time is set through an integer value in 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 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.

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



Applicable values: See WarrantyOfferedCodeType
Item.ReturnPolicy
  .WarrantyTypeOption
token Optional Indicates the source or type of the warranty, if any. Note: Only the eBay India site supports this field.

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.

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 a time in the future 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 (listing has yet to go live).

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.
Item.SecondaryCategory CategoryType Optional The unique identifer for a secondary category. This field is only applicable if the seller decides to list the item under two categories.

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

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

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.

See Categories.

Item.SecondaryCategory
  .CategoryID
string Conditional This string value is the unique identifier of an eBay category. In GetItem and related calls, see the CategoryName field for the text name of the category. The parent category of this eBay category is only shown in GetCategories.

In an Add/Revise/Relist call, the PrimaryCategory.CategoryID is always required, and the SecondaryCategory.CategoryID is conditionally required if a Secondary Category is used.

Max length: 10.
Item.SellerProfiles SellerProfilesType Conditional This container is used if the seller would like to use/reference Business Policies to create, revise, relist, or verify their listing. The seller's account must be opted in to Business Policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy is applied to the listing. If the seller's account is not opted in to Business Policies, that seller may not use this container. Sellers must opt-in to Business Policies through My eBay or by using the optInToProgram call of the eBay Account API.

If Business Policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
Item.SellerProfiles
  .SellerPaymentProfile
SellerPaymentProfileType Conditional The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileID
long Conditional The unique identifier of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the PaymentProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment profile.
Item.SellerProfiles
  .SellerPaymentProfile
  .PaymentProfileName
string Conditional The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

In the 'Get' calls, the PaymentProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment profile.
Item.SellerProfiles
  .SellerReturnProfile
SellerReturnProfileType Conditional The SellerReturnProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option, how many days the buyer has to return the item for a refund, warranty information, and restocking fee (if any).

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileID
long Conditional The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

Return Policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the ReturnProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy profile.
Item.SellerProfiles
  .SellerReturnProfile
  .ReturnProfileName
string Conditional The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

In the 'Get' calls, the ReturnProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy profile.
Item.SellerProfiles
  .SellerShippingProfile
SellerShippingProfileType Conditional The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information.

This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing.
Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID
long Conditional The unique identifier of a Business Policies shipping profile. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the Shippping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence.

Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business Policy IDs can also be retrieved through the Business Policies section of My eBay.

In the 'Get' calls, the ShipppingProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping profile.
Item.SellerProfiles
  .SellerShippingProfile
  .ShippingProfileName
string Conditional The name of a Business Policies shipping profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shipping values of a Business Policies shipping profile. If both fields are provided and their values don't match, the ShippingProfileID takes precedence.

In the 'Get' calls, the ShippingProfileID value will always be returned if Business Policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the payment profile.
Item.SellerProvidedTitle string Conditional 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).

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, fixed-price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes—the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout.

Shipping details are not applicable to any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not 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.

Note: The CalculatedShippingRate container should only be used to specify values for the InternationalPackagingHandlingCosts, OriginatingPostalCode, and/or PackagingHandlingCosts fields. The rest of the fields in the CalculatedShippingRate container are used to specify package dimensions and package weight, and these values should now be specified in the ShippingPackageDetails container instead.
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
  .MeasurementUnit
MeasurementSystemCodeType Conditional Note: The value for MeasurementUnit should now be specified in the ShippingPackageDetails container instead. If the MeasurementUnit field is passed in the CalculatedShippingRate container and in the ShippingPackageDetails container, the value in the ShippingPackageDetails container will take precedence.
Specifies the unit type of the weight and dimensions of a shipping package. If MeasurementUnit is used, its value will override the system specified through a measurementSystem attribute in dimension and/or weight-related fields. If neither a MeasurementUnit value nor a measurementSystem attribute are specified, the following defaults will be used:

English: US
Metric: CA, CA-FR, AU

CA and CA-FR support 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
  .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
  .ShippingIrregular
boolean Optional Note: The value for ShippingIrregular should now be specified in the ShippingPackageDetails container instead. If the ShippingIrregular field is passed in the CalculatedShippingRate container and in the ShippingPackageDetails container, the value in the ShippingPackageDetails container will take precedence. This field may be deprecated in the future.
This boolean field indicates that the shipping package is considered an irregular shape and/or size by the shipping carrier, and thus requires special handling. For calculated shipping only.
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 GetCategoryFeatures, specifying the listing category ID, and including the FeatureID field set to PaymentMethods. Look for a value of 'CashOnPickup' in one of the Category.PaymentMethod fields in the response.

See Other Shipping Features.

Item.ShippingDetails
  .ExcludeShipToLocation
string Conditional,
repeatable: [0..*]
Use this field to specify an international country or region, or a special domestic location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you will not ship the associated item. Repeat this element in the call request for each location that you want to exclude as a shipping destination for your item.

Set ShipToRegistrationCountry to true to have your ExcludeShipToLocation settings applied to your listing. The locations you have excluded display in the Shipping and Handling section of your item listing.

If a buyer's primary ship-to location is a location that you have listed as an excluded ship-to location (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on your item.

The exclude ship-to location values are eBay regions and countries. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails, and then look for the ExcludeShippingLocationDetails.Location fields in the response. Repeat GeteBayDetails for each site on which you list.

This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where you will, and will not, ship. You can list a region in the ShipToLocations field, then exclude specific countries within that region with this field (for example, you can specify Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation setting). In addition, if your ShipToLocations is Worldwide, you can use this field to specify both regions and countries that you want to exclude from your shipping destinations.

You can specify a default set of locations to where you will not ship in My eBay. If you create an Exclude Ship-To List, it is, by default, in effect when you list items. However, if you specify any value in this field on input, it nullifies the default settings in your Exclude Ship-To List. (If you use ExcludeShipToLocation when you list an item, you will need to list all the locations to where you will not ship the associated item, regardless of the default settings in your Exclude Ship-To List.)

Specify none in this field to override the default Exclude Ship-To List you might have set up in My eBay and indicate that you do not want to exclude any shipping locations from the respective item listing.

Note: To enable your default Exclude Ship-To List, you must enable Exclude Shipping Locations and Buyer Requirements in your My eBay Site Preferences. For details, see the KnowledgeBase Article HowTo: ExcludeShipToLocation.

Applicable values: See CountryCodeType, ShippingRegionCodeType
Item.ShippingDetails
  .GlobalShipping
boolean Conditional Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, international shipping through the Global Shipping Program is available for the listing, and eBay automatically sets one of the available shipping service options to International Priority Shipping. If the value of GlobalShipping is false, the seller is responsible for specifying one or more international shipping service options if the seller is willing to ship internationally.

When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change.

Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program.

See Introduction to Shipping for information about Global Shipping Program eligibility.

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.

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 if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
Item.ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
AmountType (double) Conditional The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

See Shipping.

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. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified.

This field is applicable to Flat and Calculated shipping.
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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, ShipToLocation fields will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, ShipToLocation fields are only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

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

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 Optional This container is used to reference and apply a seller's specific domestic and/or international shipping rate tables to a listing. Shipping rate tables allow sellers to configure specific shipping costs based on the shipping destinations and level of service (e.g. economy, standard, expedited, and one-day). Generally speaking, sellers want to use these shipping rate tables so they can charge a higher shipping cost to the buyer whenever shipping costs are higher for them as well. For example, shipping to Alaska or Hawaii is generally more expensive than shipping to any other of the 48 US states, or in regards to international shipping, shipping to some regions and countries are more expensive than others.

Sellers configure domestic and international shipping rate tables in My eBay Shipping Preferences. To apply shipping rate tables, the shipping cost type must be flat-rate.

For domestic shipping rate tables, the three supported domestic regions are Alaska & Hawaii, US Protectorates (e.g. Puerto Rico and Guam), and APO/FPO destinations, which are US military bases/locations outside of the continental US. In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package, or they can add a surcharge instead. To determine if a domestic shipping rate table is set up for the seller's account, the GetUser call can be used, and then the seller will look for a value of true in the User.SellerInfo.DomesticRateTable field. Although the GetUser call can be used to see if a domestic shipping rate table exists for the seller's account, details of the shipping rate table, including all specified costs for the different regions, can only be viewed and modified in My eBay Shipping Preferences. This functionality is not yet available in any public APIs.

For international shipping rate tables, specific rates may be set up for any and all of the nine geographical regions and individual countries within those regions. Similar to domestic shipping rate tables, the seller has the option of adding an extra charge based on the weight of the shipping package. Sellers cannot add a surcharge for international shipping. To determine if a international shipping rate table is set up for the seller's account, the GetUser call can be used, and then the seller will look for a value of true in the User.SellerInfo.InternationalRateTable field. Although the GetUser call can be used to see if an international shipping rate table exists for the seller's account, details of the shipping rate table, including all specified costs for the different regions/countries, can only be viewed and modified in My eBay Shipping Preferences. This functionality is not yet available in any public APIs.

If you are applying a domestic or international shipping rate table that specifies a surcharge by weight, you must specify the item weight in the ShippingPackageDetails container's WeightMajor and WeightMinor fields, even though the listing is using flat-rate shipping. Do not use any other fields in the ShippingPackageDetails container because none of those fields are applicable in this use case.

This container is only returned in the 'Get' calls if one or more shipping rate tables have been applied to the listing, and if the call is being made by the seller who listed the item.

Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US and Australia sites. This capability will also roll out to the UK and Germany sites later in 2017. Currently, for sites other than the US and Australia, only one domestic and one international shipping rate table may be set up per seller. Whether a seller is using the old default domestic and international shipping rate tables or the new shipping rate tables, these shipping rate tables are set up in My eBay Shipping Preferences or as part of a Shipping Business Policy. If using the Trading API to create a listing that will use the new shipping rate tables, the DomesticRateTableId and InternationalRateTableId fields are used to reference and apply these new shipping rate tables to the listing. If desired, sellers can still use the old default shipping rate tables, but they are not allowed to mix and match old and new shipping rate tables, meaning that they will get an error if they pass in both the old fields (DomesticRateTable and InternationalRateTable) and the new fields ( DomesticRateTableId and InternationalRateTableId). The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).

See Using Shipping Rate Tables for more information on using shipping rate tables..

Item.ShippingDetails
  .RateTableDetails
  .DomesticRateTable
string Conditional This field is used in an Add/Revise/Relist/Verify call to apply the domestic shipping rate table to the listing. Domestic rate tables can be used only for items listed on the eBay US, UK, DE, and AU sites.

In all cases, sellers pass in a string value of Default to apply the domestic shipping rate table. The shipping rates and/or surcharges set up in the domestic shipping rate table will only be applicable based on the location of the buyer, and if that shipping service level is covered in one of the specified shipping service options in the listing. Basically, domestic shipping costs and surcharges are set in one or more ShippingServiceOptions containers in the listing, and based on the settings and costs in the domestic shipping rate table, these shipping costs and/or surcharges may be overridden based on the buyer's location. For example, if the buyer lives in Alaska, and the domestic shipping rate table has one or more shipping rates set up for the Alaska & Hawaii domestic region, the buyer will see these rates in the View Item page and not the rates/costs that are defined in the ShippingServiceOptions containers.

If a seller is revising or relisting an item, the domestic shipping rate table can be unassociated from the listing by using the empty tag: <DomesticRateTable />

This field is returned in the 'Get' calls if a domestic rate table is being applied to the listing, and it is only returned for the seller who listed the item.



Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US and Australia sites. This capability will also be rolling out to the UK and Germany sites in the near future. Currently, for sites other than the US and Australia, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).
Max length: 50.

See Using Shipping Rate Tables for more information on using shipping rate tables..

Item.ShippingDetails
  .RateTableDetails
  .DomesticRateTableId
string Conditional Note: This field was added in Version 1019 and it is ready for use on the US and Australia sites. The feature will be wired on for the UK and Germany sites in the near future. The unique shipping rate identifiers that will be passed into this field can only be retrieved using the getRateTables call of the Account API.
This field is included in an Add/Revise/Relist/Verify call if the seller wants to apply a customized domestic shipping rate table to the listing. The string value that is supplied in this field is the unique identifier of the shipping rate table. The seller must use the getRateTables call of the Account API to retrieve these eBay-generated shipping rate table identifiers, as these identifiers are not shown in the Shipping Rate Tables UI. If the DomesticRateTableId field is used, the seller must make sure that the DomesticRateTable and InternationalRateTable fields are not used, as the old and new rate tables cannot be used together or an error will occur.

In domestic shipping rate tables, sellers customize the flat-rate cost of shipping based on shipping destination (region/state/province) and shipping service level (one-day, expedited, standard, economy in US). In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package, or they can add a surcharge instead.

If the seller is using the Revise or Relist call, they must include the DomesticRateTableId field or the domestic shipping rate table currently being applied to the listing will be unassociated from the listing. If they want to continue using the same domestic shipping rate table, the seller will pass in this identifier. The seller can also change the domestic shipping rate table by passing in the identifier for a different domestic shipping rate table.

This field is returned in the 'Get' calls if a customized domestic rate table is being applied to the listing, and it is only returned for the seller who listed the item.

Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US and Australia sites. This capability will also be rolling out to the UK and Germany sites in the near future. Currently, for sites other than the US and Australia, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).
Max length: 50.
Item.ShippingDetails
  .RateTableDetails
  .InternationalRateTable
string Conditional This field is used in an Add/Revise/Relist/Verify call to apply the international shipping rate table to the listing. Domestic rate tables can be used only for items listed on the eBay US, UK, and DE sites.

In all cases, sellers pass in a string value of Default to apply the international shipping rate table. The shipping rates set up in the international shipping rate table will only be applicable based on the location of the buyer, and if that shipping service level is covered in one of the specified international shipping service options in the listing. Basically, international shipping costs are set in one or more InternationalShippingServiceOption containers in the listing, and based on the settings and costs in the international shipping rate table, these shipping costs may be overridden based on the buyer's location. For example, if the buyer lives in Argentina, and the international shipping rate table has one or more shipping rates set up for the country of Argentina, the buyer will see these rates in the View Item page and not the rates/costs that are defined in the InternationalShippingServiceOption containers.

If a seller is revising or relisting an item, the international shipping rate table can be unassociated from the listing by using the empty tag: <InternationalRateTable />

This field is returned in the 'Get' calls if an international rate table is being applied to the listing, and it is only returned for the seller who listed the item.



Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US and Australia sites. This capability will also be rolling out to the UK and Germany sites in the near future. Currently, for sites other than the US and Australia, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).
Max length: 50.

See Using Shipping Rate Tables for more information on using shipping rate tables..

Item.ShippingDetails
  .RateTableDetails
  .InternationalRateTableId
string Conditional Note: This field was added in Version 1019 and it is ready for use on the US and Australia sites. The feature will be wired on for the UK and Germany sites in the near future. The unique shipping rate identifiers that will be passed into this field can only be retrieved using the getRateTables call of the Account API.
This field is included in an Add/Revise/Relist/Verify call if the seller wants to apply a customized international shipping rate table to the listing. The string value that is supplied in this field is the unique identifier of the shipping rate table. The seller must use the "Get Rate Tables" call of the Account API to retrieve these eBay-generated shipping rate table identifiers, as these identifiers are not shown in the Shipping Rate Tables UI. If the InternationalRateTableId field is used, the seller must make sure that the DomesticRateTable and InternationalRateTable fields are not used, as the old and new rate tables cannot be used together or an error will occur.

In international shipping rate tables, sellers customize the flat-rate cost of shipping based on shipping destination (continent/region/country) and shipping service level (expedited, standard, economy in US). In addition to setting one flat rate based on the destination and service level, the seller also has the option of adding an extra charge based on the weight of the shipping package. Unlike domestic shipping, sellers cannot add a surcharge for international shipping.

If the seller is using the Revise or Relist call, they must include the InternationalRateTableId field or the international shipping rate table currently being applied to the listing will be unassociated from the listing. If they want to continue using the same international shipping rate table, the seller will pass in this identifier. The seller can also change the international shipping rate table by passing in the identifier for a different international shipping rate table.

This field is returned in the 'Get' calls if a customized international rate table is being applied to the listing, and it is only returned for the seller who listed the item.

Note: The capability to create and use multiple domestic and international shipping rate tables (up to 40 per seller account) has rolled out to the US and Australia sites. This capability will also be rolling out to the UK and Germany sites in the near future. Currently, for sites other than the US and Australia, only one domestic and one international shipping rate table may be set up per seller. Until the seller's account is updated with the new shipping rate tables in My eBay, the seller will continue to use the DomesticRateTable and InternationalRateTable tags and pass in Default as the value. Once the seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId tags, and the DomesticRateTable and InternationalRateTable tags will not work. Note that shipping rate tables can also be applied to Shipping business policies that are applied against a listing. The new shipping rate tables have all of the functionality of the old shipping rate tables, plus the seller has access to all domestic regions and not just the special regions (such as Alaska & Hawaii, US Protectorates, and APO/FPO locations in US).
Max length: 50.
Item.ShippingDetails.SalesTax SalesTaxType Optional Sales tax details. US and US Motors (site 0) sites only, excluding vehicle listings. Flat and calculated shipping.

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 (##.###).
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.
Item.ShippingDetails.SalesTax
  .ShippingIncludedInTax
boolean Optional (US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping.
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. 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). 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.

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 Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.

If the seller specifies FreeShipping but requires shipping insurance (InsuranceOption = Require), eBay sets the insurance cost to 0.00. However, if shipping insurance is optional and the buyer chooses shipping insurance, 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, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

For flat and calculated shipping.

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 if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

See Determining Shipping Costs for a Listing.

Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
AmountType (double) Conditional The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable.
  • If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services.
  • If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

See Determining Shipping Costs for a Listing.

Item.ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority
int Conditional 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.
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
  .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.

GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.

Applicable values: See ShippingType.
Item.ShippingPackageDetails ShipPackageDetailsType Conditional 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>


The example 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. See UPS for the maximum weight allowed by UPS.

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
  .ShippingServiceCostOverrideList
ShippingServiceCostOverrideListType Optional This container is used when the seller wants to override the flat shipping costs for all domestic and/or all international shipping services defined in the Business Policies shipping profile referenced in the SellerProfiles.SellerShippingProfile.ShippingProfileID field. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services.

A ShippingServiceCostOverrideList.ShippingServiceCostOverride container is required for each domestic and/or international shipping service that is defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the Business Policies shipping profile.

Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each ShippingServiceCostOverrideList.ShippingServiceCostOverride container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile.

For Revise and Relist calls: To delete all shipping service cost overrides when you revise or relist, specify Item.ShippingServiceCostOverrideList in DeletedField, and don't pass ShippingServiceCostOverrideList in the request.
Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
ShippingServiceCostOverrideType Optional,
repeatable: [0..*]
A ShippingServiceCostOverride container is required for each domestic and/or international shipping service that is defined in the domesticShippingPolicyInfoService and intlShippingPolicyInfoService containers of the Business Policies shipping profile. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services.

Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each ShippingServiceCostOverride container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile.

To override the shipping costs for each domestic shipping service in the Business Policies shipping profile, the ShippingServiceType field should be set to 'Domestic', and to override the shipping costs for each international shipping service, the ShippingServiceType field should be set to 'International'. For both domestic and international shipping services, the ShippingServicePriority value should match the sortOrderId value for the matching shipping service in the shipping profile. If any of the domestic and/or international shipping service priorities and shipping service options in the Add/Revise/Relist call and Business Policies shipping profile do not match, an error occurs.

If shipping service cost overrides are used in a listing, the ShippingServiceCostOverride container will be returned in the GetSellerList and GetSellingManagerTemplates calls.
Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceAdditionalCost
AmountType (double) Optional This dollar value indicates the cost to ship each additional identical item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceAdditionalCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile.

This field is only applicable to multi-quantity, fixed-price listings.
Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceCost
AmountType (double) Optional This dollar value indicates the shipping service cost to ship one item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding shippingServiceCost value set in the domesticShippingPolicyInfoService (domestic shipping service) or intlShippingPolicyInfoService (international shipping service) containers in the Business Policies shipping profile.
Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServicePriority
int Optional This integer value maps the particular instance of the ShippingServiceCostOverride container to the domesticShippingPolicyInfoService or intlShippingPolicyInfoService container of the Business Policies shipping profile. The ShippingServicePriority value should match the sortOrderId value for the matching shipping service in the Business Policies shipping profile. If overriding the shipping costs for domestic shipping services, the ShippingServiceType field should be set to 'Domestic', and to override the shipping costs for international shipping services, the ShippingServiceType field should be set to 'International'.

If any of the domestic and/or international shipping service priorities and shipping service options in the Add/Revise/Relist call and Business Policies shipping profile do not match, an error occurs.
Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceType
ShippingServiceType Optional This enumerated value indicates whether domestic or international shipping costs are being overridden. To override the shipping costs for each domestic shipping service in the Business Policies shipping profile, this field should be set to 'Domestic', and to override the shipping costs for each international shipping service, this field should be set to 'International'.

Applicable values:

Domestic
(in) This value should be used if the seller is overriding shipping costs for all domestic shipping services defined in the Business Policies shipping profile.
International
(in) This value should be used if the seller is overriding shipping costs for all international shipping services defined in the Business Policies shipping profile.
Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingSurcharge
AmountType (double) Optional This dollar value indicates the shipping surcharge applicable to the domestic shipping service. If the shipping service costs override operation is successful, this value will override the corresponding shippingSurcharge value set in the domesticShippingPolicyInfoService container in the Business Policies shipping profile.

This field can only be used if the shipping surcharges are applicable for the corresponding shipping service.
Item
  .ShippingTermsInDescription
boolean Optional Indicates whether details about shipping costs and arrangements are specified in the item description.

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 a DetailName of ShippingLocationDetails to determine which international locations are valid for the site. Omit ShipToLocations if you want to ship only within the country of the listing site. To state that you do not wish to ship at all, set ShipToLocations to None. ReviseItem can add a ShipToLocations. On output, ShipToLocations is the collection of all input item-level ShipToLocations plus international shipping service-level ShipToLocation values.

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).
Max length: length of longest name in ShippingRegionCodeType and CountryCodeType.

See:
    Specifying Locations to Where You Ship
    GeteBayDetails



Applicable values: See CountryCodeType, ShippingRegionCodeType
Item.Site SiteCodeType Required The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem or AddFixedPriceItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API).

Applicable values: See Site.

See:
    eBay Sites and Environments
    Specifying the Target Site
    Field Differences for eBay Sites

Item.SKU SKUType (string) Optional A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

For multiple-variation listings, a SKU value is actually required for each product variation within the listing. However, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

Note: The eBay site cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.)

For GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.

Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

Item.StartPrice AmountType (double) Required The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price.

For auction listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice.

For input on fixed-price listings (FixedPriceItem): This is the constant price at which a buyer may purchase the item.

GetMyeBaySelling does not return Item.StartPrice for fixed price items—it returns Item.SellingStatus.CurrentPrice.

For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead.

For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.

See Listing Policies.

Item.Storefront StorefrontType Optional Contains information related to the item in the context of a seller's eBay Store. Applicable for auctions and fixed-price listings.
Item.Storefront
  .StoreCategory2ID
long Optional Unique identifier for the secondary custom category in which to list the item. Set this field to a root-level custom category or a custom category that has no child categories (subcategories).

The system resets the value to 0 (None) in the following cases:
- The values of StoreCategoryID and StoreCategory2ID field are the same
- You specify StoreCategory2ID but not StoreCategoryID


In other words, StoreCategoryID must be set to a valid custom category and be different from StoreCategory2ID.
Item.Storefront
  .StoreCategory2Name
string Optional Name of the secondary custom category in which to list the item. Set this field to a root-level custom category or a custom category that has no child categories (subcategories).

The system resets the value to 0 (None) in the following cases:
- The values of StoreCategoryName and StoreCategory2Name field are the same
- You specify StoreCategory2Name but not StoreCategoryName


In other words StoreCategoryName must be set to a valid custom category name and be different from StoreCategory2Name.
Item.Storefront
  .StoreCategoryID
long Optional Unique identifier of a primary custom category in which to list the item. A custom category is a category that the seller created in their eBay Store. eBay Store sellers can create up to three levels of custom categories for their stores, but the API only supports root-level categories.

To list an item using the categories in a seller's store, you must set this field to a root-level custom category or a custom category that has no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the 'Other' store category.
Item.Storefront
  .StoreCategoryName
string Optional Category name of a primary custom category in which to list the item. A custom category is a category that the seller created in their eBay Store. eBay Store sellers can create up to three levels of custom categories for their stores, but the API only supports root-level categories.

To list an item using a category name from a seller's store, you must set this field to a root-level custom category or a custom category that has no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the store category called 'Other'.
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).

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

Max length: 55.

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

Item.TaxCategory string Conditional Tax exception category code. This is to be used only by sellers who have opted into sales tax being calculated by a sales tax calculation vendor. If you are interested in becoming a tax calculation vendor partner with eBay, contact developer-relations@ebay.com.
Item.Title string Conditional Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ProductListingDetails.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.

Max length: 80.
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).

See Enabling Multi-jurisdiction Sales Tax.

Item.UUID UUIDType (string) Optional Universally unique constraint tag. Use UUID to ensure that you only list a particular item once, particularly if you are listing many items at once. If you add an item and do not get a response, resend the request with the same UUID. If the item was successfully listed the first time, you will receive an error message for trying to use a UUID that you have already used. The error will also include the item ID for the duplicated item and a boolean value indicating whether the duplicate UUID was sent by the same application.

We recommend you use Item.UUID with calls that add item objects (for example, AddItem and RelistItem). For calls that modify an existing item, such as ReviseItem, use InvocationID instead.

The UUID can only contain digits from 0-9 and letters from A-F and must be 32 characters long. The UUID value must be unique across all item listings on all sites.

Max length: 32.
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). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no purchases, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0.

As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e., within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing.

For GetItem and related calls Only returned when a listing has variations.

For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified.

For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.)

For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request.

See:
    Multi-Variation Listings
    Qualifications for Listing with Variations

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 Conditional One aspect of the variations that will be illustrated in the pictures for all variations. For example, if each variation is visually distinguished by color and the pictures show the different colors available, then specify "Color" as the name. The name must match one of the names specified in the VariationSpecifics container.

This field is required in each Item.Variations.Pictures container that is used.
Max length: 40.
Item.Variations.Pictures
  .VariationSpecificPictureSet
VariationSpecificPictureSetType Conditional,
repeatable: [0..*]
A container consisting of one or more picture URLs associated with a variation specific value (e.g., color=blue). For example, suppose a listing contains blue and black color variations, and VariationSpecificName=Color. In this case, one picture set could contain pictures of the blue shirts (e.g., front view, back view, and close-up of a trim detail), and another picture set could contain pictures of the black shirts.

A variation specific picture set can consist of up to 12 images hosted by eBay Picture Services (EPS) or self-hosted (hosted outside of eBay) pictures. The eBay Picture Services and self-hosted images can never be combined into the same variation specific picture set.

At least one picture set is required if the Pictures node is present in the request. You are not required to provide pictures for all values that correspond to the variation specific name. For example, a listing could have pictures depicting the blue and black color variations, but not the pink variations.

Note: All images must comply with the Picture Requirements.
Item.Variations.Pictures
  .VariationSpecificPictureSet
  .PictureURL
anyURI Conditional,
repeatable: [0..*]
The URL of a picture that is associated with the VariationSpecificValue. A variation specific picture set can consist of up to 12 self-hosted or eBay Picture Services (EPS) hosted pictures. eBay Picture Services and self-hosted images can never be combined into the same variation specific picture set. To specify more than one image, use multiple PictureURL fields, passing in a distinct URL in each of those fields. This field cannot have an empty/null value.

The image specified in the first PictureURL field is also used as the thumbnail image for applicable variations. For example, if the picture set contains pictures of red shirts (i.e., VariationSpecificName=Color and VariationSpecificValue=Red), the first picture is used as the thumbnail image for all the red shirt variations.

Note: All images must comply with the Picture Requirements. You can use Item.PictureDetails to specify additional pictures. For example, the item-level pictures could include a model wearing a black shirt, as a typical example of the shirt style.

Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name. Variation pictures cannot be added or removed from a fixed-price listing when the listing is scheduled to end within 12 hours or if the item variation has already had transactions.

Note: For some large merchants, there are no limitations on when variation pictures can be added or removed from a fixed-price listing, even when the item variation has had transactions or is set to end within 12 hours.
Item.Variations.Pictures
  .VariationSpecificPictureSet
  .VariationSpecificValue
string Conditional A value that is associated with VariationSpecificName. For example, suppose this set of pictures is showing blue shirts, and some of the variations include Color=Blue in their variation specifics. If VariationSpecificName is Color , then VariationSpecificValue would be Blue.
Item.Variations.Variation VariationType Conditional,
repeatable: [1..120]
Contains data that distinguishes one item variation from another. For example, if an item varies by color and size, each Variation node specifies a combination of one of those colors and sizes.

When listing or relisting an item, you are allowed to create a listing with only one item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers.

If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call.

When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0.

See Multi-Variation Listings.

Item.Variations.Variation
  .DiscountPriceInfo
DiscountPriceInfoType Optional This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites, while MAP is available only on the US site.

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

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

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

See Displaying Discount Pricing Information to Buyers.

Item.Variations.Variation
  .DiscountPriceInfo
  .MadeForOutletComparisonPrice
AmountType (double) Conditional Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet).

The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet.

In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.)
Item.Variations.Variation
  .DiscountPriceInfo
  .MinimumAdvertisedPrice
AmountType (double) Conditional Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can offer prices below MAP by means of other discounts. This only applies to fixed-price listings and auction listings with the Buy It Now option.
Item.Variations.Variation
  .DiscountPriceInfo
  .MinimumAdvertisedPriceExposure
MinimumAdvertisedPriceExposureCodeType Conditional For MinimumAdvertisedPrice (MAP) listings only. A seller cannot show the actual discounted price on eBay's View Item page. Instead, the buyer can either click on a pop-up on eBay's View Item page, or the discount price will be shown during checkout.

Applicable values:

CustomCode
(in/out) Reserved for future use.
DuringCheckout
(in/out) DuringCheckout specifies that the discounted price must be shown on the eBay checkout flow page.
None
(in/out) None means the discount price is not shown via either PreCheckout nor DuringCheckout.
PreCheckout
(in/out) PreCheckout specifies that the buyer must click a link (or a button) to navigate to a separate page (or window) that displays the discount price. eBay displays the discounted item price in a pop-up window.
Item.Variations.Variation
  .DiscountPriceInfo
  .OriginalRetailPrice
AmountType (double) Conditional The actual retail price set by the manufacturer (OEM). eBay does not maintain or validate the OriginalRetailPrice supplied by the seller. OriginalRetailPrice should always be more than StartPrice. Compare the StartPrice/BuyItNowPrice to OriginalRetailPrice to determine the amount of savings to the buyer.
Item.Variations.Variation
  .DiscountPriceInfo.SoldOffeBay
boolean Conditional Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on a Web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the seller's own price for the item.

If this field is set to true, eBay displays 'Was*' in the UK and 'Ursprunglich*' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set to true, SoldOneBay takes precedence.

Default: false.
Item.Variations.Variation
  .DiscountPriceInfo.SoldOneBay
boolean Conditional Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on eBay within the previous 30 days. The discount price is always in reference to the seller's own price for the item.

If this field is set to true, eBay displays 'Was' in the UK and 'Ursprunglich' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set to true, SoldOneBay takes precedence.

Default: false.
Item.Variations.Variation
  .Quantity
int Required 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. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true.

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

For RelistFixedPriceItem:
  • For an item variation that had an available quantity greater than 0 when the listing ended, the Quantity value of the item variation for the newly relisted item is set to the actual quantity available. For item variations, there is actually no QuantityAvailable field, but this value may be derived if you look at the corresponding item variation in a GetMyeBaySelling) response and subtract the Variation.QuantitySold value from the Variation.Quantity value, which represents the original Variation.Quantity value at creation time of the previous listing.
  • For item variations with an available quantity of 0 when the listing ended, the relisted item will retain the Variaton.Quantity value that was passed in at creation time of the previous listing.
So, if you are relisting an item that had one or more item variations with an available quantity of 0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings).

For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, unless you set the OutOfStockControlPreference boolean field of the SetUserPreferences call to true, at least one variation must remain with a non-zero quantity in order for the listing to remain active. If you set the OutOfStockControlPreference field to true, a multiple-variation listing will remain active but hidden from search even if the quantity of all variations in the listing is set to 0. 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.Quantityinstead.

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

Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True.

Min: 0.

See:
    Describing Variations in a Listing
    Using the Out-of-Stock Feature for more details

Item.Variations.Variation.SKU SKUType (string) Conditional 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) Conditional The fixed price for this item 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
  .VariationProductListingDetails
VariationProductListingDetailsType Optional This container is used to provide one or more product identifiers for a product variation within a multiple-variation, fixed-price listing. If the specified product is matched to a product in the eBay catalog, some of the details on the product variation will be prefilled for the listing, including the product variation name, and item specifics for that variation of the product. The same product identifier type must be used for all product variations within the listing. For instance, if one product variation uses ISBNs, all product variations must use ISBN values.

Note: Currently, the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 ( dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018.

When you specify VariationProductListingDetails, you must specify at least one GTIN. If you specify more than one of these values, eBay uses the first one that matches a product in eBay's catalog.

For ReviseItem and RelistItem only: When you revise a listing, if it ends within 12 hours, you cannot change the product identifier and you cannot remove existing product variation listing details data.
Item.Variations.Variation
  .VariationProductListingDetails
  .EAN
string Conditional This field is used if the seller wishes to identify each product variation within a multi-variation listing by an EAN (European Article Number) value. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products. Unlike single-variation listings where the EAN is specified in the ProductListingDetails container, eBay will attempt to match this EAN value to a product in the eBay catalog, but the product's item title, item description, item specifics, and stock photos are not automatically picked up for multiple-variation listings. If a secondary category is used, and the primary and secondary categories are both catalog-enabled, this EAN value should correspond to the primary category (not the secondary category).

Note: If the listing is being posted to a category that expects an EAN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, 'ProductDetails' should be included as a DetailName value in the call request.
Note: Currently, the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 (dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018.
Max length: 13.
Item.Variations.Variation
  .VariationProductListingDetails
  .ISBN
string Conditional This field is used if the seller wishes to identify each product variation within a multi-variation listing by an ISBN (International Standard Book Number) value. An ISBN is a unique identifer for books. Both 10 and 13-character ISBNs are supported. When specifying a 13-character ISBN, the value must begin with either '978' or '979'. Unlike single-variation listings where the ISBN is specified in the ProductListingDetails container, eBay will attempt to match this ISBN value to a product in the eBay catalog, but the product's item title, item description, item specifics, and stock photos are not automatically picked up for multiple-variation listings. If a secondary category is used, and the primary and secondary categories are both catalog-enabled, this ISBN value should correspond to the primary category (not the secondary category).

Note: If the listing is being posted to a category that expects an ISBN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, 'ProductDetails' should be included as a DetailName value in the call request.
Note: Currently, the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 (dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018.
Max length: 13.
Item.Variations.Variation
  .VariationProductListingDetails
  .NameValueList
NameValueListType Conditional,
repeatable: [0..*]
Note: The NameValueList container was added in Version 997, but it is not yet available for use in Sandbox or Production environments. Currently, the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 ( dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018. This container is used to pass in a name-value pair that will identify the type of product identifier (and its value) being used for a product variation within a multiple-variation listing. This product identifier, such as EAN, ISBN, or UPC, is then used by eBay to try and match the identifier to a product in the eBay catalog.

Note: If a brand/MPN pair is going to be used to identify product variations within a multiple-variation listing, the Brand identifier (and its value) should be specified at the listing level, or through the Item.ProductListingDetails.NameValueList container, and each product variation should be identified by its Manufacturer Part Number through the Variation.VariationProductListingDetails.NameValueList container. Please note that a brand cannot vary within the same listing. Each part must be from the same brand.
The GetCategorySpecifics call can be used to see the product identifier type(s) that are required/supported for a particular eBay category. Each required/supported product identifier type will be shown in a separate ProductIdentifiers.NameRecommendation container in the GetCategorySpecifics call response. The product identifier type name will be shown in the NameRecommendation.Name field. By looking at the value in the corresponding ProductIdentifiers.ValidationRules.MinRequired field, the seller will know if one or more product identifiers are required at listing time. If two product identifier types are returned, and the MinRequired value is '2', the seller will be required to use both product identifier types at listing time. If the MinRequired value is '1', only one of the two product identifier types would be required, but the seller could use them both if they wanted. If the MinRequired value is 0, one or both of those product identifier types could be used, but they would not be required.
Item.Variations.Variation
  .VariationProductListingDetails
  .NameValueList.Name
string Conditional Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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.

Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.
Item.Variations.Variation
  .VariationProductListingDetails
  .NameValueList.Value
string Conditional,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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: 65.
Item.Variations.Variation
  .VariationProductListingDetails
  .UPC
string Conditional This field is used if the seller wishes to identify each product variation within a multi-variation listing by a UPC (Universal Product Code) value. A UPC is a commonly used identifer for many different products. Unlike single-variation listings where the UPC is specified in the ProductListingDetails container, eBay will attempt to match this UPC value to a product in the eBay catalog, but the product's item title, item description, item specifics, and stock photos are not automatically picked up for multiple-variation listings. If a secondary category is used, and the primary and secondary categories are both catalog-enabled, this UPC value should correspond to the primary category (not the secondary category).

Note: If the listing is being posted to a category that expects a UPC value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response. To get the ProductDetails container to return in the GeteBayDetails response, 'ProductDetails' should be included as a DetailName value in the call request.
Note: Currently, the EAN, ISBN, or UPC fields are used to specify a Global Trade Item Number (GTIN), and the GetCategoryFeatures call is used to see if particular product identifier types are supported/required. Starting later in 2017 (dates will be announced as we approach second half of year), the NameValueList container can start being used to specify any and all GTINs, and the GetCategorySpecifics call will be the better option of retrieving the product identifier types that are supported/required. See the Required Product Identifiers Mandate (Current Phase) topic for more information on how product identifiers are currently used/specified in the Trading API, and see the Required Product Identifiers Mandate (Future Phase) topic for more information on how product identifiers will be used/specified in the Trading API beginning later in 2017. Note that the BrandMPN container, and the EAN, ISBN, and UPC fields will still be supported well into 2018.
Max length: 12.
Item.Variations.Variation
  .VariationSpecifics
NameValueListArrayType Conditional,
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 Conditional,
repeatable: [2..5]
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified.

For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node.

If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.
When you list with Item Variations:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • 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.

For more details, see Requiring Product Identifiers Mandate
Item.Variations.Variation
  .VariationSpecifics
  .NameValueList.Name
string Conditional Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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.

Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.
Item.Variations.Variation
  .VariationSpecifics
  .NameValueList.Value
string Conditional,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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: 65.
Item.Variations
  .VariationSpecificsSet
NameValueListArrayType Conditional 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 Conditional,
repeatable: [2..5]
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified.

For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node.

If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.
When you list with Item Variations:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • 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.

For more details, see Requiring Product Identifiers Mandate
Item.Variations
  .VariationSpecificsSet
  .NameValueList.Name
string Conditional Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, a Parts Compatibility name, or a product identifier type.

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier type, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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.

Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.
Item.Variations
  .VariationSpecificsSet
  .NameValueList.Value
string Conditional,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

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

For the AddItem and AddFixedPriceItem families of calls: In the ProductListingDetails.NameValueList (single-variation listing) and VariationProductListingDetails.NameValueList (multiple-variation listing) context, this value is the product identifier, such as ISBN or UPC. Product identifier types that are supported/required for a specific category can be retrieved using the GetCategorySpecifics call.

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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For GetCategorySpecifics: 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: 65.
Item.VATDetails VATDetailsType Conditional Container for eBay's VAT (value-added-tax) 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.

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 Features 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 (Value Add Tax) 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 Conditional This field displays the Vehicle Identification Number, which is a unique serial number for a motor vehicle.

This field is 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 in 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.

Max length: 17.
Item.VRM string Conditional Vehicle Registration Mark, which is a unique identifier for a motor vehicle in the UK.

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).
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
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

See Tags for the Identification of Languages.

MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version string Conditional The version number of the API code that you are programming against (e.g., 859). The version you specify for a call has these basic effects:
  • It indicates the version of the code lists and other data that eBay should use to process your request.
  • It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

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

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

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

High
(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
Low
(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.



Output

See also Samples.

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

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

<?xml version="1.0" encoding="utf-8"?>
<AddFixedPriceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <Category2ID> string </Category2ID>
  <CategoryID> string </CategoryID>
  <DiscountReason> DiscountReasonCodeType </DiscountReason>
  <!-- ... more DiscountReason values allowed here ... -->
  <EndTime> dateTime </EndTime>
  <Fees> FeesType
    <Fee> FeeType
      <Fee currencyID="CurrencyCodeType"> AmountType (double) </Fee>
      <Name> string </Name>
      <PromotionalDiscount currencyID="CurrencyCodeType"> AmountType (double) </PromotionalDiscount>
    </Fee>
    <!-- ... more Fee nodes allowed here ... -->
  </Fees>
  <ItemID> ItemIDType (string) </ItemID>
  <ListingRecommendations> ListingRecommendationsType
    <Recommendation> ListingRecommendationType
      <Code> string </Code>
      <FieldName> string </FieldName>
      <Group> string </Group>
      <Message> string </Message>
      <Metadata> MetadataType
        <Name> string </Name>
        <Value> string </Value>
        <!-- ... more Value values allowed here ... -->
      </Metadata>
      <!-- ... more Metadata nodes allowed here ... -->
      <Type> string </Type>
      <Value> string </Value>
      <!-- ... more Value values allowed here ... -->
    </Recommendation>
    <!-- ... more Recommendation nodes allowed here ... -->
  </ListingRecommendations>
  <ProductSuggestions> ProductSuggestionsType
    <ProductSuggestion> ProductSuggestionType
      <EPID> string </EPID>
      <Recommended> boolean </Recommended>
      <StockPhoto> string </StockPhoto>
      <Title> string </Title>
    </ProductSuggestion>
    <!-- ... more ProductSuggestion nodes allowed here ... -->
  </ProductSuggestions>
  <SKU> SKUType (string) </SKU>
  <StartTime> dateTime </StartTime>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <DuplicateInvocationDetails> DuplicateInvocationDetailsType
    <Status> InvocationStatusType </Status>
  </DuplicateInvocationDetails>
  <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>
  <Message> string </Message>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</AddFixedPriceItemResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
Category2ID string Conditionally Unique identifier of the secondary category in which the item was listed. This field is only returned if a secondary category was used, the Item.CategoryMappingAllowed boolean field is included and set to true in the request, and the Category ID passed in as the secondary listing category was mapped to a new Category ID by eBay. If the secondary category has not changed or it has expired with no replacement, this field is not returned.
Max length: 10.
CategoryID string Conditionally The unique identifier of the primary category in which the item was listed. This field is only returned if the Item.CategoryMappingAllowed boolean field is included and set to true in the request and the Category ID passed in as the primary listing category was mapped to a new Category ID by eBay. If the primary category has not changed, or if it has expired with no replacement, this field is not returned.
Max length: 10.
DiscountReason DiscountReasonCodeType Conditionally,
repeatable: [0..*]
This container is an array of one or more listing fee/upgrade discount types being offered by eBay to the seller.

Applicable values:

CustomCode
(out) Reserved for future use
Promotion
(out) An offer that applies to an unlimited number of listings during the offering period. Example: "Get subtitle for $0.10 in Tech category when listing between 12/25 and 12/28. No limit to the number of items listed during this period."
SpecialOffer
(out) An offer that applies to a limited number of listings during the offering period. Example: "There is no insertion fee for up to 5 auctions when listing between 12/1 and 12/10."

Code so that your app gracefully handles any future changes to this list.
EndTime dateTime Conditionally Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the ListingDuration field at listing time. If the value of ListingDuration was set to GTC (Good 'Til Cancelled) this value will be set 30 days ahead of the start time, although this value will be updated if the GTC listing is still alive and automatically renewed 30 days after start time.
Fees FeesType Always This container is an array of fees associated with the creation of the listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold.

See:
    eBay.com Fees
    Final Value Fees and Credits
    Final Value Fees
    Fees per Site
    Using Feature Packs to Save on Upgrade Fees

Fees.Fee FeeType Always,
repeatable: [1..*]
A Fee container is returned for each listing fee associated with listing an item. Each Fee container consists of the fee type, the amount of the fee, and any applicable eBay promotional discount on that listing fee. A Fee container is returned for each listing feature, even if the associated cost is 0.
Fees.Fee.Fee AmountType (double) Always Amount of the fee that eBay will charge the member for the associated listing feature.

See:
    eBay.com Fees for A current schedule of listing features and their associated fees.
    Fees Resulting from Listing an Item for A table listing the type of fees that can be charged when you list an item.

Fees.Fee.Fee
  [ attribute currencyID ]
CurrencyCodeType Always Amount of the fee that eBay will charge the member for the associated listing feature.

For a list of possible enumeration values, see CurrencyCodeType.
Fees.Fee.Name string Always This is the name of the listing feature, such as ListingFee, SubtitleFee, or BoldFee.

See Fees Resulting from Listing an Item.

Fees.Fee.PromotionalDiscount AmountType (double) Always This field exists in the response when the user has selected a feature that participates in a promotional discount.

Note: Verify calls might not return the PromotionalDiscount fee in the response.

See Standard selling fees for A current schedule of listing features and their associated fees..

Fees.Fee.PromotionalDiscount
  [ attribute currencyID ]
CurrencyCodeType Always This field exists in the response when the user has selected a feature that participates in a promotional discount.

Note: Verify calls might not return the PromotionalDiscount fee in the response.

For a list of possible enumeration values, see CurrencyCodeType.
ItemID ItemIDType (string) Always Unique identifier for the new fixed-price listing. This field is returned as long as the listing was successfully created.
Max length: 19 (Note: Currently, Item IDs are usually 9 to 12 digits).
ListingRecommendations ListingRecommendationsType Conditionally Container consisting of one or more Recommendation containers. Each Recommendation container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge.

This container is only returned if the IncludeRecommendations flag was included and set to 'true' in the AddFixedPriceItem request, and if at least one listing recommendation exists for the newly created listing. If one or more listing recommendations are returned, it will be at the seller's discretion about whether to revise the item based on eBay's listing recommendation(s).
ListingRecommendations
  .Recommendation
ListingRecommendationType Conditionally,
repeatable: [0..*]
Each Recommendation container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to use Fast 'N Free shipping.

One or more Recommendation containers can be returned for each listing.
ListingRecommendations
  .Recommendation.Code
string Conditionally This code value provides a generic, "human-friendly" message summarizing what is wrong with the listing, or how it can be improved. These values include:
  • FIELD_VALUE_INCORRECT
  • FIELD_VALUE_RECOMMENDATION
  • MANDATED_FIELD_VALUE_MISSING
  • MANDATORY_STANDARDS_NOT_MET
  • RECOMMENDED_FIELD_VALUE_MISSING
  • RECOMMENDED_FIELD_VALUE_TO_REMOVE
  • RECOMMENDED_STANDARDS_NOT_MET
This field is always returned with each recommendation container.
Max length: 128.
ListingRecommendations
  .Recommendation.FieldName
string Conditionally The FieldName value will vary based on the recommendation type. The FieldName values for each recommendation type are summarized below:

For eTRS listing recommendations, the FieldName value will indicate the specific Trading API field that the seller needs to update to bring the listing up to top-rated listing standards. For example, if the Recommendation.Type value is 'eTRS' and the Recommendation.Group value is 'SHIPPING', the FieldName value may be 'DispatchTimeMax'. If the seller is returned a listing recommendation like this, it would most likely indicate that the seller must reduce the handling time (DispatchTimeMax value) in the listing to '0' (same-day shipping) or '1' (one-day handling time) in order for the listing to qualify as a top-rated listing and receive a Top Rated Plus seal in View Item and Search Results pages.

For an ItemSpecifics listing recommendation, the FieldName value will be the name of the recommended Item Specific. If the seller gets a ItemSpecifics listing recommendation, the seller will perform a ReviseItem/ReviseFixedPriceItem call, passing in the recommended Item Specific (with one or more values) through the ItemSpecifics.NameValueList container. If available, eBay will also return recommended Item Specific value(s) through the Recommendation.Value field.

For a Picture listing recommendation, the FieldName value will be the URL of the image that needs to be brought up to picture quality standards. If the seller gets a Picture listing recommendation for this image in the listing, the seller will need to make the required picture quality update, and then perform a ReviseItem/ReviseFixedPriceItem call, passing in the URL of the image through the PictureURL field in the PictureDetails container.

If the seller gets a Picture listing recommendation for this image in the listing, the seller will need to make the required picture quality update, and then perform a ReviseItem/ReviseFixedPriceItem call, passing in the URL of the image through the PictureURL field in the PictureDetails container.

For a Price listing recommendation, the FieldName value will be one of the following:
  • BuyItNowPrice: the recommended price for an item in a fixed-price listing or for the "Buy It Now" price in an auction listing; this value will be shown in the Recommendation.Value field. Upon getting a BuyItNowPrice recommendation, the seller may consider revising their listing with a price matching or closer to the recommended price.
  • ListingType: this value is returned if a different listing type (auction vs. fixed-price) is being suggested for the item. Upon getting a ListingType recommendation, the seller may consider the recommended listing type the next time they list a similar item.
  • StartPrice: the recommended starting bid price for an item in an auction listing; this value will be shown in the Recommendation.Value field. Upon getting a StartPrice recommendation, the seller may consider the recommended starting bid price the next time they list a similar item.
Two other pricing recommendations, BuyItNowPriceRange and StartPriceRange, are supported in the Listing Recommendation API, but are not yet supported by the Trading API.

For a Title listing recommendation, the FieldName value will be 'Title' for any of the three use cases - missing keywords, missing Item Specifics, or inaccurate keywords. Upon getting a Title recommendation, the seller may consider the Title recommendation (adding keywords, adding Item Specifics, removing inaccurate keywords) the next time they list a similar item.

For an FnF listing recommendation, either one or two recommendation containers will be returned, based on whether a listing needs fast handling (same-day handling or handling time of 1 day), at least one free shipping service, or both. These two fieldName values are described below:
  • shipsWithinDays: this fieldName value is returned if the seller needs to implement fast handling (same-day handling or a handling time of 1 day). To implement fast handling, the seller will perform a ReviseItem/ReviseFixedPriceItem call, passing a value of '0' or '1' into the DispatchTimeMax field.
  • shippingServiceCost: this fieldName value is returned if the seller needs to offer a free shipping service option in the listing. To add a free shipping service option, the seller will perform a ReviseItem/ReviseFixedPriceItem call, passing in one or more ShippingDetails.ShippingServiceOptions containers where the shipping service is free (ShippingServiceOptions.FreeShipping boolean value set to 'true').


This FieldName field is always returned with each Recommendation container.
Max length: 256.
ListingRecommendations
  .Recommendation.Group
string Conditionally This value indicates the group that a specific listing recommendation belongs to. There may be multiple groups for each listing recommendation type. For example, two groups of the eTRS listing recommendation type are 'SHIPPING' and 'RETURNS'.
Max length: 256.
ListingRecommendations
  .Recommendation.Message
string Conditionally This textual message is the detailed description of a specific action that a seller can take to improve the quality of the listing, or bring it up to Picture or eTRS standards. For some recommendations, the fields may be revised on an active listing through a ReviseItem or ReviseFixedPriceItem call of the Trading API. For other recommendations, it may not be possible to revise the fields on an active listing.

This field is returned in the Recommendation container when available/applicable.
Max length: 4000.
ListingRecommendations
  .Recommendation.Metadata
MetadataType Conditionally,
repeatable: [0..*]
This container contains price guidance information, which includes the minimum and maximum recommended prices for the item, which are based on recent sales of similar items. This container is only returned for price recommendations and when the pricing data is available.

A Metadata container is returned for each price guidance parameter that is applicable/available for the pricing recommendation.
ListingRecommendations
  .Recommendation.Metadata.Name
string Conditionally The name of the price guidance parameter is returned in this field. Any of the following price guidance parameters may be returned in a Metadata container:
  • AppliesTo: this parameter indicates the type of listing that the MaxRecommendedValue and MinRecommendedValue values pertain to. The corresponding value values that can be returned with the AppliesTo parameter is 'Auction' and 'FixedPrice'.
  • Currency: this parameter indicates the type of currency being used for the MaxRecommendedValue and MinRecommendedValue values. The currency values (returned in corresponding value field) are based on the currency codes defined in the ISO 4217 - Currency Codes standard.
  • MaxRecommendedValue: this parameter indicates the upper end of the recommended price range for the item. Based on the recent sales of similar items, eBay recommends a price range through the MaxRecommendedValue and MinRecommendedValue parameters. A dollar value is returned in the corresponding value field.
  • MinRecommendedValue: this parameter indicates the lower end of the recommended price range for the item. Based on the recent sales of similar items, eBay recommends a price range through the MaxRecommendedValue and MinRecommendedValue parameters. A dollar value is returned in the corresponding value field.
  • SimilarItems: this parameter and its corresponding value values indicates which eBay item listings were used to determine the MinRecommendedValue and MaxRecommendedValue values. The values returned in the value fields are Item IDs.
ListingRecommendations
  .Recommendation.Metadata.Value
string Conditionally,
repeatable: [0..*]
The corresponding value(s) for the price guidance parameter (returned in Name field of the same Metadata container. For the AppliesTo parameter, this value will either be 'Auction' or 'FixedPrice'. For the Currency parameter, this value will be a three-digit representation of a currency (as defined in the ISO 4217 - Currency Codes standard). For the MaxRecommendedValue and MinRecommendedValue parameters, this value will be a dollar value. For the SimilarItems parameters, this value will be an Item ID value, and it's possible that numerous Item IDs will be returned.
ListingRecommendations
  .Recommendation.Type
string Conditionally This value indicates the specific type of listing recommendation being provided to the seller. Possible values include the following:
  • eTRS - this recommendation type advises the seller that the listing is not meeting a specific Top-Rated listing requirement, such as same-day or 1-day handling or a 14-day (or longer) Money Back Return Policy;
  • ItemSpecifics - this recommendation type advises the seller that the listing is missing a required or recommended Item Specifics name/value pair;
  • Picture - this recommendation type advises the seller that a specific picture in the listing is not meeting a specific picture qualityrequirement;
  • Price - this recommendation type provides a recommended price and/or a recommended price range for auction and fixed-price listings. These price recommendation values are based on similar items that have recently sold on eBay. Along with pricing recommendations, a recommended listing format (auction vs. fixed-price) is also returned. This recommendation type is currently only supported on the US, UK, and DE sites;
  • Title - this recommendation type provides guidance on forming an effective listing title, and will suggest valuable keywords or recommended Item Specifics that the listing title is missing. This recommendation type will also call out keywords that do not accurately describe the item. The keywords or Item Specifics are called out in the response. This recommendation type is currently only supported on the US, UK, DE, and AU sites; and
  • FnF - this recommendation type advises the seller to offer expedited shipping for the item (same-day shipping or handling time of 1 day) and/or offer at least one free shipping service option.

Max length: 128.
ListingRecommendations
  .Recommendation.Value
string Conditionally,
repeatable: [0..*]
The Value field is only applicable for ItemSpecifics, Pricing, and Title listing recommendation types, and it is only returned for these recommendation types.

For the ItemSpecifics recommendation type, the value in the Value field is a recommended value for the recommended Item Specific name found in the Recommendation.FieldName field. Each Item Specific name can have more than one recommended value, so it is possible to have multiple Recommendation.Value fields for that recommendation. It is also possible that a recommended Item Specific name will have no recommended values, hence no Recommendation.FieldName values are returned.

For the Pricing recommendation type, the value in the Value field is either:
  • a recommended value for the starting bid price (if Recommendation.FieldName value is 'StartPrice');
  • a recommended value for a fixed-price item (if Recommendation.FieldName value is 'BuyItNowPrice'); or
  • a recommended value for the listing type (if Recommendation.FieldName value is 'ListingType').
For the Title recommendation type, the value in the value field is either:
  • a recommended keyword to include in the listing Title (if Recommendation.Code value is 'RECOMMENDED_FIELD_VALUE_MISSING');
  • a recommended keyword to remove (to maintain accuracy) in the listing Title (if Recommendation.Code value is 'RECOMMENDED_FIELD_VALUE_TO_REMOVE');
  • a recommended Item Specific to include in the listing Title (if Recommendation.Code value is 'FIELD_VALUE_RECOMMENDATION');
Each Title recommendation can have more than one keyword or Item Specific value, so it is possible to have multiple Recommendation.Value fields for that recommendation.
Max length: 128.
ProductSuggestions ProductSuggestionsType Conditionally This container holds an array of one or more products in the eBay product catalog that appear to match the product being listed, just based on the information in the listing. This container will not be returned if no similar products were found in the eBay product catalog.
ProductSuggestions
  .ProductSuggestion
ProductSuggestionType Conditionally,
repeatable: [0..*]
Contains details for one or more individual product suggestions. The product details include the EPID, Title, Stock photo url and whether or not the product is an exact match for the submitted item. This product information can be used to list subsequent items.
ProductSuggestions
  .ProductSuggestion.EPID
string Conditionally The product reference Id of the product The eBay Product ID, a global reference ID for an eBay catalog product. The ePID is a fixed reference to a product (regardless of version).
ProductSuggestions
  .ProductSuggestion.Recommended
boolean Conditionally If true, indicates that the product is an exact match, suitable for listing the item.
ProductSuggestions
  .ProductSuggestion.StockPhoto
string Conditionally Fully qualified URL for a stock image (if any) that is associated with the eBay catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it.
ProductSuggestions
  .ProductSuggestion.Title
string Conditionally The title of the product from the eBay catalog.
Max length: 80.
SKU SKUType (string) Conditionally The SKU value for an item is returned if the seller specified a SKU value through the Item.SKU field in the request. In the case of a multi-variation listing, variation-level SKU values are not returned in the response. To get this data, a GetItem call would have to be made by the seller.
StartTime dateTime Always Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller included the Item.ScheduleTime field in the request and set a custom start time of the listing (in the future).
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 the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

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

Code so that your app gracefully handles any future changes to this list.
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.
DuplicateInvocationDetails DuplicateInvocationDetailsType Conditionally Information that explains a failure due to a duplicate InvocationID being passed in.
DuplicateInvocationDetails
  .Status
InvocationStatusType Conditionally This enumeration value indicates the status of the previous call that used the InvocationID or InvocationTrackingID specified in the DuplicateInvocationID.

Applicable values:

CustomCode
 
Failure
(out)
InProgress
(out)
Success
(out)

Code so that your app gracefully handles any future changes to this list.
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.

Code so that your app gracefully handles any future changes to this list.
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 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.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
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) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, 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.


See the Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Code so that your app gracefully handles any future changes to this list.
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Message string Conditionally Supplemental information from eBay, if applicable. May elaborate on errors (such as how a listing violates eBay policies) or provide useful hints that may help a seller increase sales. This data can accompany the call's normal data result set or a result set that contains only errors.

Applications must recognize when the Message field is returned and provide a means to display the listing hints and error message explanations to the user.

The string can return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML-based application should be able to include the HTML as-is in the HTML page that displays the results. A non-HTML application would need to parse the HTML and convert the table elements and image references into UI elements particular to the programming language used. As usual for string data types, the HTML markup elements are escaped with character entity references (e.g.,<table><tr>...).

See Standard Data for All Calls.

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 the Time Values section in the eBay Features 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Detail Controls


DetailLevel

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



Samples

New to making API calls? Please see Making a Call.

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.

Available samples:

Sample: Product Details with UPC and Item Condition

Lists an item with product details (using a UPC) and ConditionID.

Description

The seller megaonlinemerchant wants to sell a new Apple laptop on the eBay US site. They want to use a UPC to fill in the product details.

As a result of this call, megaonlinemerchant has a new listing for their laptop on eBay with the product details that match the UPC. You can call GetItem with the DetailLevel set to ReturnAll or ItemReturnAttributes to see the product details (includine pre-filled item specifics).

Input

The seller sets ConditionID to 1000 to indicate that this is a new laptop. The seller specifies a UPC in ProductListingDetails to find a product in eBay's catalog and use it to pre-fill the item specifics. The seller also chooses to include a stock photo from the catalog, and to use that photo as the gallery image.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<AddFixedPriceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>YOURTOKENHERE</eBayAuthToken>
  </RequesterCredentials>
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <Item>
    <Title>Apple MacBook Pro MB990LL/A 13.3 in. Notebook NEW</Title>
    <Description>Brand New Apple MacBook Pro MB990LL/A 13.3 in. Notebook!</Description>
    <PrimaryCategory>
      <CategoryID>111422</CategoryID>
    </PrimaryCategory>
    <StartPrice>500.0</StartPrice>
    <CategoryMappingAllowed>true</CategoryMappingAllowed>
    <ConditionID>1000</ConditionID>
    <Country>US</Country>
    <Currency>USD</Currency>
    <DispatchTimeMax>3</DispatchTimeMax>
    <ListingDuration>Days_7</ListingDuration>
    <ListingType>FixedPriceItem</ListingType>
    <PaymentMethods>PayPal</PaymentMethods>
    <PayPalEmailAddress>megaonlinemerchant@gmail.com</PayPalEmailAddress>
    <PictureDetails>
      <GalleryType>Gallery</GalleryType>
    </PictureDetails>
    <PostalCode>95125</PostalCode>
    <ProductListingDetails>
      <UPC>885909298594</UPC>
      <IncludeStockPhotoURL>true</IncludeStockPhotoURL>
      <IncludeeBayProductDetails>true</IncludeeBayProductDetails>
      <UseFirstProduct>true</UseFirstProduct>
      <UseStockPhotoURLAsGallery>true</UseStockPhotoURLAsGallery>
      <ReturnSearchResultOnDuplicates>true</ReturnSearchResultOnDuplicates>
    </ProductListingDetails>
    <Quantity>6</Quantity>
    <ReturnPolicy>
      <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
      <RefundOption>MoneyBack</RefundOption>
      <ReturnsWithinOption>Days_30</ReturnsWithinOption>
      <Description>If you are not satisfied, return the item for refund.</Description>
      <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
    </ReturnPolicy>
    <ShippingDetails>
      <ShippingType>Flat</ShippingType>
      <ShippingServiceOptions>
        <ShippingServicePriority>1</ShippingServicePriority>
        <ShippingService>UPSGround</ShippingService>
        <FreeShipping>true</FreeShipping>
        <ShippingServiceAdditionalCost currencyID="USD">0.00</ShippingServiceAdditionalCost>
      </ShippingServiceOptions>
    </ShippingDetails>
    <Site>US</Site>
  </Item>
</AddFixedPriceItemRequest>

Output

The response includes the ItemID and the list of fees associated with the listing. There are no additional fees associated with product details or an item condition.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddFixedPriceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2016-03-31T16:27:27.892Z</Timestamp>
  <Ack>Warning</Ack>
  <Errors>
    <ShortMessage>Dropped condition from Item specifics.</ShortMessage>
    <LongMessage>Dropped condition from Item specifics.</LongMessage>
    <ErrorCode>21916885</ErrorCode>
    <SeverityCode>Warning</SeverityCode>
    <ErrorClassification>RequestError</ErrorClassification>
  </Errors>
  <Version>967</Version>
  <Build>E967_CORE_BUNDLED_10913188_R1</Build>
  <ItemID>110044494992</ItemID>
  <StartTime>2016-03-31T16:27:26.970Z</StartTime>
  <EndTime>2016-04-07T16:27:26.970Z</EndTime>
  <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.5</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.5</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>
</AddFixedPriceItemResponse>

Back to list of samples

Sample: Create a Multi-Variation Listing

Creates a multi-variation listing that will require inventory management over a long period.

Description

A salesperson from megaonlinemerchant is listing multiple, similar women's tops that vary in size and color. To save fees and improve Best Match scores, he is including all the items in a single listing.

To create this listing on eBay, the seller must be eligible to list with variations, the category must support multi-variation listings, and the items must differ by at least one Item Specific. (See the Using Multi-Variation Listings for more details.)

To determine whether the listing's category supports multi-variation listings, call GetCategoryFeatures, with VariationsEnabled set as a FeatureID value in the request, and then look for a true value in the VariationsEnabled field for the category in the response. It's also a good idea to call GetCategorySpecifics to retrieve recommended Item Specifics for that category.

Input

The women's tops that megaonlinemerchant is listing are always in fashion, so the salesperson expects to keep them in stock (and to restock them as needed) for a very long time. Therefore, he chooses a listing duration of GTC, and he configures some of the variation details in anticipation of future revisions.

He specifies shared details (like Brand) for all the tops in Item.ItemSpecifics. Some of the item specifics (Brand, Style, and Size Type) are required, according to GetCategorySpecifics, so he is careful to specify them correctly to avoid errors.

He can't specify Item.Quantity and Item.StartPrice, because each variation needs its own quantity and price (see below).

He specifies the details that differ for each set of tops in Item.Variations. For each variation:

In addition to defining the variation details, the salesperson needs to configure the way buyers will browse and select the variations in eBay's View Item page (and in third-party applications). To do this, he uses Variations.VariationSpecificSet. This configures drop-down list options in eBay's View Item page (see screen shot). He expects buyers to first choose their size, and then choose a color that is available in their size, and then a shade that is available for that color:

All the yellow tops are back-ordered, and some of the sizes for some colors won't be in for several weeks. Therefore, the salesperson doesn't include any variations for yellow tops or for the missing sizes.

The salesman includes pictures for each color in Variations.Pictures. He also includes some shared pictures (such as a model wearing a representative example of the shirt style) in Item.PictureDetails.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<AddFixedPriceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <Item>
    <Country>US</Country>
    <Currency>USD</Currency>
    <Description><![CDATA[New Ralph Lauren Polo womens tops shirts! Black, Pink, Yellow, Blue. NWT]]></Description>
    <DispatchTimeMax>3</DispatchTimeMax>
    <ListingDuration>GTC</ListingDuration>
    <ListingType>FixedPriceItem</ListingType>
    <PaymentMethods>PayPal</PaymentMethods>
    <PayPalEmailAddress>megaonlinemerchant@gmail.com</PayPalEmailAddress>
    <PostalCode>95125</PostalCode>
    <PrimaryCategory>
      <CategoryID>37565</CategoryID>
    </PrimaryCategory>
    <Title>New Ralph Lauren Polo shirt Pink Black Blue Yellow</Title>
    <PictureDetails>
      <PictureURL>http://i12.ebayimg.com/03/i/04/8a/5f/a1_1_sbl.JPG</PictureURL>
      <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sbl.JPG</PictureURL>
      <PictureURL>http://i4.ebayimg.ebay.com/01/i/000/77/3c/d88f_1_sbl.JPG</PictureURL>
    </PictureDetails>
    <ReturnPolicy>
      <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
      <RefundOption>MoneyBack</RefundOption>
      <ReturnsWithinOption>Days_30</ReturnsWithinOption>
      <Description>Text description of return policy details</Description>
      <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
    </ReturnPolicy>
    <ShippingDetails>
      <CalculatedShippingRate>
        <OriginatingPostalCode>95125</OriginatingPostalCode>
        <MeasurementUnit>English</MeasurementUnit>
        <PackageDepth>6</PackageDepth>
        <PackageLength>7</PackageLength>
        <PackageWidth>7</PackageWidth>
        <ShippingPackage>PackageThickEnvelope</ShippingPackage>
        <WeightMajor>2</WeightMajor>
        <WeightMinor>0</WeightMinor>
      </CalculatedShippingRate>
      <PaymentInstructions>Payment must be received within 7 business days of purchase.</PaymentInstructions>
      <SalesTax>
        <SalesTaxPercent>8.75</SalesTaxPercent>
        <SalesTaxState>CA</SalesTaxState>
      </SalesTax>
      <ShippingServiceOptions>
        <FreeShipping>true</FreeShipping>
        <ShippingService>USPSPriority</ShippingService>
        <ShippingServicePriority>1</ShippingServicePriority>
      </ShippingServiceOptions>
      <ShippingServiceOptions>
        <ShippingService>UPSGround</ShippingService>
        <ShippingServicePriority>2</ShippingServicePriority>
      </ShippingServiceOptions>
      <ShippingServiceOptions>
        <ShippingService>UPSNextDay</ShippingService>
        <ShippingServicePriority>3</ShippingServicePriority>
      </ShippingServiceOptions>
      <ShippingType>Calculated</ShippingType>
    </ShippingDetails>
    <ItemSpecifics>
      <NameValueList>
        <Name>Occasion</Name>
        <Value>Casual</Value>
      </NameValueList>
      <NameValueList>
        <Name>Brand</Name>
        <Value>Ralph Lauren</Value>
      </NameValueList>
      <NameValueList>
        <Name>Style</Name>
        <Value>Polo Shirt</Value>
      </NameValueList>
      <NameValueList>
        <Name>Sleeve Style</Name>
        <Value>Short Sleeve</Value>
      </NameValueList>
    </ItemSpecifics>
    <Variations>
      <VariationSpecificsSet>
        <NameValueList>
          <Name>Size</Name>
          <Value>XS</Value>
          <Value>S</Value>
          <Value>M</Value>
          <Value>L</Value>
          <Value>XL</Value>
        </NameValueList>
        <NameValueList>
          <Name>Color</Name>
          <Value>Black</Value>
          <Value>Pink</Value>
          <Value>Yellow</Value>
          <Value>Blue</Value>
        </NameValueList>
      </VariationSpecificsSet>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Pnk_S</SKU>
        <StartPrice>17.99</StartPrice>
        <Quantity>4</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Pink</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>S</Value>
          </NameValueList>
        </VariationSpecifics>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Pnk_M</SKU>
        <StartPrice>17.99</StartPrice>
        <Quantity>8</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Pink</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>M</Value>
          </NameValueList>
        </VariationSpecifics>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Blk_S</SKU>
        <StartPrice>20.00</StartPrice>
        <Quantity>10</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Black</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>S</Value>
          </NameValueList>
        </VariationSpecifics>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Blk_M</SKU>
        <StartPrice>20.00</StartPrice>
        <Quantity>10</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Black</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>M</Value>
          </NameValueList>
        </VariationSpecifics>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Blu_S</SKU>
        <StartPrice>20.00</StartPrice>
        <Quantity>10</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Blue</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>S</Value>
          </NameValueList>
        </VariationSpecifics>
      </Variation>
      <Variation>
        <SKU>RLauren_Wom_TShirt_Blu_M</SKU>
        <StartPrice>20.00</StartPrice>
        <Quantity>10</Quantity>
        <VariationSpecifics>
          <NameValueList>
            <Name>Color</Name>
            <Value>Blue</Value>
          </NameValueList>
          <NameValueList>
            <Name>Size</Name>
            <Value>M</Value>
          </NameValueList>
        </VariationSpecifics>
      </Variation>
      <Pictures>
        <VariationSpecificName>Color</VariationSpecificName>
        <VariationSpecificPictureSet>
          <VariationSpecificValue>Pink</VariationSpecificValue>
          <PictureURL>http://i12.ebayimg.com/03/i/04/8a/5f/a1_1_sbl.JPG</PictureURL>
          <PictureURL>http://i12.ebayimg.com/03/i/04/8a/5f/a1_1_sb2.JPG</PictureURL>
        </VariationSpecificPictureSet>
        <VariationSpecificPictureSet>
          <VariationSpecificValue>Blue</VariationSpecificValue>
          <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sbl.JPG</PictureURL>
          <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sb2.JPG</PictureURL>
          <PictureURL>http://i22.ebayimg.com/01/i/04/8e/53/69_1_sb3.JPG</PictureURL>
        </VariationSpecificPictureSet>
        <VariationSpecificPictureSet>
          <VariationSpecificValue>Black</VariationSpecificValue>
          <PictureURL>http://i4.ebayimg.ebay.com/01/i/000/77/3c/d88f_1_sbl.JPG</PictureURL>
        </VariationSpecificPictureSet>
        <VariationSpecificPictureSet>
          <VariationSpecificValue>Yellow</VariationSpecificValue>
          <PictureURL>http://i4.ebayimg.ebay.com/01/i/000/77/3c/d89f_1_sbl.JPG</PictureURL>
        </VariationSpecificPictureSet>
      </Pictures>
    </Variations>
  </Item>
  <RequesterCredentials>
    <eBayAuthToken>YOURTOKENHERE</eBayAuthToken>
  </RequesterCredentials>
</AddFixedPriceItemRequest>

Output

The response includes the ItemID and the list of fees associated with listing megaonlinemerchant's items. For this particular AddFixedPriceItem call with variations, the fees are the insertion fee and picture fees.

To peform or track activities against specific variations, applications need to use the ItemID as well as the VariationSpecifics or variation SKU to uniquely identify the variations. (See the Using Multi-Variation Listings guide and calls like ReviseFixedPriceItem and GetItem for details.)

As a result of successfully submitting this listing, eBay's View Item page and GetItem show buyers all available variations, with the option to view a single variation. Search calls are able to find the listing based on keywords matching any of the variations. In GetItem, the item-level StartPrice appears as $17.99, which is the lowest available variation price.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddFixedPriceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-06-12T14:16:25.914Z</Timestamp>
  <Ack>Success</Ack>
  <Version>967</Version>
  <Build>e967__Bundled_9183565_R1</Build>
  <ItemID>110039490209</ItemID>
  <StartTime>2015-06-12T14:16:25.257Z</StartTime>
  <EndTime>2015-07-12T14:16:25.257Z</EndTime>
  <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.65</Fee>
    </Fee>
    <Fee>
      <Name>PhotoDisplayFee</Name>
      <Fee currencyID="USD">0.0</Fee>
    </Fee>
    <Fee>
      <Name>PhotoFee</Name>
      <Fee currencyID="USD">0.3</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>
</AddFixedPriceItemResponse>

Back to list of samples

Sample: Upload Multiple Listings in Bulk (for Large Merchants)

Defines and lists items that will be added to the eBay site by using eBay's Large Merchant Services solution. This sample demonstrates a data file that you would zip and then upload using the Bulk Data Exchange API and File Transfer API. (You cannot do bulk uploads with the Trading API.)

Description

A salesperson from megaonlinemerchant wants to sell a warehouse full of shoes on the eBay US site. She creates a data file with listings for two different SKUs for men's basketball shoes to test her upload file and the data within it. She chooses flat-rate shipping for the shoes and includes various shipping options. After megaonlinemerchant verifies that this data file is producing the correct listings, she will expand this file to include all of the shoes that she wants to sell (e.g., with 2,000 or 20,000 listings).

AddFixedPriceItem needs a category ID. You may need to first call GetCategories to determine the category ID. (See GetCategories for more information.) For example, the category ID for shoes is 63850.

As a result of uploading this request by using calls in the Bulk Data Exchange API and the File Transfer API, megaonlinemerchant has two new listings for shoes on eBay with the details as provided in the call. She can use GetItem with the ItemID found in the AddFixedPriceItem response to confirm the item details.

Note: This sample shows the data file format that you use when you upload multiple AddFixedPriceItem requests in a .zip file by using the File Transfer API and Bulk Data Exchange API. See Large Merchant Services for information about uploading and managing inventory in bulk.

Input

The fields in the following AddFixedPriceItem request sample are included to represent megaonlinemerchant's two shoes listings within a data file. In this sample, we have included a basic AddFixedPricedItem request, followed by a more complex request that has pictures and multiple shipping options. In a normal data file that you upload with the File Transfer API, you can include thousands of listings per request type.

XML format.

<?xml version="1.0" encoding="UTF-8"?>
<BulkDataExchangeRequests xmlns="urn:ebay:apis:eBLBaseComponents">
  <Header>
    <Version>967</Version>
    <SiteID>0</SiteID>
  </Header>
<AddFixedPriceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <Version>967</Version>
  <Item>
    <CategoryMappingAllowed>true</CategoryMappingAllowed>
    <Country>US</Country>
    <Currency>USD</Currency>
    <Description>Minimal fixed-price shoe listing with SKU, free shipping, 3-day dispatch time, return policy, and no Item Specifics. New Nike Shox Elite TB White/White-Black-Chrome. Size: Mens US 12, UK 11, Europe 46 (Medium, D, M). Condition: New in box.</Description>
    <DispatchTimeMax>3</DispatchTimeMax>
    <InventoryTrackingMethod>SKU</InventoryTrackingMethod>
    <ListingDuration>Days_30</ListingDuration>
    <ListingType>FixedPriceItem</ListingType>
    <Location>San Jose, CA</Location>
    <PaymentMethods>PayPal</PaymentMethods>
    <PayPalEmailAddress>MegaOnlineMerchant@gmail.com</PayPalEmailAddress>
    <PrimaryCategory>
      <CategoryID>63850</CategoryID>
    </PrimaryCategory>
    <Quantity>6</Quantity>
    <ReturnPolicy>
      <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
      <RefundOption>MoneyBack</RefundOption>
      <ReturnsWithinOption>Days_30</ReturnsWithinOption>
      <Description>Text description of return policy details here.</Description>
      <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
    </ReturnPolicy>
    <ShippingDetails>
      <ShippingType>Flat</ShippingType>
      <ShippingServiceOptions>
        <ShippingServicePriority>1</ShippingServicePriority>
        <ShippingService>USPSPriority</ShippingService>
        <ShippingServiceCost currencyID="USD">0.0</ShippingServiceCost>
        <ShippingServiceAdditionalCost>0.00</ShippingServiceAdditionalCost>
        <FreeShipping>true</FreeShipping>
      </ShippingServiceOptions>
    </ShippingDetails>
    <Site>US</Site>
    <SKU>1122334455-14</SKU>
    <StartPrice>50.00</StartPrice>
    <Title>New Nike Shox Elite TB White Mens Basketball Shoes S 12</Title>
    <UUID>7d004a30b0f511ddad8b0807654c9a55</UUID>
  </Item>
</AddFixedPriceItemRequest>
<AddFixedPriceItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <Version>967</Version>
  <Item>
    <CategoryMappingAllowed>true</CategoryMappingAllowed>
    <Country>US</Country>
    <Currency>USD</Currency>
    <Description>Minimal fixed-price shoe listing with SKU, free shipping, 3-day dispatch time, return policy, and no Item Specifics. New Nike Shox Elite TB BLACK / WHITE-VARSITY RED. Size: Mens US 12, UK 11, Europe 46 (Medium, D, M). Condition: New in box.</Description>
    <DispatchTimeMax>3</DispatchTimeMax>
    <InventoryTrackingMethod>SKU</InventoryTrackingMethod>
    <ListingDuration>Days_30</ListingDuration>
    <ListingType>FixedPriceItem</ListingType>
    <Location>San Jose, CA</Location>
    <PaymentMethods>PayPal</PaymentMethods>
    <PayPalEmailAddress>MegaOnlineMerchant@gmail.com</PayPalEmailAddress>
    <PrimaryCategory>
      <CategoryID>63850</CategoryID>
    </PrimaryCategory>
    <Quantity>6</Quantity>
    <ReturnPolicy>
      <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
      <RefundOption>MoneyBack</RefundOption>
      <ReturnsWithinOption>Days_30</ReturnsWithinOption>
      <Description>Text description of return policy details here.</Description>
      <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
    </ReturnPolicy>
    <ShippingDetails>
      <ShippingType>Flat</ShippingType>
      <ShippingServiceOptions>
        <ShippingServicePriority>1</ShippingServicePriority>
        <ShippingService>USPSPriority</ShippingService>
        <ShippingServiceCost currencyID="USD">0.0</ShippingServiceCost>
        <ShippingServiceAdditionalCost>0.00</ShippingServiceAdditionalCost>
        <FreeShipping>true</FreeShipping>
      </ShippingServiceOptions>
    </ShippingDetails>
    <Site>US</Site>
    <SKU>1122334455-15</SKU>
    <StartPrice>55.00</StartPrice>
    <Title>New Nike Shox Elite TB Black Mens Basketball Shoes S 12</Title>
    <UUID>7d005a30b0f511ddad8b0876540c9a55</UUID>
  </Item>
</AddFixedPriceItemRequest>
</BulkDataExchangeRequests>

Output

The response includes the ItemID,SKU(if provided in the request) and the fees associated with listing megaonlinemerchant's shoes. The listing fees are the total fees incurred prior to selling the item. (With a fixed price item, the listing fees equal the insertion fees.) The response is returned as a .zip file, with a separate response for each item in the request file.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<BulkDataExchangeResponses xmlns="urn:ebay:apis:eBLBaseComponents">
<AddFixedPriceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2015-10-21T00:06:47.066Z</Timestamp>
   <Ack>Success</Ack>
   <Version>967</Version>
   <Build>e967_core_API_7225127_R1</Build>
   <ItemID>110036629691</ItemID>
   <SKU>1122334455-14</SKU>
   <StartTime>2015-09-21T00:06:46.379Z</StartTime>
   <EndTime>2015-10-21T00:06:46.379Z</EndTime>
   <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>
  </AddFixedPriceItemResponse>
<AddFixedPriceItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
   <Timestamp>2015-11-21T00:06:47.863Z</Timestamp>
   <Ack>Success</Ack>
   <Version>967</Version>
   <Build>e967_core_API_7225127_R1</Build>
   <ItemID>110036629692</ItemID>
   <SKU>1122334455-15</SKU>
   <StartTime>2015-11-21T00:06:47.379Z</StartTime>
   <EndTime>2015-12-21T00:06:47.379Z</EndTime>
   <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>
  </AddFixedPriceItemResponse>
</BulkDataExchangeResponses>

Back to list of samples



Change History

Change Date Description
997
2017-01-20
  • CalculatedShippingRate.PackageDepth (deprecated): This field is being deprecated. Package type, Package dimensions, and package weight should be specified in the ShippingPackageDetails container instead.
  • CalculatedShippingRate.PackageLength (deprecated): This field is being deprecated. Package type, Package dimensions, and package weight should be specified in the ShippingPackageDetails container instead.
  • CalculatedShippingRate.PackageWidth (deprecated): This field is being deprecated. Package type, Package dimensions, and package weight should be specified in the ShippingPackageDetails container instead.
  • CalculatedShippingRate.ShippingPackage (deprecated): This field is being deprecated. Package type, Package dimensions, and package weight should be specified in the ShippingPackageDetails container instead.
  • CalculatedShippingRate.WeightMajor (deprecated): This field is being deprecated. Package type, Package dimensions, and package weight should be specified in the ShippingPackageDetails container instead.
  • CalculatedShippingRate.WeightMinor (deprecated): This field is being deprecated. Package type, Package dimensions, and package weight should be specified in the ShippingPackageDetails container instead.
  • Item.ListingCheckoutRedirectPreference (deprecated): This field is being deprecated. Third-party checkout has been deprecated.
  • Item.PostCheckoutExperienceEnabled (deprecated): This field is being deprecated. The Post-Checkout Experience feature has been deprecated.
  • Item.SkypeContactOption (deprecated): This field is being deprecated. Member communication through Skype has been deprecated.
  • Item.SkypeEnabled (deprecated): This field is being deprecated. Member communication through Skype has been deprecated.
  • Item.SkypeID (deprecated): This field is being deprecated. Member communication through Skype has been deprecated.
  • Item.ThirdPartyCheckout (deprecated): This field is being deprecated. Third-party checkout has been deprecated.
  • Item.ThirdPartyCheckoutIntegration (deprecated): This field is being deprecated. Third-party checkout has been deprecated.
  • Item.UseRecommendedProduct (deprecated): This field is being deprecated.
  • PictureDetails.GalleryURL (deprecated): This field is being deprecated from public WSDL. It is only used internally.
  • ProductListingDetails.NameValueList (added): Although this container was added in Version 997, it is not yet available for use in Sandbox or Production environments. It is expected to be wired on for use late in the second quarter of 2017. Ultimately, specifying product identifiers through the NameValueList container will replace the process of specifying product identifiers through the BrandMPN container, or through the EAN, ISBN, or UPC fields.
  • ReturnPolicy.EAN (deprecated): This field is being deprecated. The EAN value will be specified through the ProductListingDetails or VariationProductListingDetails (multiple-variation listings only) containers instead.
  • ShippingDetails.InsuranceFee (deprecated): This field is being deprecated. If applicable, the shipping insurance fee should be specified in the ShippingDetails.InsuranceDetails or ShippingDetails.InternationalInsuranceDetails containers instead.
  • ShippingDetails.InsuranceOption (deprecated): This field is being deprecated. If applicable, the shipping insurance option should be specified in the ShippingDetails.InsuranceDetails or ShippingDetails.InternationalInsuranceDetails containers instead.
  • VariationProductListingDetails.NameValueList (added): Although this container was added in Version 997, it is not yet available for use in Sandbox or Production environments. It is expected to be wired on for use late in the second quarter of 2017. Ultimately, specifying product identifiers through the NameValueList container will replace the process of specifying product identifiers through the EAN, ISBN, or UPC fields.
965
2016-04-22
  • ProductListingDetails.ProductID (deprecated): This field is being deprecated. Seller should use the ProductReferenceID field instead, and pass in the eBay Product ID (ePID) for the product.
959
2016-03-11
  • ItemCompatabilityType (modified): Added the ability to accept eBay Product ID (ePID) numbers in the DE and UK eBay sites to specify parts compatibility for motorcycles (in DE, scooter parts compatibility is also supported).
947
2015-10-29
  • ShippingServiceCodeType (modified): A new enumeration value, FlatRateFreight, enables sellers to offer free or flat rate freight shipping on listings shipped within the United States. The seller negotiates the actual shipping cost with the freight carrier separately from the checkout process, so the sale can be completed quickly.
945
2015-10-15
  • BuyerPaymentMethodCodeType (modified): Sellers can no longer specify Moneybookers, ProPay, or Paymate as values in a PaymentMethods field. If any of these values are used, the listing will be rejected.
941
2015-09-18
  • ProductListingDetails.IncludePrefillItemInformation (deprecated): This field has been deprecated. Use the IncludeeBayProductDetails field in its place.
939
2015-09-04
  • ProductListingDetails.IncludeeBayProductDetails (added): This boolean field controls whether or not an eBay catalog product is used to help create or revise an item listing. For this field to have an effect, the user must specify a product ID value through the ProductListingDetails container, and eBay must be able to match the product in the listing to a product in the eBay catalog.
933
2015-07-24
  • Item.eBayPlusEligible (added): This boolean value indicates whether an item is eligible to be listed under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Currently available only in Germany.
  • Item.eBayPlus (added): This new field accepts a boolean value that indicates whether the eBay Plus program is being offered on an item listing. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Currently available only in Germany.
  • Item.DigitalGoodInfo (added): This container is used to designate the listing as a digital gift card listing. The listing category must support digitial gift card listings in order for this container to have an affect.
931
2015-07-10
  • NameValueList.Name (modified): The maximum length was increased to 65.
  • NameValueList.Value (modified): The maximum length was increased to 65.
923
2015-05-15
  • PictureURL (modified): Added the ability to upload PNG images and support for https:// URLs.
  • ProductListingDetails.GTIN (deprecated): This field was deprecated. Other Product ID fields should be used instead.
  • ProductListingDetails.ListIfNoProduct (deprecated): This field was deprecated. There are no other alternatives for this field.
921
2015-05-01
  • NameValueList.Name (modified): If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
  • Item.ProductListingDetails (modified): For a multiple-variation listing, the product identifier (EAN, ISBN or UPC) for each product variation should be specified in the Variation.VariationProductListingDetails container instead.
  • BrandMPN.Brand (modified): Decreased maximum length of string value to 65 characters. If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand can be specified at the item level (this field and the ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
  • BrandMPN.MPN (modified): Decreased maximum length of string value to 65 characters. If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand can be specified at the item level (this field and the ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
  • ProductListingDetails.EAN (modified): If creating a multiple-variation listing, the EAN of each product variation should be specified in the VariationProductListingDetails container instead. If the listing is being posted to a category that expects an EAN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response.
  • ProductListingDetails.GTIN (modified): Marked for deprecation.
  • ProductListingDetails.ISBN (modified): If creating a multiple-variation listing, the ISBN of each product variation should be specified in the VariationProductListingDetails container instead. If the listing is being posted to a category that expects an ISBN value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response.
  • ProductListingDetails.ListIfNoProduct (modified): Marked for deprecation.
  • ProductListingDetails.UPC (modified): If creating a multiple-variation listing, the UPC of each product variation should be specified in the VariationProductListingDetails container instead. If the listing is being posted to a category that expects an UPC value, but one doesn't exist for the product, the seller must pass in the text that can be found in the ProductDetails.ProductIdentifierUnavailableText field of the GeteBayDetails response.
  • VariationProductListingDetails (added): New type added to allow sellers to specify EAN, ISBN, or UPC values for product variations in a multiple-variation listing.
917
2015-04-03
  • ListingRecommendations.Recommendation.Type (modified): 'FnF' (Fast 'N Free shipping) added as a listing recommendation type. The 'FnF' recommendation advises sellers to add expedited shipping (same-day shipping or 1-day handling time) and/or a free shipping service option. The 'Category', 'ConditionDescription', 'GSP', and 'UPC' listing recommendation types were disabled and will no longer be returned in the response.
905
2015-01-09
  • DiscountPriceInfoType (modified): The Strikethrough Pricing Feature is now available for more sites. These sites include US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain.
  • CalculatedShippingRateType (modified): Data fields in this container used to specify shipping package weight and dimensions should no longer be used. Instead, the equivalents fields in ShippingPackageDetailsType should be used.
899
2014-11-04
  • BuyerPaymentMethodCodeType (modified): 'QIWI' added as enumeration value. This payment method can only be specified on the US site and is only applicable to Russian buyers.
897
2014-10-21
  • SiteCodeType (modified): 'Russia' added as enumeration value to support selling on the new Russia site.
895
2014-10-07
  • Item.OutOfStockControl (deprecated): In this release, the Item.OutOfStockControl field was deprecated and was replaced by SetUserPreferences.OutOfStockControlPreference. For more information, see Using the Out-of-Stock Feature.
889
2014-08-26
  • PictureURL (modified): Added the ability to pass in up to 12 self-hosted or 12 ESP images at once at no cost. For US and Canada Motors sites for vehicle listings you can upload up to 24 pictures at no cost.
885
2014-07-29
  • Recommendation.Metadata (added): New container that is returned when price guidance information is requested/available for the item. The data in this container includes the minimum and maximum recommended prices for the item, which are based on recent sales of similar items. A Metadata container is returned for each price guidance parameter that is applicable/available for the pricing recommendation.
879
2014-06-17
  • PickupInStoreDetails.EligibleForPickupDropOff (added): Use this boolean field to enable the listing for the "Click and Collect" feature.
877
2014-06-03
  • ReturnPolicyType.ExtendedHolidayReturns (added): Use this boolean field to specify your policy for holiday returns. A seller can offer an item with an extended holiday returns period, which overrides the seller's existing return policy period for the item during the winter holidays. Buyers who purchase the item from early November through the end of the year have until the end of January to return it. ExtendedHolidayReturns is False by default.
869
2014-04-08
  • CalculatedShippingRate.WeightMajor, CalculatedShippingRate.WeightMinor (doc change): The description clarifies that WeightMajor and WeightMinor are required on input not only for calculated shipping, but also in one case for flat rate shipping: when shipping rate tables are specified and the shipping rate table uses weight surcharges. No other calculated shipping fields are required in this case.
865
2013-03-11
  • ListingRecommendations.Recommendation.Type (modified): 'Price' and 'Title' added as listing recommendation types. The 'Price' recommendation advises sellers on optimal prices for their items based on the sale history of similar items on eBay. The 'Title' recommendation advises sellers on keywords or Item Specifics that could be added to their listing titles in order to get better search or sale results.
861
2014-02-11
  • StorefrontType.StoreCategoryName (added): This field is used by eBay Stores sellers to list an item under one of their custom categories using the category name.
  • StorefrontType.StoreCategory2Name (added): This field is used by eBay Stores sellers to list an item under a second category using one of their custom categories names.
859
2014-01-28
  • Item.OutOfStockControl (modified): OutOfStockControl can now be used with BestOffer.
851
2013-11-19
  • Item.ConditionDescription (modified): ConditionDescription is now supported on the following eBay sites: US and US Motors (0, 100), CA (2), CAFR (210), UK (3), AU (15), AT (16), BEFR (23), BENL (123) FR (71), DE (77), IT (101), NL (146), ES (186), CH (193), IE (205), PL (212).
849
2013-11-05
  • Item.ConditionDescription (modified): In addition to the eBay US and US eBay Motors (0), UK (3), CA (2), CAFR (210) and AU (15) sites, ConditionDescription is now supported on the AT (16), FR (71), IT (101) and ES (186) sites.
  • Item.PaymentMethods (modified): 'CreditCard' and 'DirectDebit' added as acceptable buyer payment methods. These two values should only be used for eBay Now-enabled listings.
  • ShippingServiceOptions.ShippingService (modified): 'eBayNowImmediateDelivery' added as an acceptable value in the ShippingService field. This value should only be used for eBay Now-enabled listings.
845
2013-10-08
  • ListingRecommendations.Recommendation.Type (modified): 'Category' and 'ConditionDescription' added as listing recommendation types. One to three 'Category' listing recommendation containers will be returned in the response if eBay determines (by analyzing Item Title) that the item has been miscategorized. Each 'Category' container will provide a Category ID of an eBay category that is better suited for the item. One 'ConditionDescription' listing recommendation container will be returned in the response if the item is a used item (ConditionID value greater than 1500) that would benefit if a Condition Description was included in the listing.
843
2013-09-24
  • RateTableDetails.DomesticRateTable (modified): In addition to the eBay US, UK, DE and Motors Parts and Accessories sites, sellers listing on the eBay AU site can now configure domestic shipping rate tables in My eBay Shipping Preferences. In a domestic rate table, a seller can specify an alternative flat shipping rate for each shipping service category, in each of several domestic regions. Use the DomesticRateTable field to specify the domestic rate table to use for a listing.
841
2013-09-19
  • Item.ShippingServiceCostOverrideList (added): This container is used when the seller wants to override the flat shipping costs for all domestic and/or all international shipping services defined in the Business Policies shipping profile referenced in the AddFixedPriceItem call.
  • Item.eBayNowEligible (added): This boolean field is used to enable the listing for eBay Now delivery. A seller must be eligible for the eBay Now delivery feature to list an item that is eligible for eBay Now delivery.
831
2013-07-03
  • Item.PickupInStoreDetails (added): A new container that is used to enable a multi-quantity, fixed-price listing with the In-Store Pickup option. If an eligible seller/merchant enables the In-Store Pickup option, the buyer of the item will have the option of picking up that item at one of the merchant's retail locations at no charge. Besides including and setting the EligibleForPickupInStore flag to 'true', there are additional requirements that the seller must follow when listing an In-Store Pickup item. These requirements are discussed in the description of the EligibleForPickupInStore field.
829
2013-06-19
  • ReturnPolicy.RefundOption (modified): A new 'MoneyBackOrReplacement' value is now supported. This value should be used by a seller opted in to eBay-managed returns who wants to give buyers the choice of receiving a refund for a returned item, or receiving a replacement item.
825
2013-05-22
  • ReturnPolicy.ReturnsWithinOption (modified): A new 'Months_1' value is now supported. This value indicates a one-month return policy.
823
2013-05-08
  • Item.OutOfStockControl (added): Flag that when set to 'true' hides a listing when the quantity of the item goes to 0 (zero) but keeps the listing alive. While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the 'OutOfStock' Enum would be returned. This is useful for a seller who is waiting for additional stock of an item. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields in an AddFixedPriceItem call) and the listing would appear again.
819
2013-04-10
  • BestOfferDetails.BestOfferEnabled (modified): The BestOfferEnabled flag was enabled for the AddFixedPriceItem and ReviseFixedPriceItem calls. This field allows the seller to enable the Best Offer feature on a fixed-price listing. To verify that a category supports the Best Offer feature, the seller can call GetCategoryFeatures while including 'BestOfferEnabled' as a FeatureID value.
  • ListingDetails.BestOfferAutoAcceptPrice (modified): The BestOfferAutoAcceptPrice field was enabled for the AddFixedPriceItem and ReviseFixedPriceItem calls. If this field is used, any Best Offer on the listing that matches or exceeds the dollar value specified in this field is automatically accepted. To verify that a category supports the Best Offer Auto Accept feature, the seller can call GetCategoryFeatures while including 'BestOfferAutoAcceptEnabled' as a FeatureID value.
  • ListingDetails.MinimumBestOfferPrice (modified): The MinimumBestOfferPrice field was enabled for the AddFixedPriceItem and ReviseFixedPriceItem calls. If this field is used, any Best Offer on the listing that is below the dollar value specified in this field is automatically declined. To verify that a category supports the Best Offer Auto Accept feature, the seller can call GetCategoryFeatures while including 'BestOfferAutoDeclineEnabled' as a FeatureID value.
817
2013-03-27
  • IncludeRecommendations (added): Flag that allows seller to retrieve one or more listing recommendations in the response that will help the seller improve the quality of the listing.
  • ListingRecommendations (added): Container consisting of one or more Recommendation containers, and each Recommendation container provides a message to the seller on how a listing can be improved (for example, add item specifics or use a UPC code) or brought up to standards (Top-rated Seller/Listing and Picture requirements). The IncludeRecommendations flag must be included and set to 'true' in the request for the ListingRecommendations container to be returned.
  • 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).
793
2012-09-26
  • UnitInfo.UnitQuantity (modified): This field's type has changed from int to double.
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.
787
2012-08-15
  • Item.QuantityRestrictionPerBuyer (added): This container is used by the seller to restrict the quantity of items that may be purchased by one buyer during the duration of a fixed-price listing (single or multi-variation).
  • 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.
785
2012-08-01
  • Item.UnitInfo (added): This container includes the UnitType and UnitQuantity fields to provide information about the weight, volume or other quantity measurement of a listed item so buyers can compare per-unit prices. The European Union requires listings for certain types of products to include the price per unit. When a seller supplies the UnitType and UnitQuantity values for an item, eBay calculates and displays the price per unit for that unit type in the item listing.
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
  • ShippingDetails.GlobalShipping (added): To offer shipping using eBay's Global Shipping Program as the default for a listing, sellers set GlobalShipping to True. To avoid offering Global Shipping Program shipping, or to offer a different international shipping service for the listing, sellers set GlobalShipping to False (and optionally specify a different international shipping service).
  • 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.
763
2012-02-29
  • SellerProfiles.SellerPaymentProfile (added): Container used to reference a Business Policies payment policy profile. If a Business Policies payment policy profile is referenced in an AddFixedPriceItem call, the payment policy and values contained in that payment policy profile are used, and the seller will not need to include payment policy values in the call itself. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
  • SellerProfiles.SellerReturnProfile (added): Container used to reference a Business Policies return policy profile. If a Business Policies return policy profile is referenced in an AddFixedPriceItem call, the return policy and values contained in that return policy profile are used, and the seller will not need to include return policy values in the call itself. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
  • SellerProfiles.SellerShippingProfile (added): Container used to reference a Business Policies shipping policy profile. If a Business Policies shipping policy profile is referenced in an AddFixedPriceItem call, the shipping policy and values contained in that shipping policy profile are used, and the seller will not need to include shipping policy values in the call itself. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
  • ShippingPackageDetails (added): If the seller is using calculated shipping, this container is used to specify the weight and dimensions of an item's shipping package. This feature is currently only available for testing in a Sandbox environment and will not be available in Production until May 2012.
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, Item.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.
733
2011-08-03
  • UseRecommendedProduct (added): Lets sellers opt to have eBay list their item using a product from the eBay catalog when the product is a match for the seller's item.
  • ProductSuggestions (added): Returns products from the eBay catalog that match the item details in the request.
729
2011-07-06
  • Item.ThirdPartyCheckout (deprecated): As of July 1, 2011, Third-Party Checkout is no longer supported. If this field is included in the request, the call will fail.
  • Item.ThirdPartyCheckoutIntegration (deprecated): As of July 1, 2011, Third-Party Checkout is no longer supported. If this field is included in the request, the call will fail.
725
2011-06-08
  • Item.ProductListingDetails (modified): eBay now indexes UPC, ISBN, or EAN for search when you pass it in ProductListingDetails, even if a matching catalog product is not found. Therefore, we strongly recommend that you provide one of these values whenever known.
723
2011-05-25
  • DiscountPriceInfo (added): Added the ability to specify and view discount pricing values (DiscountPricingInfo) for an item, which gives the item either a Strike-Through Pricing (STP) or Minimum Advertised Price (MAP) display treatment. This feature is available to qualified sellers (and their associated developers) who participate in the Discount Pricing program. Once qualified, sellers can apply Discount Pricing to both MSKU and Non-MSKU items. STP is available on the US, UK, and DE sites while MAP is available only on the US site.
    This feature will be available mid-Summer, 2011. Sellers should contact their account manager or Customer Service to see if they qualify for the Strike-Through Pricing program. For more information, see Displaying Discount Pricing Information to Buyers.
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.
695
2010-11-10
  • Item.Site (modified): More sites now support AddFixedPriceItem and related calls. See the introduction at the top of the AddFixedPriceItem call page (above).
691
2010-10-13
  • Item.PictureDetails.ExternalPictureURL (added): By late October, 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 eBay Picture Services (EPS). This copy will be used as the picture at the top of the listing. If the copy fails, the original location is used.
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 if either PrimaryCategory or SecondaryCategory is a value category (see ValueCategory in GetCategoryFeatures).
  • Item.Quantity, Item.StartPrice, Item.BuyItNowPrice (doc change): In late October 2010, for the US site, users who are registering as eBay sellers for the first time are subject to seller limits which limit the quantity of items and/or the total listing value of the items. This applies to new sellers, not currently to existing sellers. (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 auctions, the value limits apply to the start price, not the final sale amount.
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
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, LookupAttributeArray, or ItemSpecifics to specify the item's condition when GetCategoryFeatures shows ConditionEnabled=Enabled or Required for the listing's primary category.
657
2010-02-17
  • ExternalProductID.Value (doc change): Value appeared in the AddItem documentation, but not in the AddFixedPriceItem documentation. This has been corrected. Max lengths for strings in ProductListingDetails have been updated.
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., compatibility by application).
639
2009-10-14
  • ScheduleTime (modified): The start time for new, scheduled listings is now randomized within 15-minute intervals. With this change, it is possible that the scheduled start time of your listing will be delayed by up to 15 minutes. Listing end times are modified accordingly. This upgrade affects the following sites:
    AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK
635
2009-09-16
  • ExcludeShipToLocation (added): Sellers can now exclude specific regions and countries from where they will ship items.
  • 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.
  • ReturnPolicy (doc change): This call's documentation has been updated to correctly show the ReturnPolicy node (to match the corresponding AddItem documentation).
627
2009-07-22
  • DiscountReason (added): This response element indicates the nature of any discount realized with the listing.
619
2009-05-27
  • LookupAttribute (modified): Enabled for all catalog-enabled categories that support the notion of a condition (e.g., not Tickets). The name and value must match the attribute name and value defined in GetAttributesCS or GetProductSellingPages.
  • 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.
  • Fee.PromotionalDiscount (added): Users can now discover fee discounts.
615
2008-04-29
  • Variations (added): New node for describing variations in a multi-variation listing.
  • Quantity, StartPrice (modified): Item.Quantity and Item.StartPrice should not be specified for multi-variation listing.
  • (added) Call moved from Merchant Data API to Trading API.
  • Item.Fees.Fee (modified): PromotionalDiscount is added to the Fee container. Although available in the 615 schema, the element will not be returned until version 619.
589
2008-11-29
  • (added) New call in Merchant Data API.
1039
2017-10-17
  • ReturnPolicy.RestockingFeeValueOption (modified): The seller can now use the Percent_20 value to reserve the right to charge a restocking fee percentage for returned items of up to 20 percent (of sale price), but at the seller's discretion, they can also charge less than 20 percent.
  • ShippingDetails.RateTableDetails (modified): Once a seller's account is updated with the new shipping rate tables in My eBay, the seller will be required to use the new DomesticRateTableId and InternationalRateTableId fields, and the DomesticRateTable and InternationalRateTable tags will no longer work. The required IDs for these tables can be retrieved with the getRateTables method of the Account API.
1031
2017-09-01
  • ShippingDetails.InsuranceDetails, ShippingDetails.InternationalInsuranceDetails (deprecated): These two containers and InsuranceDetailsType have been deprecated, as it is no longer possible/applicable for sellers to offer shipping insurance to buyers on any eBay site.
1027
2017-08-04
  • ListingTypeCodeType (modified): The Half enumeration value is being deprecated, as API support for Half.com listings is being deprecated.
1019
2017-06-09
  • RateTableDetails.DomesticRateTableId (added): New field added to support new domestic shipping rate tables. The new shipping rate tables are currently only available on US and Australia sites, but will be coming soon to UK and Germany sites.
  • RateTableDetails.InternationalRateTableId (added): New field added to support new international shipping rate tables. The new shipping rate tables are currently only available on US and Australia sites, but will be coming soon to UK and Germany sites.