eBay Trading APIVersion 965

AddItems

Use this call to define one to five items and list them on the specified eBay site.

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.

AddItems works just like AddItem with the exception that AddItems lets you list up to five items at a time. In the call to AddItems, specify each complete Item definition within a AddItemRequestContainer node. In addition to Item, specify a MessageID value in each AddItemRequestContainer to help you correlate the respective item with the values returned in the response.

For each Item in the request, the response returns a corresponding container that has the ItemID for the new listing, the listing's start and end times, plus the estimated fees for listing the item (not including the Final Value Fee, which cannot be calculated until the item is sold).

For complete details on listing items, refer to the AddItem call.

See:
    Listing an Item
    Listing Items
    Introduction to Pictures in Item Listings
    Listing an Item

See also the reference documentation for these calls:



Input

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

See also Samples.

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

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

<?xml version="1.0" encoding="utf-8"?>
<AddItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <AddItemRequestContainer> AddItemRequestContainerType
    <Item> ItemType
      <ApplicationData> string </ApplicationData>
      <AttributeArray> AttributeArrayType
        <Attribute attributeLabel="string"> AttributeType
          <Value> ValType
            <ValueLiteral> string </ValueLiteral>
          </Value>
          <!-- ... more Value nodes allowed here ... -->
        </Attribute>
        <!-- ... more Attribute nodes allowed here ... -->
      </AttributeArray>
      <AutoPay> boolean </AutoPay>
      <BestOfferDetails> BestOfferDetailsType
        <BestOfferEnabled> boolean </BestOfferEnabled>
      </BestOfferDetails>
      <BuyerRequirementDetails> BuyerRequirementDetailsType
        <LinkedPayPalAccount> boolean </LinkedPayPalAccount>
        <MaximumBuyerPolicyViolations> MaximumBuyerPolicyViolationsType
          <Count> int </Count>
          <Period> PeriodCodeType </Period>
        </MaximumBuyerPolicyViolations>
        <MaximumItemRequirements> MaximumItemRequirementsType
          <MaximumItemCount> int </MaximumItemCount>
          <MinimumFeedbackScore> int </MinimumFeedbackScore>
        </MaximumItemRequirements>
        <MaximumUnpaidItemStrikesInfo> MaximumUnpaidItemStrikesInfoType
          <Count> int </Count>
          <Period> PeriodCodeType </Period>
        </MaximumUnpaidItemStrikesInfo>
        <MinimumFeedbackScore> int </MinimumFeedbackScore>
        <ShipToRegistrationCountry> boolean </ShipToRegistrationCountry>
        <VerifiedUserRequirements> VerifiedUserRequirementsType
          <MinimumFeedbackScore> int </MinimumFeedbackScore>
          <VerifiedUser> boolean </VerifiedUser>
        </VerifiedUserRequirements>
        <ZeroFeedbackScore> boolean </ZeroFeedbackScore>
      </BuyerRequirementDetails>
      <BuyerResponsibleForShipping> boolean </BuyerResponsibleForShipping>
      <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
      <CategoryBasedAttributesPrefill> boolean </CategoryBasedAttributesPrefill>
      <CategoryMappingAllowed> boolean </CategoryMappingAllowed>
      <Charity> CharityType
        <CharityID> string </CharityID>
        <CharityNumber> int </CharityNumber>
        <DonationPercent> float </DonationPercent>
      </Charity>
      <ConditionDescription> string </ConditionDescription>
      <ConditionID> int </ConditionID>
      <Country> CountryCodeType </Country>
      <CrossBorderTrade> string </CrossBorderTrade>
      <!-- ... more CrossBorderTrade values allowed here ... -->
      <Currency> CurrencyCodeType </Currency>
      <Description> string </Description>
      <DigitalGoodInfo> DigitalGoodInfoType
        <DigitalDelivery> boolean </DigitalDelivery>
      </DigitalGoodInfo>
      <DisableBuyerRequirements> boolean </DisableBuyerRequirements>
      <DispatchTimeMax> int </DispatchTimeMax>
      <eBayNowEligible> boolean </eBayNowEligible>
      <eBayPlus> boolean </eBayPlus>
      <ExtendedSellerContactDetails> ExtendedContactDetailsType
        <ClassifiedAdContactByEmailEnabled> boolean </ClassifiedAdContactByEmailEnabled>
        <ContactHoursDetails> ContactHoursDetailsType
          <Hours1AnyTime> boolean </Hours1AnyTime>
          <Hours1Days> DaysCodeType </Hours1Days>
          <Hours1From> time </Hours1From>
          <Hours1To> time </Hours1To>
          <Hours2AnyTime> boolean </Hours2AnyTime>
          <Hours2Days> DaysCodeType </Hours2Days>
          <Hours2From> time </Hours2From>
          <Hours2To> time </Hours2To>
          <TimeZoneID> string </TimeZoneID>
        </ContactHoursDetails>
      </ExtendedSellerContactDetails>
      <GiftIcon> int </GiftIcon>
      <GiftServices> GiftServicesCodeType </GiftServices>
      <!-- ... more GiftServices values allowed here ... -->
      <HitCounter> HitCounterCodeType </HitCounter>
      <IncludeRecommendations> boolean </IncludeRecommendations>
      <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>
      <ListingCheckoutRedirectPreference> ListingCheckoutRedirectPreferenceType
        <ProStoresStoreName> string </ProStoresStoreName>
        <SellerThirdPartyUsername> string </SellerThirdPartyUsername>
      </ListingCheckoutRedirectPreference>
      <ListingDesigner> ListingDesignerType
        <LayoutID> int </LayoutID>
        <OptimalPictureSize> boolean </OptimalPictureSize>
        <ThemeID> int </ThemeID>
      </ListingDesigner>
      <ListingDetails> ListingDetailsType
        <BestOfferAutoAcceptPrice currencyID="CurrencyCodeType"> AmountType (double) </BestOfferAutoAcceptPrice>
        <LocalListingDistance> string </LocalListingDistance>
        <MinimumBestOfferPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumBestOfferPrice>
      </ListingDetails>
      <ListingDuration> token </ListingDuration>
      <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
      <!-- ... more ListingEnhancement values allowed here ... -->
      <ListingSubtype2> ListingSubtypeCodeType </ListingSubtype2>
      <ListingType> ListingTypeCodeType </ListingType>
      <LiveAuction> boolean </LiveAuction>
      <Location> string </Location>
      <LotSize> int </LotSize>
      <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
      <PaymentDetails> PaymentDetailsType
        <DaysToFullPayment> int </DaysToFullPayment>
        <DepositAmount currencyID="CurrencyCodeType"> AmountType (double) </DepositAmount>
        <DepositType> DepositTypeCodeType </DepositType>
        <HoursToDeposit> int </HoursToDeposit>
      </PaymentDetails>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods values allowed here ... -->
      <PayPalEmailAddress> string </PayPalEmailAddress>
      <PickupInStoreDetails> PickupInStoreDetailsType
        <EligibleForPickupDropOff> boolean </EligibleForPickupDropOff>
        <EligibleForPickupInStore> boolean </EligibleForPickupInStore>
      </PickupInStoreDetails>
      <PictureDetails> PictureDetailsType
        <GalleryDuration> token </GalleryDuration>
        <GalleryType> GalleryTypeCodeType </GalleryType>
        <GalleryURL> anyURI </GalleryURL>
        <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
        <PictureURL> anyURI </PictureURL>
        <!-- ... more PictureURL values allowed here ... -->
      </PictureDetails>
      <PostalCode> string </PostalCode>
      <PostCheckoutExperienceEnabled> boolean </PostCheckoutExperienceEnabled>
      <PrimaryCategory> CategoryType
        <CategoryID> string </CategoryID>
      </PrimaryCategory>
      <PrivateListing> boolean </PrivateListing>
      <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>
        <ProductReferenceID> string </ProductReferenceID>
        <ReturnSearchResultOnDuplicates> boolean </ReturnSearchResultOnDuplicates>
        <TicketListingDetails> TicketListingDetailsType
          <EventTitle> string </EventTitle>
          <PrintedDate> string </PrintedDate>
          <PrintedTime> string </PrintedTime>
          <Venue> string </Venue>
        </TicketListingDetails>
        <UPC> string </UPC>
        <UseFirstProduct> boolean </UseFirstProduct>
        <UseStockPhotoURLAsGallery> boolean </UseStockPhotoURLAsGallery>
      </ProductListingDetails>
      <Quantity> int </Quantity>
      <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
      <ReturnPolicy> ReturnPolicyType
        <Description> string </Description>
        <EAN> string </EAN>
        <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>
      <Seller> UserType
        <MotorsDealer> boolean </MotorsDealer>
      </Seller>
      <SellerContactDetails> AddressType
        <CompanyName> string </CompanyName>
        <County> string </County>
        <Phone2AreaOrCityCode> string </Phone2AreaOrCityCode>
        <Phone2CountryCode> CountryCodeType </Phone2CountryCode>
        <Phone2LocalNumber> string </Phone2LocalNumber>
        <PhoneAreaOrCityCode> string </PhoneAreaOrCityCode>
        <PhoneCountryCode> CountryCodeType </PhoneCountryCode>
        <PhoneLocalNumber> string </PhoneLocalNumber>
        <Street> string </Street>
        <Street2> string </Street2>
      </SellerContactDetails>
      <SellerInventoryID> string </SellerInventoryID>
      <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 currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
          <MeasurementUnit> MeasurementSystemCodeType </MeasurementUnit>
          <OriginatingPostalCode> string </OriginatingPostalCode>
          <PackageDepth unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageDepth>
          <PackageLength unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageLength>
          <PackageWidth unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageWidth>
          <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
          <ShippingIrregular> boolean </ShippingIrregular>
          <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
          <WeightMajor unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightMajor>
          <WeightMinor unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightMinor>
        </CalculatedShippingRate>
        <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
        <ExcludeShipToLocation> string </ExcludeShipToLocation>
        <!-- ... more ExcludeShipToLocation values allowed here ... -->
        <GlobalShipping> boolean </GlobalShipping>
        <InsuranceDetails> InsuranceDetailsType
          <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
          <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        </InsuranceDetails>
        <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        <InternationalInsuranceDetails> InsuranceDetailsType
          <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
          <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
        </InternationalInsuranceDetails>
        <InternationalPromotionalShippingDiscount> boolean </InternationalPromotionalShippingDiscount>
        <InternationalShippingDiscountProfileID> string </InternationalShippingDiscountProfileID>
        <InternationalShippingServiceOption> InternationalShippingServiceOptionsType
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShipToLocation> string </ShipToLocation>
          <!-- ... more ShipToLocation values allowed here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
        <PaymentInstructions> string </PaymentInstructions>
        <PromotionalShippingDiscount> boolean </PromotionalShippingDiscount>
        <RateTableDetails> RateTableDetailsType
          <DomesticRateTable> string </DomesticRateTable>
          <InternationalRateTable> string </InternationalRateTable>
        </RateTableDetails>
        <SalesTax> SalesTaxType
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <ShippingDiscountProfileID> string </ShippingDiscountProfileID>
        <ShippingServiceOptions> ShippingServiceOptionsType
          <FreeShipping> boolean </FreeShipping>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
        </ShippingServiceOptions>
        <!-- ... more ShippingServiceOptions nodes allowed here ... -->
        <ShippingType> ShippingTypeCodeType </ShippingType>
      </ShippingDetails>
      <ShippingPackageDetails> ShipPackageDetailsType
        <MeasurementUnit> MeasurementSystemCodeType </MeasurementUnit>
        <PackageDepth unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageDepth>
        <PackageLength unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageLength>
        <PackageWidth unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </PackageWidth>
        <ShippingIrregular> boolean </ShippingIrregular>
        <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
        <WeightMajor unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightMajor>
        <WeightMinor unit="token" measurementSystem="MeasurementSystemCodeType"> MeasureType (decimal) </WeightMinor>
      </ShippingPackageDetails>
      <ShippingServiceCostOverrideList> ShippingServiceCostOverrideListType
        <ShippingServiceCostOverride> ShippingServiceCostOverrideType
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShippingServiceType> ShippingServiceType </ShippingServiceType>
          <ShippingSurcharge currencyID="CurrencyCodeType"> 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>
      <SkypeContactOption> SkypeContactOptionCodeType </SkypeContactOption>
      <!-- ... more SkypeContactOption values allowed here ... -->
      <SkypeEnabled> boolean </SkypeEnabled>
      <SkypeID> string </SkypeID>
      <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
      <Storefront> StorefrontType
        <StoreCategory2ID> long </StoreCategory2ID>
        <StoreCategory2Name> string </StoreCategory2Name>
        <StoreCategoryID> long </StoreCategoryID>
        <StoreCategoryName> string </StoreCategoryName>
      </Storefront>
      <SubTitle> string </SubTitle>
      <TaxCategory> string </TaxCategory>
      <ThirdPartyCheckout> boolean </ThirdPartyCheckout>
      <ThirdPartyCheckoutIntegration> boolean </ThirdPartyCheckoutIntegration>
      <Title> string </Title>
      <UseTaxTable> boolean </UseTaxTable>
      <UUID> UUIDType (string) </UUID>
      <VATDetails> VATDetailsType
        <BusinessSeller> boolean </BusinessSeller>
        <RestrictedToBusiness> boolean </RestrictedToBusiness>
        <VATPercent> float </VATPercent>
      </VATDetails>
      <VIN> string </VIN>
      <VRM> string </VRM>
    </Item>
    <MessageID> string </MessageID>
  </AddItemRequestContainer>
  <!-- ... more AddItemRequestContainer nodes allowed here ... -->
  <!-- Standard Input Fields -->
  <ErrorHandling> ErrorHandlingCodeType </ErrorHandling>
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</AddItemsRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
AddItemRequestContainer AddItemRequestContainerType Required,
repeatable: [1..5]
Defines a single item to be listed on eBay. This container is similar to an AddItem request. Up to five of these containers can be included in one AddItems request.
AddItemRequestContainer.Item ItemType Required Container holding all values that define a new listing. One Item container is required for each AddItemRequestContainer.
AddItemRequestContainer.Item
  .ApplicationData
string Optional Returns custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField.

Not applicable to Half.com, use SellerInventoryID instead.
Max length: 32.
AddItemRequestContainer.Item
  .AttributeArray
AttributeArrayType Optional Used to specify the item condition in AddItem. Only applicable to Half.com (not eBay listings). You can revise this property for Half.com listings. For Half.com, AddItem does not use the same Attributes format as eBay's Item Specifics.

Not returned in GetItem.

See Half.com.

AddItemRequestContainer.Item
  .AttributeArray.Attribute
AttributeType Conditional,
repeatable: [0..*]
This container is used by the seller in an Add call to specify one or more attribute values for a Half.com item. This container can also be used in a ReviseItem call to add, remove, or modify an Half.com item attribute or its value.

This field is not applicable for any listings on an eBay site.
AddItemRequestContainer.Item
  .AttributeArray.Attribute
  [ attribute attributeLabel ]
string Conditional This container is used by the seller in an Add call to specify one or more attribute values for a Half.com item. This container can also be used in a ReviseItem call to add, remove, or modify an Half.com item attribute or its value.

This field is not applicable for any listings on an eBay site.
AddItemRequestContainer.Item
  .AttributeArray.Attribute
  .Value
ValType Conditional,
repeatable: [0..*]
A value the seller selected or entered for the Half.com item attribute. At least one value is required for each attribute that you specify. Some attributes can have multiple values.

If using an Add or Revise call to add or revise a Half.com item, this field is required.
AddItemRequestContainer.Item
  .AttributeArray.Attribute
  .Value.ValueLiteral
string Conditional For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests.

AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings.
Max length: see description.
AddItemRequestContainer.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). If true, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

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

AutoPay can be enabled for ThirdPartyCheckout apps that have been approved by eBay. For a non-Immediate Payment listing, the AutoPay flag is not required.

Not applicable to Half.com.
Default: false.

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

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

For GetItem and other calls that retrieve item data, this container will include the status (GetMyeBayBuying only) and dollar amount of the latest Best Offer on a fixed-price listing, and the number of Best Offers received for the fixed-price listing.

Not applicable to Half.com.
AddItemRequestContainer.Item
  .BestOfferDetails
  .BestOfferEnabled
boolean Optional This field indicates whether or not the Best Offer feature is enabled for this item. A seller of a fixed-price item (in a category for which Best Offer is also enabled) can opt that item into the Best Offer feature. This feature enables a buyer to make a lower-priced binding offer on that item.

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

Note: Some large merchant accounts are enabled to revise this field through a Revise call even within 12 hours of the listing's scheduled end time. The exception to this rule is that Best Offers can not be disabled if the listing has any completed or pending Best Offers.
AddItemRequestContainer.Item
  .BuyerRequirementDetails
BuyerRequirementDetailsType Optional When this container is present in an AddItem or AddFixedPriceItem call, all buyer requirements for the resulting listing are set by this container. Furthermore, individual buyer requirements cannot be modified or added when including this container in a ReviseItem call. The ReviseItem call needs to provide the entire set of buyer requirements to modify or add any of the requirements.

Unless otherwise specified, most buyer requirements are only returned if the caller is the seller. All global My eBay Buyer Requirements are overridden by the contents of this container. This means that buyer requirements set in My eBay cannot be combined with buyer requirements included in this container.

Not applicable to Half.com.

See Selecting Buyer Requirements (eBay help).

AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.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.)
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .BuyerRequirementDetails
  .MaximumItemRequirements
  .MaximumItemCount
int Conditional This field is conditionally required if the MaximumItemRequirements container is used.

The value of this field specifies the maximum number of items a prospective buyer can purchase from the seller during a 10-day period. The prospective buyer will be blocked from bidding/buying once this value is reached.

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.

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

AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .BuyerResponsibleForShipping
boolean Optional Applicable for listings in vehicle categories on the US eBay Motors site and eBay Canada site. (No business effect if specified for other categories or sites, as the Web site will not display the information to buyers.)
  • If true, the buyer is responsible for vehicle pickup or shipping.
  • If false, specify vehicle shipping arrangements in the item description. (The description can also include vehicle shipping arrangements when this value is true.)
If the item has bids or ends within 12 hours, you cannot modify this flag. Do not specify ShippingDetails.ShippingServiceOptions for vehicle listings.

If true and the listing is on the US eBay Motors site, and you want the listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA.

If true and the listing is on the eBay Canada site, and you want your listing to be visible on the US eBay Motors site, set Item.ShipToLocations to US.

Not applicable to Half.com.
Default: true.
AddItemRequestContainer.Item
  .BuyItNowPrice
AmountType (double) Optional This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits.
AddItemRequestContainer.Item
  .BuyItNowPrice
  [ attribute currencyID ]
CurrencyCodeType Optional This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately.

By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored.

The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option.

Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item.

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

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.Item
  .CategoryBasedAttributesPrefill
boolean Optional Allows eBay to auto-fill some of a listing's Item Specifics (attribute) values based on the listing's category (or categories). Auto-filling attributes based on a category is not the same as using Pre-filled Item 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 attributes.
Not applicable to Half.com.
AddItemRequestContainer.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.

Not applicable to Half.com.

See Maintaining Category Data.

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

AddItemRequestContainer.Item
  .Charity.CharityID
string Conditional A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when the listing has Giving Works items.
AddItemRequestContainer.Item
  .Charity.CharityNumber
int Optional A unique identifier assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. This value can contain up to 10 digits. This value is superseded by CharityID.
AddItemRequestContainer.Item
  .Charity.DonationPercent
float Conditional The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. DonationPercent is required input when the listing has Giving Works items.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ConditionID
int Conditional The numeric ID (e.g., 1000) for the item condition. Sellers should also clarify the item's condition in their own item description.

For the AddItem family of calls: Use GetCategoryFeatures for details about which categories support (or require) ConditionID, plus policies and help on choosing the right condition for the item (to reduce disputes).

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

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

Some categories may support ConditionID but also define conditions in GetCategorySpecifics. Even if a category still seems to support passing item condition in LookupAttributeArray, or ItemSpecifics fields, you should use ConditionID instead.

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

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

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

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

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

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

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

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

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

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

AddItemRequestContainer.Item
  .Country
CountryCodeType Required This 2-digit enumeration value defines the country under which the seller is registered. 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 call, this field is required.

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

AddItemRequestContainer.Item
  .Currency
CurrencyCodeType Required In an Add/Revise/Relist call, this required 3-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.

AddItemRequestContainer.Item
  .Description
string Conditional The seller's description of the item. In listing requests, you can submit your description using CDATA if you want to use HTML or XML-reserved characters in the description. An error will occur if this field contains malicious JavaScript content. (For related eBay policy, see HTML and JavaScript policy.)

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: http://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 ID 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.

AddItemRequestContainer.Item
  .DigitalGoodInfo
DigitalGoodInfoType Optional Note: This field was enabled with version 935. For those using versions older than 935, this field will not be available for use in the listing calls, nor returned in GetItem.
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.
AddItemRequestContainer.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).
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .DispatchTimeMax
int Conditional Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. This time does not include the shipping time (the carrier's transit time).

For 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

AddItemRequestContainer.Item
  .eBayNowEligible
boolean Conditional Note: eBay Now has been officially retired in all US locations, so this field no longer is 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.
AddItemRequestContainer.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).

See Offering eBay Plus for more details.

AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
ExtendedContactDetailsType Optional Extended contact information for sellers using the Classified Ad format. Specifies the days and hours when the seller can be contacted. To remove seller contact information when revising or relisting an item, use DeletedField.
AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ClassifiedAdContactByEmailEnabled
boolean Optional Returned for classified ads to indicate whether contact by email is enabled. In the pay-per-lead feature, which will be available in upcoming months on the US site, this field will specify whether potential buyers can email the seller after viewing a pay-per-lead listing.
AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
ContactHoursDetailsType Optional All fields related to contact hours including time ranges and user-designated time zone.
AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours1AnyTime
boolean Optional Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours1Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours1From and Hours1To will be ignored. In the case of this field being false, the values provided Hours1From and Hours1To will be considered.
AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours1Days
DaysCodeType Optional Indicates the range of days for which the primary contact hours specified by Hours1AnyTime or Hours1From and Hours1To apply. If a value of None is provided for this field, the values provided for Hours1AnyTime, Hours1From, Hours1To are ignored.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
EveryDay
(in/out) Seller can be contacted any day during the specified contact hours.
None
(in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored.
Weekdays
(in/out) Seller can be contacted Monday through Friday during the specified contact hours.
Weekends
(in/out) Seller can be contacted Saturday or Sunday during the specified contact hours.

AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours1From
time Optional Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails.Hours1To
time Optional Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours2AnyTime
boolean Optional Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours2Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours2From and Hours2To will be ignored. In the case of this field being false, the values provided Hours2From and Hours2To will be considered.
AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours2Days
DaysCodeType Optional Indicates the range of days for which the secondary contact hours specified by Hours2AnyTime or Hours2From and Hours2To apply. If a value of None is provided for this field, the values provided for Hours2AnyTime, Hours2From, Hours2To are ignored.
Note: You cannot set Hours2Days to EveryDay. If Hours1Days is set to EveryDay, secondary contact hours do not apply. Hours2Days cannot be set to the same value as Hours1Days.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
EveryDay
(in/out) Seller can be contacted any day during the specified contact hours.
None
(in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored.
Weekdays
(in/out) Seller can be contacted Monday through Friday during the specified contact hours.
Weekends
(in/out) Seller can be contacted Saturday or Sunday during the specified contact hours.

AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .Hours2From
time Optional Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours2Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails.Hours2To
time Optional Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
AddItemRequestContainer.Item
  .ExtendedSellerContactDetails
  .ContactHoursDetails
  .TimeZoneID
string Optional Indicates the local time zone of the values provided for Hours1From/Hours1To and Hours2From/Hours2To. If you specify a contact hours time range with Hours1From and Hours1To, you must provide a local time zone. To retrieve a complete list of the TimeZoneID values supported by eBay, call GeteBayDetails with DetailName set to TimeZoneDetails.
AddItemRequestContainer.Item
  .GiftIcon
int Conditional If true, a generic gift icon displays next the listing's title in search and browse pages. GiftIcon must be set to be able to use GiftServices options. Note that one/zero are returned instead of true/false.
AddItemRequestContainer.Item
  .GiftServices
GiftServicesCodeType Optional,
repeatable: [0..*]
This field will be used for optional gift services that the seller can offer if the buyer chooses to purchase the item as a gift.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
GiftExpressShipping
(in/out) The seller is offering to ship the item via an express shipping method as explained in the item description.
GiftShipToRecipient
(in/out) The seller is offering to ship to the gift recipient (instead of to the buyer) after payment clears.
GiftWrap
(in/out) The seller is offering to wrap the item (and optionally include a card) as explained in the item description.

AddItemRequestContainer.Item
  .HitCounter
HitCounterCodeType Optional Indicates whether an optional hit counter is displayed on the item's listing page and, if so, what type. See HitCounterCodeType for specific values.

Not applicable to Half.com.

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

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

AddItemRequestContainer.Item
  .ItemCompatibilityList
  .Compatibility.NameValueList
  .Name
string Optional A name in a name/value pair.

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

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

For GetCategorySpecifics: 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.
AddItemRequestContainer.Item
  .ItemCompatibilityList
  .Compatibility.NameValueList
  .Value
string Optional,
repeatable: [0..*]
A value associated with the name.

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

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

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

For GetCategorySpecifics: 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.
AddItemRequestContainer.Item
  .ItemSpecifics
NameValueListArrayType Optional A list of Item Specific name and value pairs that the seller specified for the item.

In the AddItem family of calls, use this for specifying custom Item Specifics.

To retrieve recommended Item Specifics, use GetCategorySpecifics.

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

For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add Item Specifics. If the listing has bids but ends in more than 12 hours, you cannot change existing Item Specifics, but you can add Item Specifics that were not previously specified.

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

Note: To specify an item's condition, use the ConditionID field instead of a condition item specific. Use GetCategoryFeatures to see which categories support ConditionID and to get a list of valid condition IDs. (If you specify ConditionID and you also specify Condition as a custom item specific, eBay drops the condition item specific.)

See Working with Custom Item Specifics.

AddItemRequestContainer.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
AddItemRequestContainer.Item
  .ItemSpecifics.NameValueList
  .Name
string Optional A name in a name/value pair.

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

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

For GetCategorySpecifics: 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.
AddItemRequestContainer.Item
  .ItemSpecifics.NameValueList
  .Value
string Optional,
repeatable: [0..*]
A value associated with the name.

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

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

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

For GetCategorySpecifics: 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.
AddItemRequestContainer.Item
  .ListingCheckoutRedirectPreference
ListingCheckoutRedirectPreferenceType Conditional ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if ThirdPartyCheckout is true. If not set (and ThirdPartyCheckout is true), third-party checkout is redirected to the listing application.
AddItemRequestContainer.Item
  .ListingCheckoutRedirectPreference
  .ProStoresStoreName
string Conditional The name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.
AddItemRequestContainer.Item
  .ListingCheckoutRedirectPreference
  .SellerThirdPartyUsername
string Conditional The user name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField.
Max length: 200.
AddItemRequestContainer.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.

Not applicable to Half.com.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ListingDesigner
  .OptimalPictureSize
boolean Optional If true, indicates that the item's picture will be enlarged to fit description of the item.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ListingDetails
ListingDetailsType Optional Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria.

Not applicable to Half.com.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ListingDetails
  .BestOfferAutoAcceptPrice
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ListingDetails
  .MinimumBestOfferPrice
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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.

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

See:
    GetCategoryFeatures
    Fees per Site



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

Not applicable to Half.com.

Applicable values: See ListingEnhancement.
AddItemRequestContainer.Item
  .ListingSubtype2
ListingSubtypeCodeType Optional Indicates a specific type of lead generation format listing, such as classified ad or local market best offer listing. Only applicable when ListingType = LeadGeneration.

Note: ListingSubtype2 replaces the deprecated ListingSubtype field. If both are specified in a request, ListingSubtype2 takes precedence.

Applicable values:

ClassifiedAd
(in/out) General classified ad listing subtype.

Note: This value indicates a classified ad (or digital download) listing on ebay.com websites, not on ebayclassifieds.com. The ebayclassifieds.com site is not supported by the Trading API. For information about other differences between these two sites, see Advertising with classified ads on eBay and eBay Classifieds.
CustomCode
(in/out) Reserved for internal or future use
LocalMarketBestOfferOnly
(in/out) General LocalMarketBestOfferOnly listing subtype.

See:
    About Local Market Listings
    Advertising with Classified Ads

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

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

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

The FixedPriceItem listing format has replaced the StoresFixedPrice listing format, and the StoresFixedPrice format has been deprecated. Currently, AddItem and AddFixedPriceItem accept either FixedPriceItem or StoresFixedPrice as listing formats, but the item will be displayed as FixedPriceItem on the site and in search results. GetItem and other Get calls will return the format you originally used in the request. Therefore, the preferred format is FixedPriceItem.

As part of the merge of the StoresFixedPrice and FixedPriceItem formats, the start price of all new FixedPriceItems must be 99 cents or greater.

Applicable values: See ListingType.

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

AddItemRequestContainer.Item
  .LiveAuction
boolean Conditional This field must be included and set to true if the listing will be a part of a Live Auction. This boolean field is returned as true in GetItem if the listing is part of a Live Auction. See the eBay Live Auctions home page for more information about Live Auctions on eBay.com.
AddItemRequestContainer.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.

Also applicable as input to AddItem and related calls when you list items to Half.com.
Max length: 45.
AddItemRequestContainer.Item
  .LotSize
int Optional A lot is a set of two or more similar items included in a single listing that must be purchased together in a single order line item. The Item.LotSize value is the number of items in the lot. This field is required if two or more items are including in one listing.

Lots can be used for auction-style and fixed-price listings. Lot items can be listed only in lot-enabled categories. Call GetCategories to determine if a category supports lots. If the returned CategoryArray.Category.LSD (LotSize Disabled) value is true, the category does not support lots.

Not applicable to Half.com.
Max: 100000.
AddItemRequestContainer.Item
  .MotorsGermanySearchable
boolean Optional Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany motor vehicle listings only.

If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site.
AddItemRequestContainer.Item
  .PaymentDetails
PaymentDetailsType Optional This container is used in an Add/Revise/Relist call if the seller is selling a motor vehicle, and is requiring an initial deposit on that vehicle. This container is only applicable for motor vehicle listings.

This container will only be returned in Get calls for motor vehicle listings where an initial deposit is required for that vehicle.

See Listing US and CA eBay Motors Items.

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

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

Min: 3. Max: 14. Default: 7.
AddItemRequestContainer.Item
  .PaymentDetails.DepositAmount
AmountType (double) Conditional This dollar value indicates the amount of the deposit that a buyer must make on a purchased motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00.

If not specified, this value defaults to '0.0'. If the seller is requiring that the buyer put down a deposit on the vehicle, the seller must include and set the DepositType field to OtherMethod and specify an HoursToDeposit value. If specified, then also specify HoursToDeposit

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

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

For ReviseItem and related calls: If the listing has no bids, the seller can add or lower a deposit; and they can increase the deposit if the listing doesn't require Immediate Payment. The seller can also remove the Immediate Payment option (if any). If the listing has bids, the seller can only lower an existing deposit; but not add or increase a deposit. The seller can't remove Immediate Payment when a listing with a deposit has bids.
Min: 0.0. Max: 2000.0. Default: 0.0.
AddItemRequestContainer.Item
  .PaymentDetails.DepositAmount
  [ attribute currencyID ]
CurrencyCodeType Optional This dollar value indicates the amount of the deposit that a buyer must make on a purchased motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00.

If not specified, this value defaults to '0.0'. If the seller is requiring that the buyer put down a deposit on the vehicle, the seller must include and set the DepositType field to OtherMethod and specify an HoursToDeposit value. If specified, then also specify HoursToDeposit

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

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

For ReviseItem and related calls: If the listing has no bids, the seller can add or lower a deposit; and they can increase the deposit if the listing doesn't require Immediate Payment. The seller can also remove the Immediate Payment option (if any). If the listing has bids, the seller can only lower an existing deposit; but not add or increase a deposit. The seller can't remove Immediate Payment when a listing with a deposit has bids.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.Item
  .PaymentDetails.DepositType
DepositTypeCodeType Conditional This field applies to eBay Motors (US and CA) vehicles listings. If the seller is requiring that the buyer make a deposit on the vehicle, the DepositType value must be included and set to OtherMethod. Otherwise, specify None (or don't pass in DepositType).
Default: None.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
FastDeposit
(in/out) No longer used.
None
(in/out) No deposit needed.
OtherMethod
(in/out) Pay the deposit using PayPal, and then use any of the other specified payment methods to pay the balance.

AddItemRequestContainer.Item
  .PaymentDetails.HoursToDeposit
int Optional This integer value indicates the number of hours that a buyer has (after he/she commits to buy) to make a deposit to the seller as a down payment on a motor vehicle. Valid values: 24, 48 (default), and 72.

The deposit amount is specified in the DepositAmount field. If not specified, the DepositAmount value defaults to 0.0, in which case, a deposit on the vehicle is not required.
Min: 24. Max: 72. Default: 48.
AddItemRequestContainer.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 eBay Real Estate ad format listings, Classified Ad format listings, or Half.com.

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

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

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

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

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

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

See:
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences

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

In addition to setting the EligibleForPickupDropOff boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing:
  • Have inventory for the product at one or more physical stores tied to the merchant's account.
  • Set an immediate payment requirement on the item. The immediate payment feature requires the seller to:
    • Include the Item.AutoPay flag in the call request and set its value to 'true';
    • Include only one Item.PaymentMethods field in the call request and set its value to 'PayPal';
    • Include a valid PayPal payment address in the Item.PayPalEmailAddress field.
When a UK merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item.
Default: false.
AddItemRequestContainer.Item
  .PickupInStoreDetails
  .EligibleForPickupInStore
boolean Conditional This field is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup. To enable the listing for In-Store Pickup, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.

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

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

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.
Default: false.
AddItemRequestContainer.Item
  .PictureDetails
PictureDetailsType Optional Contains the data for a picture associated with an item.

Not applicable to Half.com.

See Introduction to Pictures in Item Listings.

AddItemRequestContainer.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
AddItemRequestContainer.Item
  .PictureDetails.GalleryType
GalleryTypeCodeType Conditional 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.

Do not use the GalleryURL field to specify the Gallery image. The Gallery image will be the first PictureURL in the array of PictureURL fields.

When revising a listing, you cannot remove Plus or Featured, however you can upgrade to Featured. When you upgrade, 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.

AddItemRequestContainer.Item
  .PictureDetails.GalleryURL
anyURI Conditional This field is used internally only. The Gallery image is always the first PictureURL passed in and this field is set to that value.
Max length: 1024.

See:
    Introduction to Pictures in Item Listings
    (ReviseItem) DeletedField

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

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

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

Applicable values:

CustomCode
(in/out) Reserved for internal 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

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

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

Not applicable to Half.com.
AddItemRequestContainer.Item
  .PostCheckoutExperienceEnabled
boolean Conditional This boolean field indicates whether or not the listing is enabled with the Post-Checkout Experience.
AddItemRequestContainer.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 and GetCategoryFeatures to determine valid 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. See GalleryType for information about fees that could be charged if you change the category in these cases.

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

Not applicable to Half.com.

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

If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. For the eBay US site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details.

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

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

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

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

Note: In a GetItem call, the Half.com category ID is returned in the PrimaryCategory container, and not the eBay category. The Half.com category ID is not necessarily returned in GetCategories call.
Max length: 10.
AddItemRequestContainer.Item
  .PrivateListing
boolean Optional If true, designates the listing as private. When you create a private listing, a buyer's User ID will not appear in the listing or in the listing's bid history. Sellers may want to use this option when they believe that potential bidders for a listing would not want their User IDs disclosed to others.

Not applicable to Half.com.
AddItemRequestContainer.Item
  .PrivateNotes
string Optional A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible 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).

Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
AddItemRequestContainer.Item
  .ProductListingDetails
ProductListingDetailsType Optional Specifies stock product information to include in a listing. Only applicable when listing items with product details.

As ProductID and ProductReferenceID are defined by eBay, they provide the most reliable means to identify a product. If you use ISBN, UPC, EAN, BrandMPN, and/or TicketListingDetails, eBay attempts to find a matching product on your behalf and use it in the listing.

When you specify ProductListingDetails, you must specify at least one product ID for the listing (ProductID, ProductReferenceID, ISBN, UPC, EAN, BrandMPN, and/or TicketListingDetails). If you specify more than one of these values (such as UPC and BrandMPN), eBay uses the first one that matches a product in eBay's catalog system. (This may be useful if you aren't sure which ID is more likely to result in a match.)

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

Note: As a general rule, the primary category is required. However, if you have trouble finding a catalog-enabled category, you may be able to omit the primary category (except for event tickets). If you do, eBay will attempt to determine an appropriate category based on the product ID (if we find a matching product). When you specify a category that corresponds to the product, your category is used. For ReviseItem and RelistItem only: If a listing includes product details and you change a category, the rules for continuing to include product details depend on whether or not the new category is mapped to a characteristic set associated with the same product ID. When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product ID and you cannot remove existing product data. However, you can change or add preferences such as IncludeStockPhotoURL, UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all catalog data when you revise or relist an item, specify Item.ProductListingDetails in DeletedField and don't pass ProductListingDetails in the request.


Not applicable to Half.com.

See Items and Listings.

AddItemRequestContainer.Item
  .ProductListingDetails
  .BrandMPN
BrandMPNType Conditional Applicable for listing use cases only (not buy-side searching). 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.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ProductListingDetails.EAN
string Conditional Applicable for listing use cases only (not buy-side searching). EAN is a unique 8 or 13 digit identifier that many industries (such as book publishers) use to identify products. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
Max length: 13.
AddItemRequestContainer.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.

Note: Beginning with version 939, this boolean field has essentially replaced the soon-to-be deprecated IncludePrefilledItemInformation boolean field. However, the IncludePrefilledItemInformation boolean field will still work with versions prior to 939 until March 2017.
Default: true.
AddItemRequestContainer.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 (i.e., either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free).

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


Not applicable to Half.com.
Default: true.

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

AddItemRequestContainer.Item
  .ProductListingDetails.ISBN
string Conditional Applicable for listing use cases only (not buy-side searching). ISBN is a unique identifer for books (an international standard). Specify a 10 or 13-character ISBN. If you specify the 13-character ISBN, the value must begin with either 978 pr 979. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
Max length: 13.
AddItemRequestContainer.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.

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

AddItemRequestContainer.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 (/).
AddItemRequestContainer.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.

AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ProductListingDetails.UPC
string Conditional Applicable for listing use cases only (not buy-side searching). UPC is a unique, 12-character identifier that many industries use to identify products.

If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category).
Max length: 12.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ProductListingDetails
  .UseStockPhotoURLAsGallery
boolean Optional If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. When listing an item, IncludeStockPhotoURL must also be true and Item.PictureDetails.GalleryType must be passed in with a value of Gallery or Gallery Featured (but not both). Passing in Item.PictureDetails.GalleryURL takes precedence over UseStockPhotoURLAsGallery. See the eBay Features Guide for additional validation rules for pictures.

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

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

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


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

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

Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings.
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

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

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

Not applicable to Half.com.

See:
    Revising Items
    Reserve Price (eBay site help)
    Fees Overview (eBay site help)
    Determining Whether a Category Supports Reserve Prices

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

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

Not applicable to Half.com.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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

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

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

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

See (GeteBayDetails) ReturnPolicyDetails.EAN.

AddItemRequestContainer.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.
AddItemRequestContainer.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
AddItemRequestContainer.Item
  .ReturnPolicy
  .RestockingFeeValueOption
token Optional This enumeration value indicates the restocking fee charged by the seller for returned items. In order to charge the buyer a restocking fee when an item is returned, a US seller must input a restocking fee value as part of the return policy.

For the restocking fee to take effect, the seller needs to opt into eBay's return process. Otherwise, the restocking fee is ignored.

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

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

See GeteBayDetails.ReturnPolicyDetails for applicable values for RestockingFeeValueOption.



Applicable values: See RestockingFeeCodeType
AddItemRequestContainer.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
AddItemRequestContainer.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
AddItemRequestContainer.Item
  .ReturnPolicy
  .ShippingCostPaidByOption
token Optional The party who pays the shipping cost for a returned item. Use the ReturnPolicy.Description field to explain any additional details.

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

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

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

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



Applicable values: See ShippingCostPaidByOptionsCodeType
AddItemRequestContainer.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
AddItemRequestContainer.Item
  .ReturnPolicy
  .WarrantyOfferedOption
token Optional Indicates whether a warranty is offered for the item.
Applicable values:
To get the applicable WarrantyOfferedOption values for your site, call GeteBayDetails with DetailName set to ReturnPolicyDetails, and then look for the ReturnPolicyDetails.WarrantyOffered.WarrantyOfferedOption fields in the response. WarrantyOfferedCodeType defines all the possible values.
Note: Only the eBay India site supports this field.

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

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

For the US eBay Motors "Is There an Existing Warranty?" option, use Item.AttributeSetArray instead.
For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details.

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



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

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

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

Not applicable to Half.com.
AddItemRequestContainer.Item
  .SecondaryCategory
CategoryType Optional ID for second category in which the item is listed (also see Item.PrimaryCategory).

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

Not applicable to Half.com.

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.

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

Note: In a GetItem call, the Half.com category ID is returned in the PrimaryCategory container, and not the eBay category. The Half.com category ID is not necessarily returned in GetCategories call.
Max length: 10.
AddItemRequestContainer.Item
  .Seller
UserType Conditional Container for information about this listing's seller.

Not applicable to Half.com.

Returned by GetItemsAwaitingFeedback if Buyer is making the request.
AddItemRequestContainer.Item
  .Seller.MotorsDealer
boolean Conditional Indicates if item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only.
AddItemRequestContainer.Item
  .SellerContactDetails
AddressType Optional Contact information for sellers using the Classified Ad format for eBay Motors vehicles categories. To remove seller contact information when revising or relisting an item, use DeletedField. The seller contact details for the primary and secondary phone numbers cannot be deleted individually.

To provide City, State, and Zip code information in SellerContactDetails use the following field:
Item.SellerContactDetails.Street2

To delete the secondary phone number, for example, you must delete all of the secondary phone fields:
Item.SellerContactDetails.Phone2AreaOrCityCode
Item.SellerContactDetails.Phone2CountryCode
Item.SellerContactDetails.Phone2CountryPrefix
Item.SellerContactDetails.Phone2LocalNumber

See Classified Ad Listings.

AddItemRequestContainer.Item
  .SellerContactDetails
  .CompanyName
string Optional User's company name. Only returned if available.
AddItemRequestContainer.Item
  .SellerContactDetails.County
string Optional The county in which the address resides.
AddItemRequestContainer.Item
  .SellerContactDetails
  .Phone2AreaOrCityCode
string Optional Area or City Code of a user's secondary phone number. This field applies to Classified Ad listings only.
AddItemRequestContainer.Item
  .SellerContactDetails
  .Phone2CountryCode
CountryCodeType Optional Standard ISO code for the country of a user's secondary telephone phone number. For Classified Ad listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad listings only.

Applicable values: See Phone2CountryCode.
AddItemRequestContainer.Item
  .SellerContactDetails
  .Phone2LocalNumber
string Optional The local number portion of the user's secondary phone number. This field applies to Classified Ad listings only.
Note: The full secondary phone number is constructed by combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix.
Max length: 30.
AddItemRequestContainer.Item
  .SellerContactDetails
  .PhoneAreaOrCityCode
string Optional Area or City Code of a user's primary phone number. This field applies to Classified Ad listings only.
AddItemRequestContainer.Item
  .SellerContactDetails
  .PhoneCountryCode
CountryCodeType Optional Standard ISO code for the country of the user's primary telephone phone number. For Classified Ad listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad listings only.

Applicable values: See PhoneCountryCode.
AddItemRequestContainer.Item
  .SellerContactDetails
  .PhoneLocalNumber
string Optional The local number portion of the user's primary phone number. This field applies to Classified Ad listings only.
Note: The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix.
Max length: 30.
AddItemRequestContainer.Item
  .SellerContactDetails.Street
string Optional A concatenation of Street1 and Street2, primarily used for a registration address.
AddItemRequestContainer.Item
  .SellerContactDetails.Street2
string Optional The second line of the user's street address (such as an apartment number or suite number). Returned if the user specified a second street value for their address. In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. .
AddItemRequestContainer.Item
  .SellerInventoryID
string Optional Unique identifier for a Half.com item. Must be an alphanumeric value (with no symbols) that is unique across the seller's active (unsold) inventory on Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. Only returned from GetOrders if the seller specified a value when the item was listed. You cannot revise this field.

Not applicable to eBay.com listings.
Max length: 100.
AddItemRequestContainer.Item
  .SellerProfiles
SellerProfilesType Conditional Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing.
AddItemRequestContainer.Item
  .SellerProfiles
  .SellerPaymentProfile
SellerPaymentProfileType Conditional The SellerPaymentProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address.

Business Policies payment profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.
AddItemRequestContainer.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 call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

In the "Get" calls, the PaymentProfileID value will always be returned if the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile.
AddItemRequestContainer.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 call to reference and use the payment policy values of a Business Policies payment profile. If both fields are provided and their values don't match, the PaymentProfileID takes precedence.

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

Business Policies return policy profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.
AddItemRequestContainer.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 call to reference and use the payment policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

In the "Get" calls, the ReturnProfileID value will always be returned if the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile.
AddItemRequestContainer.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 call to reference and use the return policy values of a Business Policies return policy profile. If both fields are provided and their values don't match, the ReturnProfileID takes precedence.

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

Business Policies shipping profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data.
AddItemRequestContainer.Item
  .SellerProfiles
  .SellerShippingProfile
  .ShippingProfileID
long Conditional The unique identifier of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. If both fields are provided and their values don't match, the ShippingProfileID takes precedence.

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

In the "Get" calls, the ShippingProfileID value will always be returned if the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile.
AddItemRequestContainer.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.
AddItemRequestContainer.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 Real Estate listings and Half.com.

GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned.

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

AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
CalculatedShippingRateType Conditional Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator.

Not applicable to Half.com.

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.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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.

AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackageDepth
MeasureType (decimal) Conditional Note: The value for PackageDepth should now be specified in the ShippingPackageDetails container instead. If the PackageDepth 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.
Depth of the package, in whole number of inches (English) or centimeters (Metric), 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.

AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackageDepth
  [ attribute unit ]
token Optional Note: The value for PackageDepth should now be specified in the ShippingPackageDetails container instead. If the PackageDepth 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.
Depth of the package, in whole number of inches (English) or centimeters (Metric), 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.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackageDepth
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional Note: The value for PackageDepth should now be specified in the ShippingPackageDetails container instead. If the PackageDepth 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.
Depth of the package, in whole number of inches (English) or centimeters (Metric), needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)

Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs.

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackageLength
MeasureType (decimal) Conditional Note: The value for PackageLength should now be specified in the ShippingPackageDetails container instead. If the PackageLength 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.
Length of the package, in whole number of inches (English) or centimeters (Metric), 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.)

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.

AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackageLength
  [ attribute unit ]
token Optional Note: The value for PackageLength should now be specified in the ShippingPackageDetails container instead. If the PackageLength 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.
Length of the package, in whole number of inches (English) or centimeters (Metric), 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.)

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.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackageLength
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional Note: The value for PackageLength should now be specified in the ShippingPackageDetails container instead. If the PackageLength 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.
Length of the package, in whole number of inches (English) or centimeters (Metric), 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.)

Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs.

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackageWidth
MeasureType (decimal) Conditional Note: The value for PackageWidth should now be specified in the ShippingPackageDetails container instead. If the PackageWidth 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.
Width of the package, in whole number of inches (English) or centimeters (Metric), 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.)

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.

AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackageWidth
  [ attribute unit ]
token Optional Note: The value for PackageWidth should now be specified in the ShippingPackageDetails container instead. If the PackageWidth 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.
Width of the package, in whole number of inches (English) or centimeters (Metric), 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.)

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.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackageWidth
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional Note: The value for PackageWidth should now be specified in the ShippingPackageDetails container instead. If the PackageWidth 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.
Width of the package, in whole number of inches (English) or centimeters (Metric), 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.)

Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs.

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .ShippingPackage
ShippingPackageCodeType Conditional Note: The value for ShippingPackage should now be specified in the ShippingPackageDetails container instead. If the ShippingPackage 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 enumeration value indicates the type of shipping package used to ship the item(s). This is required for calculated shipping only. To get the applicable ShippingPackage values for your site, call GeteBayDetails with DetailName set to ShippingPackageDetails, and then look for the ShippingPackageDetails.ShippingPackage fields in the response.

Applicable values: See ShippingPackage.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMajor
MeasureType (decimal) Conditional Note: The value for WeightMajor should now be specified in the ShippingPackageDetails container instead. If the WeightMajor 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.
WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz:

<WeightMajor unit="lbs">5</WeightMajor>
<WeightMinor unit="oz">2</WeightMinor>


See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

See Managing Rate Tables with the API for flat rate shipping that requires this field.

AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMajor
  [ attribute unit ]
token Optional Note: The value for WeightMajor should now be specified in the ShippingPackageDetails container instead. If the WeightMajor 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.
WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz:

<WeightMajor unit="lbs">5</WeightMajor>
<WeightMinor unit="oz">2</WeightMinor>


See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMajor
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional Note: The value for WeightMajor should now be specified in the ShippingPackageDetails container instead. If the WeightMajor 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.
WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz:

<WeightMajor unit="lbs">5</WeightMajor>
<WeightMinor unit="oz">2</WeightMinor>


See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMinor
MeasureType (decimal) Conditional Note: The value for WeightMinor should now be specified in the ShippingPackageDetails container instead. If the WeightMinor 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.
WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz:

<WeightMajor unit="lbs">5</WeightMajor>
<WeightMinor unit="oz">2</WeightMinor>


See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

Note: When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs).

See Managing Rate Tables with the API for flat rate shipping that requires this field.

AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMinor
  [ attribute unit ]
token Optional Note: The value for WeightMinor should now be specified in the ShippingPackageDetails container instead. If the WeightMinor 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.
WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz:

<WeightMajor unit="lbs">5</WeightMajor>
<WeightMinor unit="oz">2</WeightMinor>


See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

Note: When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs).
AddItemRequestContainer.Item
  .ShippingDetails
  .CalculatedShippingRate
  .WeightMinor
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional Note: The value for WeightMinor should now be specified in the ShippingPackageDetails container instead. If the WeightMinor 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.
WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz:

<WeightMajor unit="lbs">5</WeightMajor>
<WeightMinor unit="oz">2</WeightMinor>


See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service.

For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used.

Note: When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs).

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.Item
  .ShippingDetails.CODCost
AmountType (double) Conditional This dollar value indicates the money due from the buyer upon delivery of the item.

This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request.

This field is only returned if set for the listing.

To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to PaymentOptionDetails. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response.

See Other Shipping Features.

AddItemRequestContainer.Item
  .ShippingDetails.CODCost
  [ attribute currencyID ]
CurrencyCodeType Optional This dollar value indicates the money due from the buyer upon delivery of the item.

This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request.

This field is only returned if set for the listing.

To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to PaymentOptionDetails. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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
AddItemRequestContainer.Item
  .ShippingDetails
  .GlobalShipping
boolean Conditional Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is false, the seller is responsible for specifying an international shipping service for the listing if desired.

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

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

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

AddItemRequestContainer.Item
  .ShippingDetails
  .InsuranceDetails
InsuranceDetailsType Optional Container for domestic insurance information.

Note: There are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details. If this (newer) container is provided in the request and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, the two (older fields) are ignored. If this container is omitted on in the request, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, depending on which subfields are used.
Valid only on the following sites: FR and IT
AddItemRequestContainer.Item
  .ShippingDetails
  .InsuranceDetails.InsuranceFee
AmountType (double) Optional Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).
AddItemRequestContainer.Item
  .ShippingDetails
  .InsuranceDetails.InsuranceFee
  [ attribute currencyID ]
CurrencyCodeType Optional Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.Item
  .ShippingDetails
  .InsuranceDetails
  .InsuranceOption
InsuranceOptionCodeType Optional Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
IncludedInShippingHandling
(in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.
NotOffered
(in/out) The seller does not offer shipping insurance to the buyer.
Optional
(in/out) The seller offers the buyer the choice of paying for shipping insurance or not.
Required
(in/out) The seller requires that the buyer pay for shipping insurance.

(Not all values in InsuranceOptionCodeType apply to this field.)
AddItemRequestContainer.Item
  .ShippingDetails.InsuranceFee
AmountType (double) Optional Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request.

Valid only on the following sites: FR and IT
Applicable to Half.com for GetOrders.
Default: 0.00.
AddItemRequestContainer.Item
  .ShippingDetails.InsuranceFee
  [ attribute currencyID ]
CurrencyCodeType Optional Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request.

Valid only on the following sites: FR and IT
Applicable to Half.com for GetOrders.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.Item
  .ShippingDetails
  .InsuranceOption
InsuranceOptionCodeType Optional Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored.

Note: Sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged.
Valid only on the FR and IT sites and is returned only if the value is other than NotOffered.

If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing.

Applicable to Half.com

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
IncludedInShippingHandling
(in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.
NotOffered
(in/out) The seller does not offer shipping insurance to the buyer.
Optional
(in/out) The seller offers the buyer the choice of paying for shipping insurance or not.
Required
(in/out) The seller requires that the buyer pay for shipping insurance.

(Not all values in InsuranceOptionCodeType apply to this field.)
AddItemRequestContainer.Item
  .ShippingDetails
  .InternationalInsuranceDetails
InsuranceDetailsType Optional Container for international insurance information.

Note: There are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details. If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) are set to for flat and calculated shipping, depending on which subfields are used.

Valid only on the following sites: FR and IT
AddItemRequestContainer.Item
  .ShippingDetails
  .InternationalInsuranceDetails
  .InsuranceFee
AmountType (double) Optional Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).
AddItemRequestContainer.Item
  .ShippingDetails
  .InternationalInsuranceDetails
  .InsuranceFee
  [ attribute currencyID ]
CurrencyCodeType Optional Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.Item
  .ShippingDetails
  .InternationalInsuranceDetails
  .InsuranceOption
InsuranceOptionCodeType Optional Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true.

Valid only on the following sites: AU, FR, and IT
Applicable to Half.com (for GetOrders).

Applicable values:

CustomCode
(in/out) Reserved for internal or future use
IncludedInShippingHandling
(in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.
NotOffered
(in/out) The seller does not offer shipping insurance to the buyer.
Optional
(in/out) The seller offers the buyer the choice of paying for shipping insurance or not.
Required
(in/out) The seller requires that the buyer pay for shipping insurance.

(Not all values in InsuranceOptionCodeType apply to this field.)
AddItemRequestContainer.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.

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

AddItemRequestContainer.Item
  .ShippingDetails
  .InternationalShippingServiceOption
InternationalShippingServiceOptionsType Optional,
repeatable: [0..*]
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

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

See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).

AddItemRequestContainer.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
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Optional The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

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

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

Also applicable to Half.com (for GetOrders).

See Shipping.

AddItemRequestContainer.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Optional 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.)

Also applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority
int Conditional This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.
AddItemRequestContainer.Item
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShipToLocation
string Conditional,
repeatable: [0..*]
An international location or region to where the item seller will ship the item.

Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields.

For the AddItem family of calls, this field is required if any international shipping service is specified.

See Specifying Locations to Where You Ship.



Applicable values: See CountryCodeType, ShippingRegionCodeType
AddItemRequestContainer.Item
  .ShippingDetails
  .PaymentInstructions
string Optional Payment instructions (or message) from the seller to the buyer. These instructions appear on eBay's View Item page and on eBay's checkout page when the buyer pays for the item.

Sellers usually use this field to specify payment instructions, how soon the item will shipped, feedback instructions, and other reminders that the buyer should be aware of when they bid on or buy an item.

This field can be specified regardless of the shipping type eBay only allows 500 characters as input, but due to the way the eBay Web site UI treats characters, this field can return more than 500 characters in the response. Characters like & and ' (apostrophe/single quote) count as 5 characters each. Use DeletedField to remove this value when revising or relisting an item.

Applicable to eBay Motors (usually used to elaborate on the return policy).
Not applicable to Half.com.
Max length: 1000.

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

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

AddItemRequestContainer.Item
  .ShippingDetails
  .RateTableDetails
RateTableDetailsType Conditional This container specifies the shipping rate tables that are to be applied to this listing. Shipping rate tables enable sellers to tailor the flat shipping rates offered for an item to fit the shipping destination. They can specify a shipping rate for a large base region, then define alternative rates or surcharges for shipping to other extended regions within the base region.

Prerequisites for applying shipping rate tables:
  • The shipping type for the listing must be Flat.
  • The seller must have previously configured a shipping rate table in My eBay site preferences.
In a domestic shipping rate table, sellers can specify an alternative shipping rate for each shipping service category, for each of several extended domestic regions within their country. For example, in the US the shipping categories are Economy, Standard, Expedited and One-day. The extended regions are Alaska and Hawaii, US Protectorates, and Army/Fleet Post Offices.

In an international shipping rate table, sellers can specify an alternative shipping rate for each shipping service category, for each country in a given base region. The international rate table has nine base regions: Africa, Asia, Central America and Caribbean, Europe, Middle East, North America, Oceania, Southeast Asia, and South America. You can use the GetUser call to determine if the seller has configured a shipping rate table. If the domestic shipping rate table is available for this seller, the User.SellerInfo.DomesticRateTable field will be true.

If the international shipping rate table is available for this seller, the User.SellerInfo.InternationalTable field will be true.

Note: You can use RateTableDetails to apply a shipping rate table to a listing or remove it from a listing. However, the details of a shipping rate table configuration can only be viewed and modified on the eBay website, not by using the API. Sellers use a dropdown list to specify the alternative shipping rate applied by the rate table as one of the following:
  • A flat amount per item
  • A flat surcharge (domestic rate tables only)
  • A surcharge by weight
This selection applies to the entire table; there is no mixing and matching by region or shipping category.

If you are applying a shipping rate table that specifies a surcharge by weight, you must specify the item weight in the ShippingDetails.CalculatedShippingRate container's WeightMajor and WeightMinor fields, even though this is a flat rate listing. Do not use any other fields in the CalculatedShippingRate container because those are not supported in this scenario.

Note: There is currently no way to determine through the API whether a seller's rate table specifies a surcharge by weight, so your application must make it clear to the seller that item weight must be supplied if the seller has specified a surcharge by weight. If the required weight values are not supplied, a default weight of one unit (1 lb or 1 kg, depending on locale) is used as the basis for the surcharge. This container is returned from the GetItem family of calls only for the seller who listed the item.

You can find more information about using shipping rate tables in the Shipping chapter of the eBay Features Guide.

See Specifying Shipping Types and Costs.

AddItemRequestContainer.Item
  .ShippingDetails
  .RateTableDetails
  .DomesticRateTable
string Conditional On input, this field specifies which domestic shipping rate table to apply to a listing. Domestic rate tables can be used only for items listed on the eBay US, UK, DE, AU and Motors Parts and Accessories websites.

Currently, sellers can configure only one domestic shipping rate table, so set DomesticRateTable = Default to apply that table. The rates assigned to the various domestic regions are applied depending on the location of the buyer. If only one shipping service category and rate has been set for a given domestic region in the domestic rate table, buyers in that region will see only one shipping cost. If several service levels and rates are set up in the domestic shipping rate table for a given domestic region, buyers in that region will see the different shipping levels and rates and can choose one of them.

If you are modifying or relisting an item (using the Revise or Relist family of calls), you can delete the existing rate table setting applied to the listing by using the empty tag: <DomesticRateTable />

This field is returned from the GetItem family of calls only for the seller who listed the item.

You can find more information about using shipping rate tables in the Shipping chapter of the Trading API User's Guide.
Max length: 50.

See Specifying Shipping Types and Costs.

AddItemRequestContainer.Item
  .ShippingDetails
  .RateTableDetails
  .InternationalRateTable
string Conditional On input, 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 eBay US, UK and DE sites.

Currently, sellers can configure only one international shipping rate table, so set InternationalRateTable = Default to apply that table. The rates assigned to the various countries are applied depending on the location of the buyer. If only one shipping service category and rate has been set for a given country in the international rate table, buyers in that country will see only one shipping cost. If several service levels and rates are set up in the international shipping rate table for a given country, buyers in that country will see the different shipping levels and rates and can choose one of them.

If you are modifying or relisting an item (using the Revise or Relist family of calls), you can delete the existing rate table setting applied to the listing by using the empty tag: <InternationalRateTable />

This field is returned from the GetItem family of calls only for the seller who listed the item.

You can find more information about using shipping rate tables in the Shipping chapter of the Trading API User's Guide.

See Specifying Shipping Types and Costs.

AddItemRequestContainer.Item
  .ShippingDetails.SalesTax
SalesTaxType Optional Sales tax details. US and US Motors (site 0) sites only, excluding vehicle listings. Flat and calculated shipping.

Applicable to Half.com (for GetOrders).

See Enabling Multi-jurisdiction Sales Tax.

AddItemRequestContainer.Item
  .ShippingDetails.SalesTax
  .SalesTaxPercent
float Optional Percent of an item's price to be charged as the sales tax for the order. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

Applicable to Half.com (for GetOrders).
AddItemRequestContainer.Item
  .ShippingDetails.SalesTax
  .SalesTaxState
string Optional State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value.

To see the valid values for your site, call GeteBayDetails with DetailName set to TaxJurisdiction, and then look for the TaxJurisdiction.JurisdictionID fields in the response.

Applicable to Half.com (for GetOrders).
AddItemRequestContainer.Item
  .ShippingDetails.SalesTax
  .ShippingIncludedInTax
boolean Optional (US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping.

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

AddItemRequestContainer.Item
  .ShippingDetails
  .ShippingServiceOptions
ShippingServiceOptionsType Conditional,
repeatable: [0..*]
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified.

For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs.

If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them:

<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<ShippingServiceOptions>...</ShippingServiceOptions>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>
<InternationalShippingServiceOption>...</InternationalShippingServiceOption>


If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well.

To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

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

See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).

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

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

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.

See GeteBayDetails.



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

AddItemRequestContainer.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Optional The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

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

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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.)
Also applicable to Half.com (for GetOrders).

See Determining Shipping Costs for a Listing.

AddItemRequestContainer.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Optional 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.)
Also applicable to Half.com (for GetOrders).

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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. This field is not applicable to Half.com listings.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType Optional An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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.

Not applicable to Half.com.

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

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

AddItemRequestContainer.Item
  .ShippingPackageDetails
  .PackageDepth
  [ attribute unit ]
token Optional 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.
AddItemRequestContainer.Item
  .ShippingPackageDetails
  .PackageDepth
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)

Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs.

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.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.

AddItemRequestContainer.Item
  .ShippingPackageDetails
  .PackageLength
  [ attribute unit ]
token Optional 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.)
AddItemRequestContainer.Item
  .ShippingPackageDetails
  .PackageLength
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.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.

AddItemRequestContainer.Item
  .ShippingPackageDetails
  .PackageWidth
  [ attribute unit ]
token Optional 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.)
AddItemRequestContainer.Item
  .ShippingPackageDetails
  .PackageWidth
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingPackageDetails
  .WeightMajor
  [ attribute unit ]
token Optional 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.
AddItemRequestContainer.Item
  .ShippingPackageDetails
  .WeightMajor
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional 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.

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingPackageDetails
  .WeightMinor
  [ attribute unit ]
token Optional 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.
AddItemRequestContainer.Item
  .ShippingPackageDetails
  .WeightMinor
  [ attribute measurementSystem ]
MeasurementSystemCodeType Optional See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.)

Required on input when calculated shipping is used.

For a list of possible enumeration values, see MeasurementSystemCodeType.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.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.
AddItemRequestContainer.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.

AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ShippingServiceCostOverrideList
  .ShippingServiceCostOverride
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType 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.

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.Item
  .ShippingTermsInDescription
boolean Optional Indicates whether details about shipping costs and arrangements are specified in the item description.

Not applicable to Half.com.

See Specifying Shipping Types and Costs.

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

Not applicable to Half.com.
Max length: length of longest name in ShippingRegionCodeType and CountryCodeType.

See:
    Specifying Locations to Where You Ship
    GeteBayDetails



Applicable values: See CountryCodeType, ShippingRegionCodeType
AddItemRequestContainer.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).

Not applicable to Half.com.

Applicable values: See Site.

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

AddItemRequestContainer.Item
  .SKU
SKUType (string) Optional A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)

A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs.

If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. 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 multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier.

Note: The eBay 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 GetMyeBaySelling, this is only returned if set.
Not applicable to Half.com.
Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.

AddItemRequestContainer.Item
  .SkypeContactOption
SkypeContactOptionCodeType Optional,
repeatable: [0..*]
Specifies the Skype contact options supported. Requires that SkypeEnabled is set to true. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account.

Applicable values:

Chat
(in/out) The seller can communicate with the buyer by Skype Chat.
CustomCode
(in/out) Reserved for internal or future use.
Voice
(in/out) The seller can communicate with the buyer by Skype Voice.

AddItemRequestContainer.Item
  .SkypeEnabled
boolean Optional Specifies that Skype-related information is included with an item listing, including, for example, Skype Voice. Skype-related information provides buttons that enable potential buyers to contact sellers through Skype. Information about Skype is available at www.Skype.com. If all of the prerequisites for adding Skype buttons to listings are met, you can make communication through Skype available in listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are specified.
AddItemRequestContainer.Item
  .SkypeID
string Optional The Skype name of the seller. Requires that SkypeEnabled is set to true. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account.
AddItemRequestContainer.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.

Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings.
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.

AddItemRequestContainer.Item
  .StartPrice
  [ attribute currencyID ]
CurrencyCodeType Optional 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.

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

For a list of possible enumeration values, see CurrencyCodeType.
AddItemRequestContainer.Item
  .Storefront
StorefrontType Optional Contains information related to the item in the context of a seller's eBay Store. Applicable for auction formats, Basic Fixed Price, and Store Inventory format items listed by eBay Stores sellers.

Not applicable to Half.com.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.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'.
AddItemRequestContainer.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.

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

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

AddItemRequestContainer.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.
AddItemRequestContainer.Item
  .ThirdPartyCheckout
boolean Optional Determines whether or not checkout is to be handled by an authorized Third-Party Checkout application. See "Third-Party Checkout" in the main documentation.

The counterpart in the GetItem family of calls is Item.ShippingDetails.ThirdPartyCheckout.

To create an Immediate Payment listing, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and PaymentMethods must be PayPal. AutoPay can be enabled for ThirdPartyCheckout apps that have been approved by eBay.

Not applicable to Half.com.

See (GetItem) Item.ShippingDetails.ThirdPartyCheckout.

AddItemRequestContainer.Item
  .ThirdPartyCheckoutIntegration
boolean Optional Only authorized Third-Party Checkout providers can use this flag.

If you are a seller, subscribe to Checkout notifications through a supporting application. Set this flag to true to enable Checkout notifications for a particular listing.

IMPORTANT: If you are not authorized to support Third-Party Checkout and your application is not the original listing application, never specify ThirdPartyCheckout or ThirdPartyCheckoutIntegration in your request (even if you revise a listing that already includes these flags). Otherwise you may get unexpected results.

Returned only if true for a listing.
Not applicable to Half.com.
Default: false.

See Working with Platform Notifications.

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

For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead.

You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours.
Max length: 80.
AddItemRequestContainer.Item
  .UseTaxTable
boolean Optional Indicates whether the seller's tax table is to be used when applying and calculating sales tax for an order line item. A sales tax table can be created programmatically using the SetTaxTable call, or it can be created manually in My eBay's Selling Preferences. If UseTaxTable is set to true, the values contained in the seller's sales tax table will supersede the values contained in the Item.ShippingDetails.SalesTax container (if included in the request).

Not applicable to Half.com.

See Enabling Multi-jurisdiction Sales Tax.

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

Also applicable as input to AddItem and related calls when you list items to Half.com.
Max length: 32.
AddItemRequestContainer.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.
Not applicable to Half.com.

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

AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.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.
AddItemRequestContainer.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).
AddItemRequestContainer
  .MessageID
string Required Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. With AddItems, a unique MessageID value is required for each AddItemRequestContainer container that is used in the request. The CorrelationID value returned under each AddItemResponseContainer container is used to correlate each item request container with its corresponding response container. The same MessageID value that you pass into a request will be returned in the CorrelationID field in the response.
Standard Input Fields  
ErrorHandling ErrorHandlingCodeType Optional Error tolerance level for the call. This is a preference that specifies how eBay should handle requests that contain invalid data or that could partially fail. This gives you some control over whether eBay returns warnings or blocking errors and how eBay processes the invalid data.

This field is only applicable to AddItem and related calls, and only when the listing includes ProductListingDetails.
Default: BestEffort.

Applicable values:

AllOrNothing
(in) If any of the item specifics data is invalid, drop all the data and proceed with listing the item. If the category has required item specifics and the data was dropped, reject the listing.
BestEffort
(in) Drop the invalid data, continue processing the request with the valid data. If dropping the invalid data leaves the request in a state where required data is missing, reject the request.

If BestEffort is specified for CompleteSale, the Ack field in the response could return PartialFailure if one change fails but another succeeds. For example, if the seller attempts to leave feedback twice for the same order line item, the feedback changes would fail but any paid or shipped status changes would succeed.
FailOnError
(in) If any data is invalid, reject the request.
Legacy
(in) Apply validation rules that were in effect prior to the time the call started supporting ErrorHandling.

See Pre-filling Item Specifics with Product Details.

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

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

See also Samples.

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

<?xml version="1.0" encoding="utf-8"?>
<AddItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <AddItemResponseContainer> AddItemResponseContainerType
    <Category2ID> string </Category2ID>
    <CategoryID> string </CategoryID>
    <CorrelationID> string </CorrelationID>
    <DiscountReason> DiscountReasonCodeType </DiscountReason>
    <!-- ... more DiscountReason values allowed here ... -->
    <EndTime> dateTime </EndTime>
    <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>
      <UserDisplayHint> boolean </UserDisplayHint>
    </Errors>
    <!-- ... more Errors nodes allowed here ... -->
    <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>
    <Message> string </Message>
    <StartTime> dateTime </StartTime>
  </AddItemResponseContainer>
  <!-- ... more AddItemResponseContainer nodes allowed here ... -->
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <DuplicateInvocationDetails> DuplicateInvocationDetailsType
    <DuplicateInvocationID> UUIDType (string) </DuplicateInvocationID>
    <InvocationTrackingID> string </InvocationTrackingID>
    <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>
    <UserDisplayHint> boolean </UserDisplayHint>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Message> string </Message>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</AddItemsResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
AddItemResponseContainer AddItemResponseContainerType Always,
repeatable: [1..*]
One AddItemResponseContainer container is returned for each listing that is being created with the AddItems call. Each container includes the ItemID of each newly created listings, the eBay category each item is listed under, the seller-defined SKUs of the items (if any), the listing recommendations for each item (if applicable), the start and end time of each listing, and the estimated fees that each listing will incur.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .CorrelationID
string Always Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. With AddItems, a unique MessageID value is required for each AddItemRequestContainer container that is used in the request. The CorrelationID value returned under each AddItemResponseContainer container is used to correlate each item request container with its corresponding response container. The same MessageID value that you pass into a request will be returned in the CorrelationID field in the response.
AddItemResponseContainer
  .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."

AddItemResponseContainer
  .EndTime
dateTime Always 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.
AddItemResponseContainer
  .Errors
ErrorType Conditionally,
repeatable: [0..*]
This container is an array of one or more errors and/or warnings (if any) that occurred when eBay processed the request.

Errors may occur due to problems with business-level data on the client side or on the eBay server side. For example, an error would occur if the request contains an invalid combination of fields, or it is missing a required field, or the value of the field is not recognized. An error could also occur if eBay encountered a problem in our internal business logic while processing the request.

This container is only returned if there were one or more warnings or errors.
AddItemResponseContainer
  .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.

AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .Errors.ErrorParameters.Value
string Conditionally The value of the variable (e.g., the attribute set ID)
AddItemResponseContainer
  .Errors.LongMessage
string Conditionally A more detailed description of the condition that raised the error.
AddItemResponseContainer
  .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.

AddItemResponseContainer
  .Errors.ShortMessage
string Conditionally A brief description of the condition that raised the error.
AddItemResponseContainer
  .Errors.UserDisplayHint
boolean Conditionally Indicates whether the error message text is intended to be displayed to an end user or intended only to be parsed by the application. If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for the application, and the application should translate the error into a more appropriate message. Only applicable to Item Specifics errors and warnings returned from listing requests.
AddItemResponseContainer.Fees FeesType Always This container is an array of one or more 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:
    Final Value Fees and Credits
    Fees per Site
    Using Feature Packs to Save on Upgrade Fees

AddItemResponseContainer.Fees
  .Fee
FeeType Always,
repeatable: [1..*]
Contains the name, fee, and possible discount amount for an item listing feature. A Fee container is returned for each listing feature, even if the associated cost (Fee value) is 0.
AddItemResponseContainer.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.

AddItemResponseContainer.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.
AddItemResponseContainer.Fees
  .Fee.Name
string Always Name of the listing feature, for identification purposes.

See Fees Resulting from Listing an Item.

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

AddItemResponseContainer.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.
AddItemResponseContainer
  .ItemID
ItemIDType (string) Always Unique identifier for the new listing. This field is returned as long as the listing was successfully created.
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
AddItemResponseContainer
  .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 AddItems request, and if at least one listing recommendation exists for the newly created listing. If one or more listing recommendations are returned for one or more of the newly created listings, it will be at the seller's discretion about whether to revise the item(s) based on eBay's listing recommendation(s).
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .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.
AddItemResponseContainer
  .Message
string Conditionally Supplemental information from eBay, if applicable. May elaborate on errors or provide useful hints for the seller. This data can accompany the call's normal data result set or a result set that contains only errors. 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. Because this data is returned as a string, the HTML markup elements are escaped with character entity references (e.g.,<table><tr>...).
AddItemResponseContainer
  .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.)
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
  .DuplicateInvocationID
UUIDType (string) Conditionally The duplicate InvocationID.
DuplicateInvocationDetails
  .InvocationTrackingID
string Conditionally The id that identifies the business item the previous API invocation created. For example, the ItemID of the item created by an AddItem call.
DuplicateInvocationDetails
  .Status
InvocationStatusType Conditionally The status of the previous call that used the InvocationID.

Applicable values:

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

Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.

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

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally 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 The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Error
(out) 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.

Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
Errors.UserDisplayHint boolean Conditionally Indicates whether the error message text is intended to be displayed to an end user or intended only to be parsed by the application. If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for the application, and the application should translate the error into a more appropriate message. Only applicable to Item Specifics errors and warnings returned from listing requests.
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 Routing the Request.

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

Available samples:

Sample: Basic Call

Defines and lists several duplicate items for auction on the eBay US site.

Description

User magicalbookseller wants to sell several Harry Potter books on the eBay US site. She wants to start the listing at $1.00 and wants the listing to run for 7 days. She chooses flat rate shipping of $2.50 for a particular shipping service. She'll ship each item within 3 days of receiving cleared payment. She offers a standard return policy.

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

As a result of this call, magicalbookseller has a new listing for each of her Harry Potter books on eBay with the details as provided in the call. You can call GetItem with the ItemIDs found in the AddItems response to confirm the item details.

Input

All fields in the following AddItems request sample are the basic input to create a batch listing for magicalbookseller's Harry Potter books. To see a photo with the listing, provide a link to the photo in the PictureURL field. (The URL used in this sample is a picture provided by eBay.)

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

<?xml version="1.0" encoding="utf-8" ?>
<AddItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Version>585</Version>
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <AddItemRequestContainer>
    <MessageID>1</MessageID>
    <Item>
      <Title>Harry Potter and the Goblet of Fire</Title>
      <Description>This the Harry Potter series. In excellent condition!</Description>
      <PrimaryCategory>
        <CategoryID>279</CategoryID>
      </PrimaryCategory>
      <CategoryMappingAllowed>true</CategoryMappingAllowed>
      <Site>US</Site>
      <Quantity>1</Quantity>
      <StartPrice>1.0</StartPrice>
      <ListingDuration>Days_7</ListingDuration>
      <ListingType>Chinese</ListingType>
      <DispatchTimeMax>3</DispatchTimeMax>
      <ShippingDetails>
        <ShippingType>Flat</ShippingType>
        <ShippingServiceOptions>
          <ShippingServicePriority>1</ShippingServicePriority>
          <ShippingService>USPSMedia</ShippingService>
          <ShippingServiceCost>2.50</ShippingServiceCost>
        </ShippingServiceOptions>
      </ShippingDetails>
      <ReturnPolicy>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <RefundOption>MoneyBack</RefundOption>
        <ReturnsWithinOption>Days_30</ReturnsWithinOption>
        <Description>Text description of return policy details</Description>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
      </ReturnPolicy>
      <Country>US</Country>
      <Currency>USD</Currency>
      <PostalCode>95125</PostalCode>
      <PaymentMethods>PayPal</PaymentMethods>
      <PayPalEmailAddress>magicalbookseller@yahoo.com</PayPalEmailAddress>
      <PictureDetails>
        <PictureURL>http://thumbs.ebaystatic.com/pict/41007087008080_0.jpg</PictureURL>
      </PictureDetails>
    </Item>
  </AddItemRequestContainer>
  <AddItemRequestContainer>
    <MessageID>2</MessageID>
    <Item>
      <Title>Harry Potter and the Goblet of Fire</Title>
      <Description>This the Harry Potter series. In excellent condition!</Description>
      <PrimaryCategory>
        <CategoryID>279</CategoryID>
      </PrimaryCategory>
      <CategoryMappingAllowed>true</CategoryMappingAllowed>
      <Site>US</Site>
      <Quantity>1</Quantity>
      <StartPrice>1.0</StartPrice>
      <ListingDuration>Days_7</ListingDuration>
      <ListingType>Chinese</ListingType>
      <DispatchTimeMax>3</DispatchTimeMax>
      <ShippingDetails>
        <ShippingType>Flat</ShippingType>
        <ShippingServiceOptions>
          <ShippingServicePriority>1</ShippingServicePriority>
          <ShippingService>USPSMedia</ShippingService>
          <ShippingServiceCost>2.50</ShippingServiceCost>
        </ShippingServiceOptions>
      </ShippingDetails>
      <ReturnPolicy>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <RefundOption>MoneyBack</RefundOption>
        <ReturnsWithinOption>Days_30</ReturnsWithinOption>
        <Description>Text description of return policy details</Description>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
      </ReturnPolicy>
      <Country>US</Country>
      <Currency>USD</Currency>
      <PostalCode>95125</PostalCode>
      <PaymentMethods>PayPal</PaymentMethods>
      <PayPalEmailAddress>magicalbookseller@yahoo.com</PayPalEmailAddress>
      <PictureDetails>
        <PictureURL>http://thumbs.ebaystatic.com/pict/41007087008080_0.jpg</PictureURL>
      </PictureDetails>
    </Item>
  </AddItemRequestContainer>
</AddItemsRequest>

Output

The response includes the ItemIDs and the list of fees, in separate containers associated with listing magicalbookseller's books. For the basic AddItems call, the only fee is the insertion fee per item. The listing fee is the total of fees prior to selling the item. (In this case, the listing fee equals the insertion fee.)

XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2008-10-01T17:45:13.925Z</Timestamp>
  <Ack>Success</Ack>
  <Version>585</Version>
  <Build>e585_core_Bundled_7323141_R1</Build>
  <AddItemResponseContainer>
    <ItemID>190001224016</ItemID>
    <StartTime>2008-10-01T17:45:08.972Z</StartTime>
    <EndTime>2008-10-08T17:45:08.972Z</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.25</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.25</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>
    <CorrelationID>1</CorrelationID>
  </AddItemResponseContainer>
  <AddItemResponseContainer>
    <ItemID>190001224017</ItemID>
    <StartTime>2008-10-01T17:45:11.628Z</StartTime>
    <EndTime>2008-10-08T17:45:11.628Z</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.25</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.25</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>
    <CorrelationID>2</CorrelationID>
  </AddItemResponseContainer>
</AddItemsResponse>

Back to list of samples

Sample: Buy It Now

Defines and lists several items for auction with a Buy It Now price on the eBay US site.

Description

User magicalbookseller has items she would like to auction off on the eBay US site and would also like to set a Buy It Now price to increase her chances of someone buying the items at a fair price.

As a result of this call, a new set of listings is available on eBay with the basic details of the item and a Buy It Now price.

Input

The key input to this scenario is the BuyItNowPrice. This supplies the call a buy it now price for the item. User magicalbookseller will be charged an extra fee for having a Buy It Now price. If a buyer bids on the item, the Buy It Now price will be disabled and the listing will become a regular Chinese auction. If a buyer purchases the item with a Buy It Now price, the auction ends immediately.

She also generates and specifies a UUID, unique for each listing, in case the request fails so she can resubmit the request without worrying about a duplicate listing.

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

<?xml version="1.0" encoding="utf-8" ?>
<AddItemsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Version>585</Version>
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <AddItemRequestContainer>
    <MessageID>1</MessageID>
    <Item>
      <BuyItNowPrice currencyID="USD">18.00</BuyItNowPrice>
      <CategoryMappingAllowed>true</CategoryMappingAllowed>
      <Country>US</Country>
      <Currency>USD</Currency>
      <Description>This is the fourth book in the Harry Potter series. In excellent condition!</Description>
      <DispatchTimeMax>3</DispatchTimeMax>
      <ListingDuration>Days_7</ListingDuration>
      <ListingType>Chinese</ListingType>
      <PaymentMethods>PayPal</PaymentMethods>
      <PayPalEmailAddress>magicalbookseller@yahoo.com</PayPalEmailAddress>
      <PictureDetails>
        <GalleryType>Gallery</GalleryType>
        <GalleryURL>http://i16.ebayimg.com/01/c/03/c2/9d/d5_6.JPG</GalleryURL>
        <PictureURL>http://i16.ebayimg.com/01/c/03/c2/9d/d5_7.JPG</PictureURL>
        <PictureURL>http://i8.ebayimg.com/04/c/05/a7/ca/f2_7.JPG</PictureURL>
      </PictureDetails>
      <PostalCode>95125</PostalCode>
      <PrimaryCategory>
        <CategoryID>279</CategoryID>
      </PrimaryCategory>
      <Quantity>1</Quantity>
      <ReturnPolicy>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <RefundOption>MoneyBack</RefundOption>
        <ReturnsWithinOption>Days_30</ReturnsWithinOption>
        <Description>Text description of return policy details</Description>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
      </ReturnPolicy>
      <ShippingDetails>
        <ShippingType>Flat</ShippingType>
        <ShippingServiceOptions>
          <ShippingServicePriority>1</ShippingServicePriority>
          <ShippingService>USPSMedia</ShippingService>
          <ShippingServiceCost>2.50</ShippingServiceCost>
        </ShippingServiceOptions>
      </ShippingDetails>
      <Site>US</Site>
      <StartPrice currencyID="USD">0.99</StartPrice>
      <Title>Harry Potter and the Goblet of Fire</Title>
      <!-- Change the UUID for each item you list. It needs to be unique. -->
      <UUID>cbefc1e08af811ddad8b0800200c9a68</UUID>
    </Item>
  </AddItemRequestContainer>
  <AddItemRequestContainer>
    <MessageID>2</MessageID>
    <Item>
      <BuyItNowPrice currencyID="USD">18.00</BuyItNowPrice>
      <CategoryMappingAllowed>true</CategoryMappingAllowed>
      <Country>US</Country>
      <Currency>USD</Currency>
      <Description>This is the third book in the Harry Potter series. In excellent condition!</Description>
      <DispatchTimeMax>3</DispatchTimeMax>
      <ListingDuration>Days_7</ListingDuration>
      <ListingType>Chinese</ListingType>
      <PaymentMethods>PayPal</PaymentMethods>
      <PayPalEmailAddress>magicalbookseller@yahoo.com</PayPalEmailAddress>
      <PictureDetails>
        <GalleryType>Gallery</GalleryType>
        <GalleryURL>http://i16.ebayimg.com/01/c/03/c2/9d/d5_6.JPG</GalleryURL>
        <PictureURL>http://i16.ebayimg.com/01/c/03/c2/9d/d5_7.JPG</PictureURL>
        <PictureURL>http://i8.ebayimg.com/04/c/05/a7/ca/f2_7.JPG</PictureURL>
      </PictureDetails>
      <PostalCode>95125</PostalCode>
      <PrimaryCategory>
        <CategoryID>279</CategoryID>
      </PrimaryCategory>
      <Quantity>1</Quantity>
      <ReturnPolicy>
        <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
        <RefundOption>MoneyBack</RefundOption>
        <ReturnsWithinOption>Days_30</ReturnsWithinOption>
        <Description>Text description of return policy details</Description>
        <ShippingCostPaidByOption>Buyer</ShippingCostPaidByOption>
      </ReturnPolicy>
      <ShippingDetails>
        <ShippingType>Flat</ShippingType>
        <ShippingServiceOptions>
          <ShippingServicePriority>1</ShippingServicePriority>
          <ShippingService>USPSMedia</ShippingService>
          <ShippingServiceCost>2.50</ShippingServiceCost>
        </ShippingServiceOptions>
      </ShippingDetails>
      <Site>US</Site>
      <StartPrice currencyID="USD">0.99</StartPrice>
      <Title>Harry Potter and the Prisoner of Azkaban</Title>
      <!-- Change the UUID for each item you list. It needs to be unique. -->
      <UUID>44efc1e08ac711cdad7c0800200c9af8</UUID>
    </Item>
  </AddItemRequestContainer>
</AddItemsRequest>

Output

The key output for this scenario is the additional fee for setting the BuyItNowPrice. In addition to the BuyItNowFee, an insertion fee is charged and photo fee (for the additional pictures) are charged.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2008-10-01T18:05:51.228Z</Timestamp>
  <Ack>Success</Ack>
  <Version>585</Version>
  <Build>e585_core_Bundled_7323141_R1</Build>
  <AddItemResponseContainer>
    <ItemID>190001224035</ItemID>
    <StartTime>2008-10-01T18:05:43.916Z</StartTime>
    <EndTime>2008-10-08T18:05:43.916Z</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.1</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.1</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.15</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>
    <CorrelationID>1</CorrelationID>
  </AddItemResponseContainer>
  <AddItemResponseContainer>
    <ItemID>190001224036</ItemID>
    <StartTime>2008-10-01T18:05:48.603Z</StartTime>
    <EndTime>2008-10-08T18:05:48.603Z</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.1</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.1</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.15</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>
    <CorrelationID>2</CorrelationID>
  </AddItemResponseContainer>
</AddItemsResponse>

Back to list of samples



Change History

Change Date Description
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(s) 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
  • BrandMPN.Brand (modified): Decreased maximum length of string value to 65 characters.
  • BrandMPN.MPN (modified): Decreased maximum length of string value to 65 characters.
  • ProductListingDetails.EAN (modified): 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 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 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.
917
2014-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
  • 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.
  • Item.LiveAuction (doc change): Added more content to the field description.
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
  • Item.LiveAuction (added): Use this boolean field to enable an auction listing as a "Live Auction". The Live Auctions feature will allow real-time bidding on eBay for items that are up for bidding at a live auction (physical location).
  • 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.
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(s) referenced in the AddItems call.
  • Item.eBayNowEligible (added): This boolean field is used to enable one or more listings in the AddItems call 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.
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.
  • AddItemResponseContainer.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.
  • Item.ListingSubtype2 (doc change): A note was added to clarify that this value indicates a classified ad (or digital download) listing on ebay.com websites, not on ebayclassifieds.com. The ebayclassifieds.com site is not supported by the Trading API.
787
2012-08-15
  • Item.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 AddItems 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 AddItems 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 AddItems 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
  • Item.SellerProvidedTitle, PaymentDetails.DepositAmount, PaymentDetails.DepositType (added): Fields for US and Canada eBay Motors vehicles (previously available as ID-based attributes).
735
2011-08-17
  • Item.ItemSpecifics, Item.AttributeSetArray (modified): You can now use custom item specifics instead of ID-based attributes for ticket listings.
  • Item.ReturnPolicy.RefundOption (modified): MoneyBackOrExchange value is now supported.
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.
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.
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
675
2010-06-23
  • Item.LimitedWarrantyEligible (deprecated): This feature is no longer supported and the field is ignored in listing requests. It will be removed from the schema soon.
663
2010-03-31
  • Item.ApplyShippingDiscount (deprecated): This tag is no longer being used. It will be officially deprecated later in 2010.
661
2010-03-17
  • ConditionID (added): ConditionID is supported in the Sandbox for a few categories. Starting in May 2010, it will be functional in production for most categories. Use ConditionID instead of AttributeSetArray, LookupAttributeArray, or ItemSpecifics to specify the item's condition when GetCategoryFeatures shows ConditionEnabled=Enabled or Required for the listing's primary category.
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.
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.
605
2009-02-18
  • NowAndNew (deprecated): Now & New (Sofort & Neu) has been retired as of this release.
603
2009-02-04
  • Two enums in BuyerPaymentMethodCodeType (added): New payment methods: Paymate, Moneybookers.
  • Item.PaymentMethods.IntegratedMerchantCreditCard (added): This payment method can apply if a seller has a payment gateway account.
599
2009-1-07
  • NowAndNew (doc change): eBay will retire Now & New (Sofort & Neu) by March 2009.
595
2008-12-10
  • AddItemRequestContainer.MessageID (doc change): EndItemRequestContainer.MessageID is optional input for this call. This field had been omitted inadvertently from the documentation.
585
2008-10-01
  • (added) New call.