eBay Trading API
|
Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing. This enables the seller to test the item definition and get listing fees before actually listing the item. The listing fees may be different from the listing fees returned by AddItem.
The call validates your input fields against the schema. However, some business-logic checks performed for an AddItem call are not executed. For more information, please see the following Knowledge Base article:
VerifyAddItem returns Success with no Errors, but AddItem returns Failure with Errors
There are cases in which VerifyAddItem behaves differently from AddItem and returns a different result.
See:
Listing an Item
Introduction to Pictures in Item Listings
VerifyAddItem
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History Top Errors for VerifyAddItem |
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"?> <VerifyAddItemRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Standard Input Fields --> <ErrorHandling> ErrorHandlingCodeType </ErrorHandling> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> <!-- Call-specific Input Fields --> <ExternalProductID> ExternalProductIDType </ExternalProductID> <IncludeExpressRequirements> boolean </IncludeExpressRequirements> <Item> ItemType <ApplicationData> string </ApplicationData> <ApplyShippingDiscount> boolean </ApplyShippingDiscount> <AttributeArray> AttributeArrayType <Attribute attributeLabel="string"> AttributeType <Value> ValType <ValueLiteral> string </ValueLiteral> </Value> <!-- ... more Value nodes here ... --> </Attribute> <!-- ... more Attribute nodes here ... --> </AttributeArray> <AttributeSetArray> AttributeSetArrayType <AttributeSet attributeSetID="int" attributeSetVersion="string"> AttributeSetType <Attribute attributeID="int"> AttributeType <Value> ValType <ValueID> int </ValueID> <ValueLiteral> string </ValueLiteral> </Value> <!-- ... more Value nodes here ... --> </Attribute> <!-- ... more Attribute nodes here ... --> </AttributeSet> <!-- ... more AttributeSet nodes here ... --> </AttributeSetArray> <AutoPay> boolean </AutoPay> <BestOfferDetails> BestOfferDetailsType <BestOfferEnabled> boolean </BestOfferEnabled> </BestOfferDetails> <BuyerRequirementDetails> BuyerRequirementDetailsType <LinkedPayPalAccount> boolean </LinkedPayPalAccount> <MaximumBuyerPolicyViolations> MaximumBuyerPolicyViolationsType <Count> int </Count> <Period> PeriodCodeType </Period> </MaximumBuyerPolicyViolations> <MaximumItemRequirements> MaximumItemRequirementsType <MaximumItemCount> int </MaximumItemCount> <MinimumFeedbackScore> int </MinimumFeedbackScore> </MaximumItemRequirements> <MaximumUnpaidItemStrikesInfo> MaximumUnpaidItemStrikesInfoType <Count> int </Count> <Period> PeriodCodeType </Period> </MaximumUnpaidItemStrikesInfo> <MinimumFeedbackScore> int </MinimumFeedbackScore> <ShipToRegistrationCountry> boolean </ShipToRegistrationCountry> <VerifiedUserRequirements> VerifiedUserRequirementsType <MinimumFeedbackScore> int </MinimumFeedbackScore> <VerifiedUser> boolean </VerifiedUser> </VerifiedUserRequirements> <ZeroFeedbackScore> boolean </ZeroFeedbackScore> </BuyerRequirementDetails> <BuyerResponsibleForShipping> boolean </BuyerResponsibleForShipping> <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice> <CategoryBasedAttributesPrefill> boolean </CategoryBasedAttributesPrefill> <CategoryMappingAllowed> boolean </CategoryMappingAllowed> <Charity> CharityType <CharityID> string </CharityID> <CharityNumber> int </CharityNumber> <DonationPercent> float </DonationPercent> </Charity> <Country> CountryCodeType </Country> <CrossBorderTrade> string </CrossBorderTrade> <!-- ... more CrossBorderTrade nodes here ... --> <Currency> CurrencyCodeType </Currency> <Description> string </Description> <DisableBuyerRequirements> boolean </DisableBuyerRequirements> <DispatchTimeMax> int </DispatchTimeMax> <ExtendedSellerContactDetails> ExtendedContactDetailsType <ClassifiedAdContactByEmailEnabled> boolean </ClassifiedAdContactByEmailEnabled> <ContactHoursDetails> ContactHoursDetailsType <Hours1AnyTime> boolean </Hours1AnyTime> <Hours1Days> DaysCodeType </Hours1Days> <Hours1From> time </Hours1From> <Hours1To> time </Hours1To> <Hours2AnyTime> boolean </Hours2AnyTime> <Hours2Days> DaysCodeType </Hours2Days> <Hours2From> time </Hours2From> <Hours2To> time </Hours2To> <TimeZoneID> string </TimeZoneID> </ContactHoursDetails> </ExtendedSellerContactDetails> <ExternalProductID> ExternalProductIDType <ReturnSearchResultOnDuplicates> boolean </ReturnSearchResultOnDuplicates> <Type> ExternalProductCodeType </Type> <Value> string </Value> </ExternalProductID> <GetItFast> boolean </GetItFast> <GiftIcon> int </GiftIcon> <GiftServices> GiftServicesCodeType </GiftServices> <!-- ... more GiftServices nodes here ... --> <HitCounter> HitCounterCodeType </HitCounter> <ItemSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Value> string </Value> <!-- ... more Value nodes here ... --> </NameValueList> <!-- ... more NameValueList nodes here ... --> </ItemSpecifics> <LimitedWarrantyEligible> boolean </LimitedWarrantyEligible> <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> <MinimumBestOfferMessage> string </MinimumBestOfferMessage> <MinimumBestOfferPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumBestOfferPrice> <PayPerLeadEnabled> boolean </PayPerLeadEnabled> </ListingDetails> <ListingDuration> token </ListingDuration> <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement> <!-- ... more ListingEnhancement nodes here ... --> <ListingType> ListingTypeCodeType </ListingType> <Location> string </Location> <LookupAttributeArray> LookupAttributeArrayType <LookupAttribute> LookupAttributeType <Name> string </Name> <Value> string </Value> </LookupAttribute> <!-- ... more LookupAttribute nodes here ... --> </LookupAttributeArray> <LotSize> int </LotSize> <MotorsGermanySearchable> boolean </MotorsGermanySearchable> <PaymentDetails> PaymentDetailsType <DaysToFullPayment> int </DaysToFullPayment> <HoursToDeposit> int </HoursToDeposit> </PaymentDetails> <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods> <!-- ... more PaymentMethods nodes here ... --> <PayPalEmailAddress> string </PayPalEmailAddress> <PictureDetails> PictureDetailsType <GalleryDuration> token </GalleryDuration> <GalleryType> GalleryTypeCodeType </GalleryType> <GalleryURL> anyURI </GalleryURL> <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay> <PictureURL> anyURI </PictureURL> <!-- ... more PictureURL nodes here ... --> </PictureDetails> <PostalCode> string </PostalCode> <PrimaryCategory> CategoryType <CategoryID> string </CategoryID> </PrimaryCategory> <PrivateListing> boolean </PrivateListing> <PrivateNotes> string </PrivateNotes> <ProductListingDetails> ProductListingDetailsType <BrandMPN> BrandMPNType <Brand> string </Brand> <MPN> string </MPN> </BrandMPN> <EAN> string </EAN> <IncludePrefilledItemInformation> boolean </IncludePrefilledItemInformation> <IncludeStockPhotoURL> boolean </IncludeStockPhotoURL> <ISBN> string </ISBN> <ListIfNoProduct> boolean </ListIfNoProduct> <ProductID> string </ProductID> <ProductReferenceID> string </ProductReferenceID> <ReturnSearchResultOnDuplicates> boolean </ReturnSearchResultOnDuplicates> <TicketListingDetails> TicketListingDetailsType <EventTitle> string </EventTitle> <PrintedDate> string </PrintedDate> <PrintedTime> string </PrintedTime> <Venue> string </Venue> </TicketListingDetails> <UPC> string </UPC> <UseFirstProduct> boolean </UseFirstProduct> <UseStockPhotoURLAsGallery> boolean </UseStockPhotoURLAsGallery> </ProductListingDetails> <Quantity> int </Quantity> <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice> <ReturnPolicy> ReturnPolicyType <Description> string </Description> <EAN> string </EAN> <RefundOption> token </RefundOption> <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> <ShippingDetails> ShippingDetailsType <CalculatedShippingRate> CalculatedShippingRateType <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts> <MeasurementUnit> MeasurementSystemCodeType </MeasurementUnit> <OriginatingPostalCode> string </OriginatingPostalCode> <PackageDepth> MeasureType (decimal) </PackageDepth> <PackageLength> MeasureType (decimal) </PackageLength> <PackageWidth> MeasureType (decimal) </PackageWidth> <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts> <ShippingIrregular> boolean </ShippingIrregular> <ShippingPackage> ShippingPackageCodeType </ShippingPackage> <WeightMajor> MeasureType (decimal) </WeightMajor> <WeightMinor> MeasureType (decimal) </WeightMinor> </CalculatedShippingRate> <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost> <ExcludeShipToLocation> string </ExcludeShipToLocation> <!-- ... more ExcludeShipToLocation nodes here ... --> <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 nodes here ... --> </InternationalShippingServiceOption> <!-- ... more InternationalShippingServiceOption nodes here ... --> <PaymentInstructions> string </PaymentInstructions> <PromotionalShippingDiscount> boolean </PromotionalShippingDiscount> <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 here ... --> <ShippingType> ShippingTypeCodeType </ShippingType> </ShippingDetails> <ShippingTermsInDescription> boolean </ShippingTermsInDescription> <ShipToLocations> string </ShipToLocations> <!-- ... more ShipToLocations nodes here ... --> <Site> SiteCodeType </Site> <SKU> SKUType (string) </SKU> <SkypeContactOption> SkypeContactOptionCodeType </SkypeContactOption> <!-- ... more SkypeContactOption nodes here ... --> <SkypeEnabled> boolean </SkypeEnabled> <SkypeID> string </SkypeID> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> <Storefront> StorefrontType <StoreCategory2ID> long </StoreCategory2ID> <StoreCategoryID> long </StoreCategoryID> </Storefront> <SubTitle> string </SubTitle> <ThirdPartyCheckout> boolean </ThirdPartyCheckout> <ThirdPartyCheckoutIntegration> boolean </ThirdPartyCheckoutIntegration> <Title> string </Title> <UseTaxTable> boolean </UseTaxTable> <UUID> UUIDType (string) </UUID> <VATDetails> VATDetailsType <BusinessSeller> boolean </BusinessSeller> <RestrictedToBusiness> boolean </RestrictedToBusiness> <VATPercent> float </VATPercent> </VATDetails> </Item> </VerifyAddItemRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Standard Input Fields [Jump to call-specific 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. For AddItem and related calls, this field is only applicable when the listing includes Item Specifics and Pre-filled Item Information (such as AttributeSetArray and ProductListingDetails). Default: BestEffort. Applicable values: • AllOrNothing (in) If any attribute data is invalid, drop the entire attribute set and proceed with listing the item. If the category has required attributes and the attribute set is 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. • 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. |
| ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong |
| MessageID | string | Optional |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
| Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
| WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level. |
| Call-specific Input Fields | |||
| ExternalProductID | ExternalProductIDType | Conditional |
Deprecated. This field will be removed from the schema in a future release. Recommended usage as of release 439 varies for eBay.com listings and Half.com listings. For eBay.com listings: As of release 439, this field can still be passed in, but we recommend that you update your applications to use the ExternalProductID field defined on the item instead (i.e., Item.ExternalProductID). If you specify both Item.ExternalProductID and this field in the same request, eBay uses the value in Item.ExternalProductID and ignores the value in this field. See Item.ExternalProductID for information on using an external ID for eBay.com listings. For Half.com listings: As of release 439, this field is required for Half.com listings. Causes Half.com to list the item with Pre-filled Item Information based on an ISBN value or other supported external ID, plus other meta-data that you specify. See the eBay Web Services guide for information about listing to Half.com. |
| IncludeExpressRequirements | boolean | Optional |
Deprecated as of version 579. Currently ignored. Indicates if the response should include detailed data relating to whether an item would qualify as an Express listing. For information about the Express-related data that can be returned when IncludeExpressRequirements is set to true, see the response of VerifyAddItem and see the eBay Web Services Guide. Default: false. Deprecation version: 579. See also Deprecated Objects. |
| Item | ItemType | Required | ItemType object, the properties of which define the new item listing. |
| Item.ApplicationData | string | Optional |
Returns custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField. Not applicable to Half.com, use SellerInventoryID instead. Max length: 32. |
| Item.ApplyShippingDiscount | boolean | Optional |
Multiple Item Shipping Discount. Seller specifies as input when listing, re-listing, or revising an item to indicate whether a shipping discount is to be applied when the buyer pays for the item in the checkout process and the item's transaction is combined with other transactions into an order. Returned with retrieved item data, indicating a shipping discount is applicable. Not returned by GetItem (see Item.ShippingDetails.ShippingDiscount instead). ApplyShippingDiscount can only be used if the user has not set up a shipping discount profile. Not applicable to Half.com. |
| Item.AttributeArray | AttributeArrayType | Required |
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 AttributeSetArray instead. |
| Item.AttributeArray.Attribute | AttributeType | Required,
repeatable: [1..*] |
Only applicable to Half.com. Not applicable to eBay listings. You can revise this field for Half.com listings. |
| Item.AttributeArray.Attribute [ attribute attributeLabel ] |
string | Conditional | Name of the attribute being specified. This is not part of eBay's standard Item Specifics format (i.e., there is no relationship to GetAttributesCS). For GetCategoryListings, this returns the value "Condition" to identify the item condition attribute. For GetOrders, this is always returned for Half.com orders. (It is not applicable to orders on the eBay.com site.) For Half.com, see the eBay Web Services Guide for valid input values. For Half.com, this field is required when you use AddItem. You can revise this value for Half.com listings. |
|
Item.AttributeArray.Attribute .Value |
ValType | Conditional,
repeatable: [0..*] |
A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings. |
|
Item.AttributeArray.Attribute .Value.ValueLiteral |
string | Conditional |
The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute. For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID. For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings. Max length: see description. |
| Item.AttributeSetArray | AttributeSetArrayType | Conditional |
AttributeSetArray is one format that is used to to specify Item Specifics on the eBay Web site. (Also see Item.ItemSpecifics.) Item Specifics describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard property of a book. Contains one or more instances of AttributeSet in a list. For attributes in general, an item can be associated with no more than two full attribute sets (one for the primary category and one for the secondary category). For some international sites, an item can specify an additional site-wide attribute set for the item condition. Older applications can still use AttributeSetArray to specify a return policy (which is defined in a site-wide attribute set for most sites). However, as eBay may deprecate return policy attributes in the future, we strongly recommend that you use the new Item.ReturnPolicy node instead to specify the seller's return policy. Note: AttributeSetArray does not support the newer "custom Item Specifics" model. See the ItemSpecifics node instead. For the AddItem family of calls: Some categories (such as Event Tickets and US Real Estate) require Item Specifics. See the eBay Web Services Guide links below for information on working with Item Specifics. Use GetCategory2CS and GetAttributesCS to determine when attributes are required for a category. Also use attributes to specify the item condition. For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add attributes. If the listing has bids but ends in more than 12 hours, you cannot change existing attribute data, but you can add attributes that were not previously specified. The most reliable way to do this is to pass in the entire AttributeSetArray with all the attributes you want in the listing (not just the ones you want to change, because that usually causes the others to be removed). To delete all attributes when you revise or relist, specify Item.AttributeSetArray in DeletedField and don't pass AttributeSetArray in the request. If the original listing's attributes are no longer valid and you get errors when you try to revise the listing, you can try to pass in the entire AttributeSetArray again with corrections. If that doesn't work, you can end the item and relist it with a set of valid attributes. For GetCategoryListings only: For GetCategoryListings, AttributeSetArray can return the item condition (not other Item Specifics), if specified. For GetSearchResults only: GetSearchResults can return the item condition when the request either specifies IncludeCondition as true; or specifies a product finder search (and a detail level of ItemReturnAttributes or ReturnAll). If IncludeCondition was true, see the ItemSpecific node for a simpler view of the condition value. Note: AttributeSetArray only returns the condition attribute's ValueID. You would need to use GetAttributesCS to figure out the meaning of this ID. It's easier to just look at the ItemSpecific node. If SearchRequest or TicketFinder was used to perform a product finder search, the list of attributes is limited to Item Specifics that would be included in the summary search results on the Web site, if any. At this time, GetSearchResults only returns event ticket venue name, section, and row (if specified) for eBay US (site 0); and the mileage and year for eBay Motors vehicles (site 100 and international eBay Motors sites that support this feature). In other categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.) For GetItemRecommendations only: In GetItemRecommendations, if you use the Suggested Attributes engine, the engine interprets attributes you pass in as attributes that do NOT need recommendations (i.e., attributes that the seller has already filled in as desired). The engine only returns recommendations for attributes that you do not specify, and only for attributes associated with the primary category. For Half.com, this is only returned in GetItem. It is not applicable in AddItem and other requests. See:
|
|
Item.AttributeSetArray .AttributeSet |
AttributeSetType | Conditional,
repeatable: [0..*] |
Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way. For the AddItem family of calls and GetItem, an AttributeSetArray can contain a maximum of 2 full attribute sets (one for each category in which the item is listed) if the primary and secondary categories are mapped to different characteristic sets. If they are mapped to the same characteristic set, the AttributeSetArray can contain one full attribute set. An AttributeSetArray can also contain any number of additional site-wide attribute sets. In item-listing requests, AttributeSet is required if the category is mapped to a characteristic set with required attributes. On the US site, attributes are usually required for Tickets, eBay Motors vehicles, and Real Estate listings. See GetCategory2CS and GetAttributesCS. See the Developer's Guide for information about attribute meta-data and validation rules that are applicable when listing items. In GetItem, the Half.com item condition may be returned once in an AttributeSet node with Half.com IDs and values, and once in a separate AttributeSet node with a site-wide eBay item condition. The Half.com IDs are not necessarily returned in GetAttributesCS, so you can use the eBay.com data instead. Half.com listings may also return an AttributeSet node with other eBay attributes. |
| Item.AttributeSetArray .AttributeSet [ attribute attributeSetID ] |
int | Conditional | Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristics set ID. Call GetCategory2CS to determine valid characteristics set IDs. For GetCategoryListings, you can ignore this value. Not applicable to Half.com. |
| Item.AttributeSetArray .AttributeSet [ attribute attributeSetVersion ] |
string | Conditional |
Version of the attribute set being specified (in requests) or that is currently on the site. This value changes each time changes are made to the category-to-characteristic set mappings or characteristic set data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. In listing requests, if you do not specify this value, eBay assumes you are using the current attribute set version. If you specify the version number of the attribute meta-data that you have stored locally, eBay will compare it to the current version on the site and return a warning if the versions do not match. If an error occurs due to invalid attribute data, this warning can be useful to help you determine if you might be sending outdated data. Not applicable to Half.com. |
|
Item.AttributeSetArray .AttributeSet.Attribute |
AttributeType | Conditional,
repeatable: [0..*] |
A salient aspect or feature of an item in a given category. Attributes are known as "Item Specifics" in the eBay Web site. Use attributes to describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard attribute for books. In item-listing requests, multiple attributes can be specified. Some categories (e.g., Tickets) always require certain attributes to be specified. Therefore, in item-listing requests you need to at least specify "editable" attributes (EditType 0 and EditType 2 attributes) if they are identified as required in the attribute meta-data. See the eBay Web Services guide for information about attrribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required. If you are revising or relisting an item, you don't need to pass in attributes that were already specified in the original listing. To remove an optional attribute, set all its value IDs to "-100". If the item has bids (or items have been sold) but there are more than 12 hours remaining until the listing ends, you can add Attribute nodes but you cannot remove or modify data in previously specified Attribute nodes. If the item has bids and the listing ends within 12 hours, you cannot add or remove Attribute nodes or modify the contents of previously specified Attribute nodes. For GetCategoryListings, this returns the item condition only (and it is only returned if IncludeCondition = true in the request). Not applicable to Half.com. |
| Item.AttributeSetArray .AttributeSet.Attribute [ attribute attributeID ] |
int | Conditional | Constant value that identifies the attribute in a language-independent way. Unique within the attribute set. See the Developer's Guide topics on Item Specifics and Pre-filled Item Information for information about determining valid attribute IDs. Not applicable to Half.com. |
|
Item.AttributeSetArray .AttributeSet.Attribute.Value |
ValType | Conditional,
repeatable: [0..*] |
A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings. |
|
Item.AttributeSetArray .AttributeSet.Attribute.Value .ValueID |
int | Conditional |
Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristic set. In item-listing requests, if the ID is defined as -3 or -6 (Other) in GetAttributesCS or GetProductSellingPages, use ValueLiteral to specify the string value that the user entered. Otherwise, use ValueID to specify the ID that is pre-defined in GetAttributesCS or GetProductSellingPages. In item-listing requests and product searches, the possible ID values are: -3 = User entered an arbitrary value (not an "Other" field) -6 = User entered a value in an "Other" field -100 = Value not specified (null) #### (integer) = Identifier for a pre-defined value that the user selected (e.g., -14 or 1001) For eBay.com, required if ValueList is specified. Not applicable to Half.com. See Attribute Elements. |
|
Item.AttributeSetArray .AttributeSet.Attribute.Value .ValueLiteral |
string | Conditional |
The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute. For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID. For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings. Max length: see description. |
| Item.AutoPay | boolean | Conditional |
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). See the eBay Web Services guide section on Immediate Payment for additional requirements and dependencies. Also see the section on working with the eBay Motors site for additional rules. To create an Immediate Payment listing ThirdPartyCheckout must be true, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and PaymentMethods must be PayPal. For a non-Immediate Payment listing, if ThirdPartyCheckout is true, AutoPay is not supported. Not applicable to Half.com. Default: false. See:
|
| Item.BestOfferDetails | BestOfferDetailsType | Optional |
Container for BestOffer properties associated with the item. Not applicable to Half.com. |
|
Item.BestOfferDetails .BestOfferEnabled |
boolean | Optional | Whether best offer is enabled for this item. A seller of a fixed price format item (in a category for which Best Offer is also enabled) can opt that item into the Best Offer feature. This feature enables a buyer to make a lower priced binding offer on that item. If a listing has no active best offers, you can change this value (true to false, and vice versa). If a listing does have active best offers, you cannot change the value to false. |
| Item.BuyerRequirementDetails | BuyerRequirementDetailsType | Optional |
New Container for buyer requirements. The old container, BuyerRequirements, has been deprecated. All global MyeBay Buyer Requirements are over-ridden by the contents of this container. This means that buyer requirements set in MyeBay cannot be combined with buyer requirements included in this container. When this container is present in an AddItem 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. Not applicable to Half.com. |
|
Item.BuyerRequirementDetails .LinkedPayPalAccount |
boolean | Optional |
If true, only bidders with PayPal accounts may bid. This field can be returned even if the caller is not the seller. For AddItem, the seller's My eBay preference is automatically used with request version 453 and greater. For lower request versions, you must send in explicit BuyerRequirement input even if you have your "global" My eBay preferences set to require PayPal. Default: false. |
|
Item.BuyerRequirementDetails .MaximumBuyerPolicyViolations |
MaximumBuyerPolicyViolationsType | Optional | If provided, blocks bidders who have received the maximum allowed buyer policy violation reports (in a specific time period) from bidding on this item. |
|
Item.BuyerRequirementDetails .MaximumBuyerPolicyViolations .Count |
int | Optional |
Maximum allowed buyer policy violation reports against the buyer. If the limit is reached, the buyer can not bid on this item. Used with Period. Default: 4. |
|
Item.BuyerRequirementDetails .MaximumBuyerPolicyViolations .Period |
PeriodCodeType | Optional |
If a buyer fails to follow eBay policy guidelines for an auction, they may incur a buyer violation report on their account. The Period and Count elements allow a seller to specify that only buyers with a specified number of buyer violation reports within a given period of time can bid on their item. If a buyer has more buyer violation reports than specified within these limits, the buyer can not bid on this item. The Period is the past number of days (last 60 days, last 180 days, etc.) within which the buyer violation reports are calculated. Used with Count. Default: Days_30. Applicable values: • Days_30
• Days_180
• Days_360
(Not all values in PeriodCodeType apply to this field.) |
|
Item.BuyerRequirementDetails .MaximumItemRequirements |
MaximumItemRequirementsType | Optional | If this field is included in your call, you can limit unpaying or low feedback bidders, by setting the MaximumItemCount and MinimumFeedbackScore to define when a bidder is blocked from bidding. Ignored as input if the application uses version 451 or older. |
|
Item.BuyerRequirementDetails .MaximumItemRequirements .MaximumItemCount |
int | Optional | If this field is present, blocking is enabled, where the value of this field represents the maximum number of this seller's items a bidder is allowed to bid on in a 10 day period before being blocked. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 25, 50, 75, 100. |
|
Item.BuyerRequirementDetails .MaximumItemRequirements .MinimumFeedbackScore |
int | Optional |
This field is ignored on input unless MaximumItemCount has been provided. If MaximumItemCount is included in the call, both MaximumItemCount and MinimumFeedbackScore are used to determine whether the bidder is blocked from bidding. A user is blocked from bidding if they have reached or exceeded the MaximumItemCount and the user's feedback score is less than or equal to the value of this field. Valid values: 0, 1, 2, 3, 4, 5. |
|
Item.BuyerRequirementDetails .MaximumUnpaidItemStrikesInfo |
MaximumUnpaidItemStrikesInfoType | Optional | If provided, blocks bidders who have received the maximum unpaid item strikes (in a specific time period) from bidding on this item. |
|
Item.BuyerRequirementDetails .MaximumUnpaidItemStrikesInfo .Count |
int | Optional |
Maximum allowed unpaid item strikes against the buyer. If the limit is reached, the buyer can not bid on this item. Used with Period. Default: 2. |
|
Item.BuyerRequirementDetails .MaximumUnpaidItemStrikesInfo .Period |
PeriodCodeType | Optional |
If a buyer fails to pay for an item, they incur an unpaid item strike on their account. The Period and Count elements allow a seller to specify that only buyers with a specified number of item strikes (or less) within a given period of time can bid on their item. If a buyer has more strikes than specified within these limits, the buyer can not bid on this item. The Period is the past number of days (last 60 days, last 180 days, etc.) within which the unpaid item buyer strikes are calculated. Used with Count. Default: Days_30. Applicable values: • Days_30
• Days_180
• Days_360
(Not all values in PeriodCodeType apply to this field.) |
|
Item.BuyerRequirementDetails .MinimumFeedbackScore |
int | Optional | If true, blocks bidders with this feedback score or lower. Ignored as input if the application uses version 451 or older. Valid values: -3, -2, -1. |
|
Item.BuyerRequirementDetails .ShipToRegistrationCountry |
boolean | Optional |
If true, blocks bidders who are registered in countries where the seller has specified that he will not ship. Ignored as input if the application uses version 451 or older. Default: false. |
|
Item.BuyerRequirementDetails .VerifiedUserRequirements |
VerifiedUserRequirementsType | Optional | If provided, blocks bidders who do not pass a simple check (for example, for credit card on file). Ignored as input if the application uses version 451 or older. |
|
Item.BuyerRequirementDetails .VerifiedUserRequirements .MinimumFeedbackScore |
int | Optional |
This field is ignored unless VerifiedUser is true. If this field is present, the user's feedback score is also considered: a user is blocked from bidding if the user's feedback score is less than or equal to the value of this field. Default: 5. |
|
Item.BuyerRequirementDetails .VerifiedUserRequirements .VerifiedUser |
boolean | Optional |
If true, blocks bidding by users who do not pass a simple check (for example, for credit card on file). See "Buyer Requirements - VerifiedUser" in the chapter "Field Differences for eBay Sites." Default: false. |
|
Item.BuyerRequirementDetails .ZeroFeedbackScore |
boolean | Optional |
If true, blocks bidders with a feedback score of 0 who attempt to bid on Buy It Now items worth 100 RMB or more. Ignored as input if the application uses version 451 or older. This requirement is only enabled for the CN site. Default: false. |
|
Item .BuyerResponsibleForShipping |
boolean | Optional |
Applicable for listings in vehicle categories on the US eBay Motors site and eBay Canada site. (No business effect if specified for other categories or sites, as the Web site will not display the information to buyers.) If true, the buyer is responsible for vehicle pickup or shipping. If false, specify vehicle shipping arrangements in the item description. Default is true. (The description can also include vehicle shipping arrangements when this value is true.) If the item has bids or ends within 12 hours, you cannot modify this flag. Do not specify ShippingDetails.ShippingServiceOptions for vehicle listings. If true and the listing is on the US eBay Motors site, and you want the listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA. If true and the listing is on the eBay Canada site , and you want your listing to be visible on the US eBay Motors site, set Item.ShipToLocations to US. Not applicable to Half.com. |
| Item.BuyItNowPrice | AmountType (double) | Optional |
For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. Once a Chinese auction has bids (and the high bid exceeds the reserve price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. See:
|
| Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
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. (Alternatively, you can auto-fill attributes on the client side by using mapping meta-data returned by GetAttributesCS.) See the eBay Web Services guide for more information. Ignored if the category does not support auto-filling attributes. If you also pass in attributes in AttributeSetArray, your values will override any auto-filled values for the same attributes. Once you have overridden the value of an auto-filled attribute for a given listing, eBay will not auto-fill it on subsequent ReviseItem requests (even if you remove the overridden value). Not applicable to Half.com. |
| Item.CategoryMappingAllowed | boolean | Optional |
Controls how eBay handles cases in which an ID specified in PrimaryCategory and/or SecondaryCategory no longer exists in the current category structure: If you pass a value of true in CategoryMappingAllowed, eBay will look up the current 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. |
| Item.Charity | CharityType | Optional |
Identifies a Giving Works listing and the benefiting nonprofit charity organization selected by the charity seller, if any. If specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods). When you revise an item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. For an auction listing, you can revise an item to add a charity if there are more than 12 hours left for the listing (whether or not the item has bids). For a fixed-price listing, you can revise an item to add a charity if there are more than 12 hours left for the listing, and the item has not been sold. For a Store Inventory listing, you can revise an item to add a charity if the item has not been sold. You cannot revise listings to add charity for Ad Format listings. When you relist an item, use DeletedField to remove charity information. Not applicable to Half.com. See:
|
| Item.Charity.CharityID | string | Conditional | A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items. |
| Item.Charity.CharityNumber | int | Optional | A unique identification number assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. Being superseded by CharityID. Max 10 digits. |
| Item.Charity.DonationPercent | float | Conditional | The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items. |
| Item.Country | CountryCodeType | Required |
Two-letter ISO 3166 country code. In some calls, used with the Location field to indicate the city and country where the item is located. Also applicable as input to AddItem and related calls when you list items to Half.com (specify US). For English names that correspond to each code (e.g., KY="Cayman Islands"), call GeteBayDetails or see the following ISO site: http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html Applicable values: See Country. |
| Item.CrossBorderTrade | string | Optional,
repeatable: [0..*] |
For a fee, enables a listing to be displayed in the default search results of another eBay site. Use this value if you want to take advantage of the International Site Visibility listing upgrade. |
| Item.Currency | CurrencyCodeType | Required |
Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the item-listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item.
Applicable values: • AUD (in/out) Australian Dollar. For eBay, you can only specify this currency for listings you submit to the Australia site (site ID 15). • CAD (in/out) Canadian Dollar. For eBay, you can only specify this currency for listings you submit to the Canada site (site ID 2) (Items listed on the Canada site can also specify USD.) • CHF (in/out) Swiss Franc. For eBay, you can only specify this currency for listings you submit to the Switzerland site (site ID 193). • CNY
• EUR (in/out) Euro. For eBay, you can only specify this currency for listings you submit to these sites: Austria (site 16), Belgium_French (site 23), France (site 71), Germany (site 77), Italy (site 101), Belgium_Dutch (site 123), Netherlands (site 146), Spain (site 186), Ireland (site 205). • GBP (in/out) Pound Sterling. For eBay, you can only specify this currency for listings you submit to the UK site (site ID 3). • HKD (in/out) Hong Kong Dollar. For eBay, you can only specify this currency for listings you submit to the Hong Kong site (site ID 201). • INR (in/out) Indian Rupee. For eBay, you can only specify this currency for listings you submit to the India site (site ID 203). • MYR (in/out) Malaysian Ringgit. For eBay, you can only specify this currency for listings you submit to the Malaysia site (site ID 207). • PHP (in/out) Philippines Peso. For eBay, you can only specify this currency for listings you submit to the Philippines site (site ID 211). • PLN (in/out) Poland, Zloty. For eBay, you can only specify this currency for listings you submit to the Poland site (site ID 212). • SEK (in/out) Swedish Krona. For eBay, you can only specify this currency for listings you submit to the Sweden site (site 218). • SGD (in/out) Singapore Dollar. For eBay, you can only specify this currency for listings you submit to the Singapore site (site 216). • TWD (in/out) New Taiwan Dollar. Note that there is no longer an eBay Taiwan site. • USD (in/out) US Dollar. For eBay, you can only specify this currency for listings you submit to the US (site ID 0), eBayMotors (site 100), and Canada (site 2) sites. (Not all values in CurrencyCodeType apply to this field.) |
| Item.Description | string | Conditional |
Description of the item. In listing requests, you can submit your description using CDATA if you want to use HTML or XML-reserved characters in the description. An error is returned if this contains malicious JavaScript content. (For related eBay policy, see http://pages.ebay.com/help/policies/listing-javascript.html.) The Description field is required for all listings, except certain listings that include Pre-filled Item Information. (See "About the Pre- filled Item Information API." in the eBay Web Services Guide.) Even if your application does not support listings items with Pre-filled Item Information, you should be aware that this also means GetItem, GetSellerList, and GetBidderList may return some items with empty Description fields. If you embed pictures in the description (by using IMG tags) instead of using PictureURL, but you want a camera icon to appear in search and listing pages, specify the following null-image URL in PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif. See "Including Pictures in an Item Listing" in the eBay Web Services Guide. Not applicable to Half.com. (For Half.com, use AttributeArray.Attribute with attributeLabel="Notes" to specify a brief description or note to the buyer.) Max length: 500000 (some sites may allow more, but the exact number may vary). |
| Item.DisableBuyerRequirements | boolean | Optional |
If false (or omitted): if BuyerRequirementDetails are present, those requirements are to be used; otherwise, any requirements specified in My eBay are to be used. If true: no requirements are considered from any source (and if BuyerRequirementDetails are present, they are ignored). Default: false. |
| Item.DispatchTimeMax | int | Conditional |
Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. This time does not include the shipping time (the carrier's transit time). For the AddItem family of calls: Required for listings in certain categories when certain shipping services (with delivery) are offered. See HandlingTimeEnabled in GetCategoryFeatures. The seller sets this 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). To add Get It Fast to listings (for domestic shipping), in addition to setting GetItFast to true, DispatchTimeMax must be set to 1 and the seller must specify at least one qualifying expedited shipping service. 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:
|
|
Item .ExtendedSellerContactDetails |
ExtendedContactDetailsType | Optional | Extended contact information for sellers using the Classified Ad format. Specifies the days and hours when the seller can be contacted. To remove seller contact information when revising or relisting an item, use DeletedField. |
|
Item .ExtendedSellerContactDetails .ClassifiedAdContactByEmailEnabled |
boolean | Optional | Returned for classified ads to indicate whether contact by email is enabled. In the pay-per-lead feature, which will be available in upcoming months on the US site, this field will specify whether potential buyers can email the seller after viewing a pay-per-lead listing. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails |
ContactHoursDetailsType | Optional | All fields related to contact hours including time ranges and user-designated time zone. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours1AnyTime |
boolean | Optional | Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours1Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours1From and Hours1To will be ignored. In the case of this field being false, the values provided Hours1From and Hours1To will be considered. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours1Days |
DaysCodeType | Optional |
Indicates the range of days for which the primary contact hours specified by Hours1AnyTime or Hours1From and Hours1To apply. If a value of None is provided for this field, the values provided for Hours1AnyTime, Hours1From, Hours1To are ignored.
Applicable values: • CustomCode (in/out) Reserved for internal or future use. • EveryDay (in/out) Seller can be contacted any day during the specified contact hours. • None (in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored. • Weekdays (in/out) Seller can be contacted Monday through Friday during the specified contact hours. • Weekends (in/out) Seller can be contacted Saturday or Sunday during the specified contact hours. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours1From |
time | Optional | Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails.Hours1To |
time | Optional | Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours2AnyTime |
boolean | Optional | Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours2Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours2From and Hours2To will be ignored. In the case of this field being false, the values provided Hours2From and Hours2To will be considered. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours2Days |
DaysCodeType | Optional |
Indicates the range of days for which the secondary contact hours specified by Hours2AnyTime or Hours2From and Hours2To apply. If a value of None is provided for this field, the values provided for Hours2AnyTime, Hours2From, Hours2To are ignored. Note: You cannot set Hours2Days to EveryDay. If Hours1Days is set to EveryDay, secondary contact hours do not apply. Hours2Days cannot be set to the same value as Hours1Days. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • EveryDay (in/out) Seller can be contacted any day during the specified contact hours. • None (in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored. • Weekdays (in/out) Seller can be contacted Monday through Friday during the specified contact hours. • Weekends (in/out) Seller can be contacted Saturday or Sunday during the specified contact hours. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours2From |
time | Optional | Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours2Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails.Hours2To |
time | Optional | Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. |
|
Item .ExtendedSellerContactDetails .ContactHoursDetails .TimeZoneID |
string | Optional | Indicates the local time zone of the values provided for Hours1From/Hours1To and Hours2From/Hours2To. If you specify a contact hours time range with Hours1From and Hours1To, you must provide a local time zone. Use GeteBayDetails to retrieve a complete list of the TimeZoneID values supported by eBay. |
| Item.ExternalProductID | ExternalProductIDType | Conditional |
This field will be deprecated in a future project. New applications should use ProductListingDetails instead of ExternalProductID for AddItem and related calls. Contains an ISBN value, UPC value, EAN value, ticket keywords, or eBay catalog product ID. Causes eBay to list the item with Pre-filled Item Information based on the value you specify. Only applicable to certain categories. See the eBay Trading API Guide for information on the categories that currently support usage of this field. For AddItem and VerifyAddItem only: On the US site, if you are listing in a media category, eBay determines the primary category ID based on the product ID you specify (and CategoryID is usually ignored). To avoid confusion (e.g., at revise/relist time), it's a good idea to avoid specifying the primary category in combination with ExternalProductID. Note: There may be cases when the category ID can't be determined and you get an error. If this does occur, then specify the category ID. If you are listing in two categories and both are catalog-enabled, the external ID should be for a product associated with the primary category. If only one category is catalog-enabled, the external ID should be for a product that is associated with the catalog-enabled category. If you are listing an event ticket, the primary category is required, and the external ID must be associated with the primary category. Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem (or VerifyAddItem) request. Do not specify both. If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL and IncludePrefilledItemInformation to true automatically. Optional for eBay.com listings. Applicable to Half.com listings. For ReviseItem and RelistItem only: ExternalProductID is not applicable when revising and relisting items (use Item.ProductListingDetails instead). For GetItemRecommendations only: In GetItemRecommendations, only applicable when the value of ListingFlow is AddItem. Not applicable when the recommendation engine is ProductPricing. See:
|
|
Item.ExternalProductID .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 value passed in Value. Only takes effect when more than one match is found. If true, the response should include an error and all matching product IDs. If false, the response should include an error but should not return the matching product IDs. This field is also applicable when listing Half.com items. |
| Item.ExternalProductID.Type | ExternalProductCodeType | Conditional |
The kind of identifier being used. The choices are listed For requests, required if Value is specified. For Half.com listing use cases, only ISBN, UPC, and EAN are supported. GetProducts supports ISBN, UPC, and EAN. Applicable values: • CustomCode (in) Reserved for internal or future use • EAN (in/out) ExternalProductID.Value contains an EAN value. Required when you pass an EAN as the external product ID. • ISBN (in/out) ExternalProductID.Value contains an ISBN value. Required when you pass an ISBN as the external product ID. (This value is also applicable to Half.com listings.) • Keywords (in) ExternalProductID.Value contains a set of keywords that uniquely identify the product. Only applicable when listing event ticket. See the eBay Web Services guide for information about valid ticket keywords for an external product ID. Required when you pass a set of keywords as the external product ID. Not applicable with GetSearchResults or GetProducts. With GetSearchResults, use TicketFinder instead. • ProductID (in) ExternalProductID.Value contains an eBay catalog product ID. Required when you pass an eBay product ID as the external product ID. Not applicable with GetSearchResults or GetProducts. • UPC (in/out) ExternalProductID.Value contains a UPC value. Required when you pass a UPC as the external product ID. (This value is also applicable to Half.com listings.) (Not all values in ExternalProductCodeType apply to this field.) |
| Item.ExternalProductID.Value | string | Conditional |
An industry-standard value that uniquely identifies the product. The valid values are dictated by the Type property. Required if Type is specified. Max length 13 for ISBN (as of February 2007), 13 for EAN, 12 for UPC, and 4000 for ProductID. No max length for ticket keywords (but passing too much data can result in "no match found" errors). For AddItem and related calls: If the primary and secondary categories are both catalog-enabled, the value must apply to the primary category. Event tickets listings support a set of keywords that uniquely identify the listing. The ticket keywords specify the event name (the title shown on the ticket), venue name, and event date and time. See the eBay Web Services guide for more information and validation rules. For convenience, you can pass an eBay product ID as input (not limited to media categories). Required for Half.com listing use cases, and this can only be an ISBN, UPC, or EAN value. For GetSearchResults and GetProducts input only: Only ISBN, EAN, and UPC values are currently supported as input. For GetProducts and GetSellerPayments output only: Also see AlternateValue, which is returned if the catalog defines multiple ISBN values (e.g., one for ISBN-13 and one for ISBN-10). Please note that some catalogs return ISBN values that are not 10 or 13 characters, and some values contain non-alphanumeric symbols (e.g., $). Max length: See description. |
| Item.GetItFast | boolean | Optional |
Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Not supported for UK Store Inventory format items. Not applicable to Half.com. See:
|
| 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 is returned instead of true/false. When the Top-Rated Seller program becomes operational in October 2009, some enhanced listing features will be removed or restricted to certain sellers on some sites. Use GeteBayDetails ListingFeatureDetails for more information. Not applicable to Half.com. |
| Item.GiftServices | GiftServicesCodeType | Optional,
repeatable: [0..*] |
Optional gift services that the seller is offering if the buyer chooses to purchase the item as a gift. Only returned if offered by the seller. When the Top-Rated Seller program becomes operational in October 2009, some enhanced listing features will be removed or restricted to certain sellers on some sites. Use GeteBayDetails ListingFeatureDetails for more information. Not applicable to Half.com. Applicable values: • CustomCode (in/out) Reserved for internal or future use • GiftExpressShipping (in/out) The seller is offering to ship the item via an express shipping method as explained in the item description. • GiftShipToRecipient (in/out) The seller is offering to ship to the gift recipient (instead of to the buyer) after payment clears. • GiftWrap (in/out) The seller is offering to wrap the item (and optionally include a card) as explained in the item description. |
| Item.HitCounter | HitCounterCodeType | Optional |
Indicates whether an optional hit counter is displayed on the item's listing page and, if so, what type. See HitCounterCodeType for specific values. Not applicable to Half.com. Applicable values: • BasicStyle (in/out) A basic style hit counter. • CustomCode (in/out) Reserved for internal or future use • GreenLED (in/out) A green LED, computer-style hit counter (US only). Non-US sites will return errors if they use GreenLED as input, and should use RetroStyle instead. • Hidden (in/out) A hidden hit counter (US only). The number of page views will only be available to the item's seller. For faster "View Item" page loads, use HiddenStyle. • HiddenStyle (in/out) A hidden hit counter. The number of page views will only be available to the item's seller. • HonestyStyle (in/out) A basic style hit counter (US only). Non-US sites will return errors if they use HonestyStyle as input, and should use BasicStyle instead. • NoHitCounter (in/out) No hit counter. The number of page views will not be available. • RetroStyle (in/out) A retro, computer-style hit counter. |
| Item.ItemSpecifics | NameValueListArrayType | Optional |
A list of attribute or 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. Note: If you are including an item condition, many categories may only support condition-based searches if you use AttributeSetArray or LookupAttributeArray. In these cases, you can use AttributeSetArray or LookupAttributeArray for the condition, and ItemSpecifics for the custom Item Specifics. To determine which categories support custom Item Specifics, use GetCategoryFeatures. Note: If you are trying to list with ID-based attributes from GetAttributesCS or GetProductSellingPages, use AttributeSetArray instead. To retrieve recommended Item Specifics, use GetCategorySpecifics or GetItemRecommendations. In GetItemRecommendations, pass in the PrimaryCategory and (optionally) Title to retrieve recommended names and values. 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. With GetProducts, only the item condition is returned at the item level. Additional attributes that were pre-filled from the catalog are returned in Product.ItemSpecifics. See:
|
|
Item.ItemSpecifics .NameValueList |
NameValueListType | Conditional,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. |
|
Item.ItemSpecifics .NameValueList.Name |
string | Optional |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations. |
|
Item.ItemSpecifics .NameValueList.Value |
string | Optional,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 50 (see GeteBayDetails). |
| Item.LimitedWarrantyEligible | boolean | Conditional |
Applicable to US eBay Motors vehicle listings only. If false, the vehicle will not be considered for a limited warranty by eBay. If your application lists Motors vehicles, you must provide the seller with an opportunity to indicate whether the vehicle has not been modified and is not a special type (e.g., Corvette ZR1). If LimitedWarrantyEligible is passed in, it means the application has presented the seller with checkboxes to indicate this information. If true, the seller has verified that the vehicle has not been modified and is not a special type. If false, the seller has verified that vehicle has been modified or it is a special type. Passing a value of true does not guarantee that eBay will offer a limited warranty. It only makes the listing eligible for consideration. See the eBay Web Services Guide for more information about Motors vehicle listings. Not applicable to Half.com. |
|
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. |
|
Item .ListingCheckoutRedirectPreference .ProStoresStoreName |
string | Conditional |
The name of the store, if ThirdPartyCheckout is true. To remove this value when revising or relisting an item, use DeletedField. Max length: 200. |
|
Item .ListingCheckoutRedirectPreference .SellerThirdPartyUsername |
string | Conditional |
The user name of the associated store, if ThirdPartyCheckout is true. To remove this value when revising or relisting an item, use DeletedField. Max length: 200. |
| Item.ListingDesigner | ListingDesignerType | Optional |
Contains the detail data for the Listing Designer theme and template (if either are used), which can optionally be used to enhance the appearance of the description area of an item's description. See ListingDesignerType for its child elements. Not applicable to Half.com. |
| Item.ListingDesigner.LayoutID | int | Optional | Identifies the Layout template to use when displaying the item's description. Call GetDescriptionTemplates for valid IDs. Set to false in GetDescriptionTemplates (or do not specify LayoutID) to get the standard layout. If a Listing Designer layout is used (except standard layout), PhotoDisplayType must be false (or not be specified). When relisting an item, LayoutID is removed from the listing if you specify ListingDesignerType without LayoutID. Alternatively, to remove this value when revising or relisting an item, use DeletedField. |
|
Item.ListingDesigner .OptimalPictureSize |
boolean | Optional | If true, indicates that the item's picture will be enlarged to fit description of the item. |
| Item.ListingDesigner.ThemeID | int | Optional | ID for the Listing Designer theme template to use when displaying the item's description. When relisting, if you specify ListingDesignerType without ThemeID, ThemeID is removed from the listing. Alternatively, to remove this value when revising or relisting an item, use DeletedField. |
| Item.ListingDetails | ListingDetailsType | Optional |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. |
|
Item.ListingDetails .BestOfferAutoAcceptPrice |
AmountType (double) | Optional | The price at which best offers are automatically accepted. Similar in use to MinimumBestOfferPrice. If a buyer submits a best offer that is above this value, the offer is automatically accepted by the seller. Applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature. Best Offer must be enabled for the item, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response. On the US eBay Motors site (site ID 100), you cannot use the API to add a minimum best offer price. For a ReviseItem call with site ID 100, prior use of a minimum best offer price on eBay.com is ignored. |
| Item.ListingDetails .BestOfferAutoAcceptPrice [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ListingDetails .MinimumBestOfferMessage |
string | Optional |
Deprecated as of version 547. Currently ignored. Specifies the message sent from the seller to the buyer when a submitted best offer is automatically declined by the seller. A best offer is automatically declined if it does not meet the minimum acceptable best offer price specified by the seller with MinimumBestOfferPrice. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item. To remove this value when revising or relisting an item, use DeletedField. Deprecation version: 547. See also Deprecated Objects. |
|
Item.ListingDetails .MinimumBestOfferPrice |
AmountType (double) | Optional | Specifies the minimum acceptable best offer price. If a buyer submits a best offer that is below this value, the offer is automatically declined by the seller. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item, and only the seller who listed the item can see this value. To remove this value when revising or relisting an item, use DeletedField. |
| Item.ListingDetails .MinimumBestOfferPrice [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ListingDetails .PayPerLeadEnabled |
boolean | Optional |
If true as an input or output field, the item is pay-per-lead-enabled. This field applies to the pay-per-lead feature, which is planned for availability on the US site in upcoming months. Default: false. |
| 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:
Applicable values: See ListingDurationCodeType |
| Item.ListingEnhancement | ListingEnhancementsCodeType | Optional,
repeatable: [0..*] |
Describes listing upgrades that sellers can select for a fee, such as the BoldTitle upgrade. Also includes feature packs for saving on listing upgrades. See Listing Upgrades in the eBay Web site online 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: • BasicUpgradePackBundle (in/out) No longer applicable to any site. Formerly, a feature pack applicable to the Australia site (site ID 15, abbreviation AU) only. Contained the Gallery and Subtitle features. • BoldTitle (in/out) If specified, the seller wants the title for the item's listing to be in boldface type. Applicable listing fees apply. Does not affect the item subtitle (Item.SubTitle), if any. Not applicable to eBay Motors. • Border (in/out) If specified, the seller wants the item to be displayed with a border that goes around the item in search result pages that return multiple items. The border differentiates the item from other items in the list. Applicable listing fees apply. • CustomCode (in/out) Reserved for internal or future use. • Featured (in/out) Listing is a "Featured Plus" item. The item will display prominently in the Featured Items section of its category list, and it will stand out on search results pages. It will also display in the regular, non- featured item list. Only available to users with a Feedback rating of 10 or greater. • Highlight (in/out) Listing is highlighted in a different color in lists. • HomePageFeatured (in/out) Listing will have a chance to rotate into a special display on eBay's Home page. Your item is very likely to show up on the Home page, although eBay does not guarantee that your item will be highlighted in this way. This is the highest level of visibility on eBay. • ProPackBundle (in/out) Listing is using ProPackBundle (a feature pack). Applies only to US and Canadian eBay motor vehicle sellers. Contains the BoldTitle, Border, Featured and Highlight features. • ProPackPlusBundle (in/out) Support for this feature varies by site and category. A ProPackPlusBundle listing is using ProPackPlus bundle (a feature pack), which combines the features of BoldTitle, Border, Highlight, Featured (which is equivalent to a GalleryType value of Featured), and Gallery, for a discounted price. Note that if, for example, in AddItem, if you use ProPackPlusBundle and a GalleryType value of Gallery, then the resulting item will have a GalleryType value of Featured. • ValuePackBundle (in/out) Listing is using ValuePack bundle (a feature pack), which combines the features Gallery, Subtitle, and Listing Designer for a discounted price. Support for this feature varies by site and category. |
| Item.ListingType | ListingTypeCodeType | Conditional |
The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese 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). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611.
• Express Deprecated as of version 561.
• FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • Half (in/out) Half.com listing (item is listed on Half.com, not on eBay). You must be a registered Half.com seller to use this format. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) See:
|
| Item.Location | string | Conditional |
Indicates the geographical location of the item (along with Country). 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 eBay Motors vehicles, the value provided in the Location is used as item location only if the SellerContactDetails.Street and the SellerContactDetails.Street2 are empty. Else, the SellerContactDetails.Street and the SellerContactDetails.Street2 will be used for item location. Also applicable as input to AddItem and related calls when you list items to Half.com. Max length: 45. |
| Item.LookupAttributeArray | LookupAttributeArrayType | Optional |
Use this as a shortcut for specifying the Condition attribute by name instead of by ID. Only valid when listing items in categories that support product details (catalog-enabled categories). You can pass either AttributeSetArray or LookupAttributeArray, but you cannot pass both in the same request. This also means that if you subsequently revise the listing's attributes, you need to specify the condition attribute ID and value ID in AttributeSetArray to prevent them from being dropped from the listing. Typically used in combination with ProductListingDetails. Not applicable to Half.com. |
|
Item.LookupAttributeArray .LookupAttribute |
LookupAttributeType | Optional,
repeatable: [0..*] |
The condition of the item. |
|
Item.LookupAttributeArray .LookupAttribute.Name |
string | Optional | The literal name of the attribute. For the US site, pass "Condition" (without quotes). Not applicable to Half.com. |
|
Item.LookupAttributeArray .LookupAttribute.Value |
string | Optional |
The attribute's literal value (i.e., not the value ID), as it is returned in GetAttributesCS. For this US site, this could be a literal like "Brand New" (without quotes) for a book or "New, Never Opened" for a camera. The value is not case-sensitive, but all spaces and punctuation need to match the attribute's literal value. Not applicable to Half.com. eBay uses this value to set the correct attribute ID and value ID on the item. This means you need to specify the correct value for the primary category (which is either the category you specify in PrimaryCategory or the category that eBay sets based on the product you identify in ProductListingDetails or ExternalProductID. In GetItem, the condition is returned in AttributeSetArray. |
| Item.LotSize | int | Optional |
A lot is a set of two or more similar items that must be purchased together in a single transaction. A listing can have multiple lots (instead of multiple items). When LotSize is specified, the listing price reflects the price of each lot (not each item within the lot). In this case, Quantity indicates the number of lots being listed, and LotSize indicates the number of items in each lot. (If a listing has no lots, Quantity indicates the number of separate items being listed.) Important: Lot items can be listed only in lot-enabled categories. GetCategories returns LSD (lot size disabled) with a value of true for categories that do not support lots. Not applicable to Half.com. Max: 100000. |
| Item.MotorsGermanySearchable | boolean | Optional |
Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany. If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. See the eBay Web Services Guide for applicable categories, revise and relist rules, and additional information on featuring vehicles on the Mobile.de Site. Not applicable to Half.com. |
| Item.PaymentDetails | PaymentDetailsType | Optional |
Contains data associated with eBay Motors payments (Durations for deposit and full payments). Returned for Motors listings. Not applicable to Half.com. |
|
Item.PaymentDetails .DaysToFullPayment |
int | Optional |
Applies to vehicle categories on the US and Canada eBay Motors sites (not Parts and Accessories categories). Number of days after a listing closes that the buyer can take to pay the full cost of the vehicle. The choices are 3, 7, 10, and 14, and the default is 7. PayPal and credit cards cannot be used to pay the full cost of a vehicle, so the listing must offer MOCC (cashier's check), PersonalCheck, LoanCheck, CashInPerson, and/or PaymentSeeDescription as payment methods. Default: 7. |
|
Item.PaymentDetails .HoursToDeposit |
int | Optional |
Applies to US eBay Motors site (except Parts and Accessories category). Number of hours after a listing closes that the buyer can put down a deposit on an item (if the seller specified a deposit). Only takes effect if listing also includes the Deposit Amount and Deposit Type attributes (see AttributeSetArray). The choices are 24, 48, and 72, and the default is 48. Deposits can only be paid using PayPal, so the listing must offer PayPal as a payment method (in addition to the payment methods offered for the full payment). Default: 48. |
| Item.PaymentMethods | BuyerPaymentMethodCodeType | Conditional,
repeatable: [0..*] |
Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. 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 Schema" in the eBay Web Services guide. Note: Required or allowed payment methods vary by site and category. Refer to Payment Method Differences (PaymentMethod) in the eBay Trading API Guide for information 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. For GetProducts only: Only PayPal is returned in product search results. Applicable values: See PaymentMethods. See:
|
| 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:
|
| Item.PictureDetails | PictureDetailsType | Optional |
Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. |
|
Item.PictureDetails .GalleryDuration |
token | Optional |
Describes the number of days that "Featured" Gallery type applies to a listing. Applicable values include 'Days_7' and 'LifeTime'. When a seller chooses "Featured" as the Gallery type, the listing is highlighted and is included at the top of search results. This functionality is applicable only for Gallery Featured items and returns an error for any other Gallery type. Additionally, an error is returned if the seller attempts to downgrade from Lifetime to limited duration, but the seller can upgrade from limited duration to Lifetime duration. This field is not applicable to auction listings. Applicable values: See ListingEnhancementDurationCodeType |
|
Item.PictureDetails .GalleryType |
GalleryTypeCodeType | Conditional |
Indicates whether listing images are included in the search results (in both Picture Gallery and List Views) and, if so, which image listing enhancements apply to them. Items that have pictures but do not have image listing enhancements display a generic photo image in search results. If the value is Gallery, Plus, or Featured, eBay checks the available image URLs in the following order to determine which URL to use (if more than one of these URLs is available): a) Use the URL in GalleryURL, if it is specified. b) Otherwise, if ProductListingDetails.UseStockPhotoURLAsGallery is true, use the eBay stock photo. c) Otherwise, use the value of the first PictureURL in the array of PictureURL fields, if any. d) Otherwise, if ProductListingDetails.ProductID is specified, use the eBay stock photo for that ProductID (eBay resets UseStockPhotoURLAsGallery to true in this case). e) If eBay is unable to find an image URL for the listing, an error is returned. Note that you can use the Gallery Plus feature whether or not the image is hosted with eBay Picture Services (EPS). Selecting Gallery Plus does not incur a separate Gallery fee. See "Describing Items in a Listing" in the eBay Web Services Guide for additional information about working with pictures and related validation rules. You cannot remove Gallery, Plus, or Featured when revising an item, however you can upgrade to a higher feature. On upgrade, the original feature fee is credited, and the new feature fee is charged. There are a number of categories on some eBay sites that always offer the Gallery feature for free. (The API doesn't flag these categories in any meta-data calls.) In these categories, if you specify a picture and you don't specify GalleryType, eBay may add GalleryType=Gallery to the listing (for free) and return a warning (error code 219243). The Knowledge Base explains an edge case that could result in an unexpected gallery fee if the seller moves the item to a category that doesn't offer the free gallery feature. This fee can also appear when if the seller moves the item from a site that offers free Gallery (across all its categories) to one where free Gallery is not yet available. Whenever you change the primary category, it is a good idea to clearly specify whether the seller is intentionally requesting the gallery option. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), UK (site ID 3), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay will automatically create a Gallery thumbnail for the listing in search results by selecting a picture from one of the image URLs specified in the request (either Item.PictureDetails.PictureURL or Item.PictureDetails.GalleryURL) or from an available stock photo. Thus, a Gallery thumbnail will be created whenever Item.PictureDetails.GalleryType is None or is not specified in the request. A Gallery fee will apply whenever GalleryType specifies the Plus or Featured image enhancements (there will be no Gallery fee whenever GalleryType is Gallery, None or is not specified in the request). eBay will select the image for the thumbnail depending on which of the image URLs above was specified in the request (there are selection rules for four cases). Note that the selected image will not necessarily be the image you have specified in Item.PictureDetails.GalleryURL. Note that a Gallery thumbnail will not be automatically created if PictureURL and GalleryURL are not supplied and UseStockPhotoURLAsGallery and IncludeStockURL are set to false. The most common case occurs when both GalleryURL and PictureURL are specified in the request. eBay will use the image referenced by PictureURL as the Gallery thumbnail. As three other cases exist, please refer to "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information on how eBay selects an image for the gallery thumbnail on these sites. You cannot remove Gallery or Featured when revising an item, however you can upgrade to a higher feature. On upgrade, the original feature fee is credited, and the new feature fee is charged. (This does not apply to Gallery Plus on sites with free Gallery; see Plus below for more information.) Applicable values: • CustomCode (in/out) Reserved for internal or future use. • Featured (in/out) Listing is highlighted and included at the top of search results. • Gallery (in/out) Listing image is included in the search results (in both Picture Gallery and List Views). Items that have pictures but do not have the Gallery feature will have a generic photo image shown in search results. • None (in/out) Listing image is not included in the search results (in either Picture Gallery or List Views), and no other image listing enhancements apply. Items that have pictures but do not have image listing enhancements display a generic photo image in search results. • Plus (in/out) Listing image has Gallery Plus funtionality. That is, listing includes a Gallery Plus icon that, when moused over or clicked, displays a large (400 px x 400 px) preview image of the item. Clicking the image displays the View Item page for that listing. See:
|
| Item.PictureDetails.GalleryURL | anyURI | Conditional |
URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CA (site ID 2), UK (site ID 3), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. 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. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. See:
|
|
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. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0.
Applicable values: • CustomCode (in/out) Reserved for internal or future use. • None (in/out) No special image display options. Valid for US Motors listings. • PicturePack (in/out) Increase the number of images displayed. 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. • SiteHostedPictureShow (in/out) This value is no longer applicable. Formerly, the value displays multiple, site-hosted pictures in a slideshow format. • 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. • SuperSizePictureShow (in/out) This value is no longer applicable. Use SuperSize instead. Formerly, the value displays multiple, super-size, site-hosted pictures in a slideshow format. Valid for US Motors listings. • VendorHostedPictureShow (in/out) This value is no longer applicable. Formerly, the value displays multiple, vendor-hosted pictures in a slideshow format. Not valid for US Motors listings. (Not all values in PhotoDisplayCodeType apply to this field.) |
| Item.PictureDetails.PictureURL | anyURI | Conditional,
repeatable: [0..*] |
Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CA (site ID 2), UK (site ID 3), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. 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 stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). As a result of these changes, the top of an item's listing page may not necessarily be the image you have specified in PictureURL for certain scenarios. For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. Contains the URL for an image associated with the item. Images can be hosted by eBay Picture Services (EPS) (or by eBay Picture Manager) or they can be self-hosted. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL value. If specified, this cannot have an empty/null value. To specify multiple pictures, send each URL in a separate, adjacent PictureURL element. In most cases, the image at the first URL is also used for the picture at the top of the View Item page on the Web site. On the main eBay site, a listing can have a maximum of 12 picture URLs hosted by eBay Picture Services or 1 picture URL hosted by a third-party vendor. You cannot mix vendor-hosted and site-hosted pictures within the same listing. On the US eBay Motors site (for all vehicle listings), and on the eBay Canada site for motors, the picture pack of a listing can contain up to 24 photos. On the eBay Live Auctions site, a listing can have a maximum of 5 picture URLs hosted by eBay Picture Services. 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 "clear image" URL in PictureURL: http://pics.ebay.com/aw/pics/dot_clear.gif. Note: On sites that offer free Gallery, the camera icon will not be available to appear as a gallery thumbnail or in a listing page whenever the first PictureURL field in the request is set to the "clear image" URL. In this case, eBay will attempt to use the image referenced by GalleryURL as the gallery thumbnail. If GalleryURL has not been specified, a blank (camera-less) gallery thumbnail displays in the search results and at the top of the listing page. If you have set the first PictureURL to the "clear image" URL, you can either Item.ProductListingDetails.UseStockPhotoURLAsGallery or Item.ProductListingDetails.UseStockPhotoURL to true and eBay will use a stock photo, if available, for the gallery thumbnail as well as the picture that displays at the top of the listing page. Note that a gallery picture will not be generated if UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to false (or not set) and no alternative picture in PictureURL. A Gallery fee applies only if you have specified GalleryType as either Plus or Featured (see Item.PictureDetails.GalleryType above for information). See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for information on eBay's selection rules for Gallery pictures on sites with free Gallery. For VerifyAddItem only: For VerifyAddItem, you can use the following fake eBay Picture Services URL (http://i2.ebayimg.com/abc/M28/dummy.jpg) to verify that your application is obtaining the correct fees for the quantity of images you pass in. For ReviseItem and RelistItem only: To remove a picture when revising or relisting an item, specify PictureDetails with all the pictures that you want the listing to include. That is, you need to completely replace the original set of URLs with the revised set. To remove all PictureURL fields from a listing, specify item.PictureDetails.PictureURL in DeletedField. However, please note that if the listing also includes a gallery image that is based on the first picture in the listing, you may need to supply an alternate image to use as the gallery image if you delete all PictureURL fields. There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for details about fees that could be charged if you change the category in these cases (or when revising a listing from a site with free gallery to one where free gallery is not yet available.) Max length: 150. See:
|
| 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. |
| 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 the eBay Web Services Guide for information on working with categories). Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for information about fees that could be charged if you change the category in these cases. Not applicable to Half.com. For ReviseItem only: When revising a listing, you can change the primary category only if an item has no bids (or no items have sold) and the listing does not end within 12 hours. If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. See Item.AttributeSetArray. For the eBay US site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details. You cannot change the meta-categories for vehicles (i.e., you cannot change a truck to a motorcycle), but you can change the leaf category (e.g., change one motorcycle subcategory to another motorcycle subcategory). See the eBay Web Services Guide for additional rules. International sites (such as the eBay Germany site) have similar rules for revising vehicle categories. For GetItemRecommendations only: For GetItemRecommendations, use this value to control the category that is searched for recommendations. Specify the category in which the item will be listed. See Getting Recommendations to Improve a Listing in the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attribute engine. For GetProducts: Use GetCategories if you need to determine the name of the category. See:
|
|
Item.PrimaryCategory .CategoryID |
string | Required |
Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For GetPopularKeywords, -1 represents the root category. For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. Max length: 10. |
| Item.PrivateListing | boolean | Optional |
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. |
| 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.) |
| Item.ProductListingDetails | ProductListingDetailsType | Optional |
Specifies stock product information to include in a listing. Only applicable when listing items with product details. See the eBay Trading API Guide for information on listing with product details. As ProductID and ProductReferenceID are defined by eBay, they provide the most reliable means to identify a product. If you use ISBN, UPC, EAN, BrandMPN, and/or TicketListingDetails, eBay attempts to find a matching product on your behalf and use it in the listing. If no match is found, you can try using the catalog search calls (such as GetProductSearchResults or GetProducts) to find a ProductID or ProductReferenceID. 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.) If you do not specify a primary category, eBay determines the category based on the product ID (if a matching product is found in the system). If you do specify the category, it takes precedence (and it must be a catalog-enabled category that is valid for the 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. (Use GetCategory2CS to determine which categories are catalog-enabled.) Either Item.ExternalProductID or Item.ProductListingDetails can be specified in an AddItem request, but not both. (ExternalProductID will be deprecated in a future release.) For ReviseItem and RelistItem only: If a listing includes product details and you change a category, the rules for continuing to include product details depend on whether or not the new category is mapped to a characteristic set associated with the same product ID. When you revise a listing, if it has bids or it ends within 12 hours, you cannot change the product ID and you cannot remove existing product data. However, you can change or add preferences such as IncludeStockPhotoURL, UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all catalog data when you revise or relist an item, specify Item.ProductListingDetails in DeletedField and don't pass ProductListingDetails in the request. For GetItemRecommendations only: For GetItemRecommendations, see the eBay Web Services guide for validation rule differences when using the Product Pricing engine. Not applicable to Half.com. See:
|
|
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. Please specify both Brand and MPN to ensure a unique product match. |
|
Item.ProductListingDetails .BrandMPN.Brand |
string | Conditional |
The brand of the product. eBay searches against the names that are publicly available in eBay's catalogs. This means you can specify the well-known brand name that an average user would recognize. Specify this in combination with MPN. Note: If you want examples of brand names that eBay is likely to recognize, you can examine product details returned in GetProductSearchResults and GetProductSellingPages. |
|
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.) |
| 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. |
|
Item.ProductListingDetails .IncludePrefilledItemInformation |
boolean | Optional |
If true, specifies that the listing should include additional information about the product, such as a publisher's description or film credits. Such information is hosted through the eBay site and cannot be edited. If true, Item.Description is optional in item-listing requests. Default: false. |
|
Item.ProductListingDetails .IncludeStockPhotoURL |
boolean | Optional |
If true, indicates that the item listing includes the stock photo. To use an eBay stock photo in an item listing, set IncludeStockPhotoURL to true. If a stock photo is available, it is used at the top of the View Item page and in the Item Specifics section of the listing. If you also include Item.PictureDetails.PictureURL, the stock photo only appears in the Item Specifics section of the listing. Other pictures you specify by using Item.PictureDetails.PictureURL appear in a separate section of the listing. If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL to true (and you cannot set it to false). In GetItem, the URL of the stock photo will be returned in StockPhotoURL. If you set IncludeStockPhotoURL to false, the stock photo does not appear in the listing at all. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). Along with these changes, IncludeStockPhotoURL will be used in the request. In some cases, if IncludeStockPhotoURL is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information. Not applicable to Half.com. Default: false. See:
|
|
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. |
|
Item.ProductListingDetails .ListIfNoProduct |
boolean | Optional |
Applicable for listing use cases only (not buy-side searching). Indicates what eBay should do if no product match has been found. If no product match was found and ListIfNoProduct is true, the item is listed without product information. (By default, eBay attempts to list the item with product information.) Note: If you omit PrimaryCategory and no product match is found, the listing will fail because eBay won't be able to determine a category without a product ID. Default: false. |
|
Item.ProductListingDetails .ProductID |
string | Conditional |
eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.) If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). In item-listing requests, if you pass in an old product ID, eBay lists the item with the latest version of the product and the latest product ID, and the call returns a warning indicating that the data has changed. As of mid-2008, some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, replacing, deleting, or merging some products (as a result of migrating from one catalog data provider to another). If you specify one of these products in a request, the call may return the product with a warning, or it may fail with an error if the product has been deleted. Max length: 4000. |
|
Item.ProductListingDetails .ProductReferenceID |
string | Conditional |
eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). As of mid-2008, 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. |
|
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, BrandMPN, or TicketListingDetails). Also see UseFirstProduct as an alternative. If true and more than one match is found, the call fails and the response returns an error and all matching ProductID values. This lets you choose one of the ProductIDs to pass in instead. If false and more than one match is found, the call fails and the response includes an error but does not return the matching ProductID values. (This flag has no effect when only one match is found.) Default: false. |
|
Item.ProductListingDetails .TicketListingDetails |
TicketListingDetailsType | Conditional |
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 Trading API Guide for more information about how to specify and troubleshoot these values.
See:
|
|
Item.ProductListingDetails .TicketListingDetails .EventTitle |
string | Conditional |
The name of the event, as shown on the ticket. Typically the headliner. There is no maximum number of words or characters. However, the words in the name must be an exact match (or a subset consisting of complete words) to the words in the product title in the catalog. The words in the name are matched using OR logic (the order of the words does not matter). As with all strings, you need to escape reserved characters such as ampersand. See the eBay Trading API Guide for more information about how to specify this value.
See Pre-filling a Ticket Listing Based on Keywords (Name, Venue, and Date). |
|
Item.ProductListingDetails .TicketListingDetails .PrintedDate |
string | Conditional |
The date of the event, as shown on the ticket. Use the date shown on the ticket, without attempting to adjust it for a different time zone (such as Pacific time or GMT). In most cases, you should be able to specify any numeric date format in month/day/year order. eBay supports m or mm for the month, d or dd for the day, and yy or yyyy for the year, in all combinations. The delimiters must be forward slashes (/). |
|
Item.ProductListingDetails .TicketListingDetails .PrintedTime |
string | Conditional |
The time of the event, as shown on the ticket. Use the time value shown on the ticket, without attempting to convert it to a different time zone (such as Pacific time or GMT). Do not round the value up or down (e.g., do not round 7:01 PM to 7:00 PM). In most cases, you should be able to specify the time format exactly as shown on the ticket. For a list of formats that have been tested, see the eBay Trading API Guide. See Pre-filling a Ticket Listing Based on Keywords (Name, Venue, and Date). |
|
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. |
| 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. |
|
Item.ProductListingDetails .UseFirstProduct |
boolean | Optional |
Applicable for listing use cases only (not buy-side searching). Indicates what eBay should do if more than one product matches the external product ID (ISBN, UPC, EAN, BrandMPN, or TicketListingDetails). Also see ReturnSearchResultOnDuplicates as an alternative. If more than one product match was found and UseFirstProduct is true, item will be listed with first product information. If false, the rules for ReturnSearchResultOnDuplicates are used. Default: false. |
|
Item.ProductListingDetails .UseStockPhotoURLAsGallery |
boolean | Optional |
If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. When listing an item, IncludeStockPhotoURL must also be true and Item.PictureDetails.GalleryType must be passed in with a value of Gallery or Gallery Featured (but not both). Passing in Item.PictureDetails.GalleryURL takes precedence over UseStockPhotoURLAsGallery. See the eBay Trading API guide for additional validation rules for pictures. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). Along with these changes, UseStockPhotoURLAsGallery will be used in the request. In some cases, if UseStockPhotoURLAsGallery is set to false, no image will be generated for the Gallery. A common example of this occurrence is when only GalleryURL has been set in the request (i.e., no PictureURL elements are defined). In this case, eBay will not use a stock photo, even if it is available. See "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information. See:
|
| Item.Quantity | int | Conditional |
This meaning of this value depends on the context. For AddItem and related calls: Specify the number of identical items the seller has available for sale in this listing. For auctions (with competitive bidding), Quantity must be 1. For certain other formats (e.g., fixed-price) the Quantity can be 1 or more. See the eBay Web site online help to learn which selling formats support multi-quantity sales. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.Quantity for each variation instead. For ReviseItem and ReviseFixedPriceItem: When you revise a listing (with no variations), 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. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, on sites that support multi-quantity auctions (Dutch auctions), if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. In multi-variation listings, this value is the sum of all the variation quantities in the listing. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. For transaction calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. |
| 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 the eBay Web Services guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the eBay Web Services guide for validation rules when revising US Motors listings. Not applicable to Half.com. See:
|
| Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| Item.ReturnPolicy | ReturnPolicyType | Conditional |
Describes the seller's return policy. Most eBay categories 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. 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:
|
| Item.ReturnPolicy.Description | string | Optional |
A detailed explanation of the seller's return policy. For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but does not specify this field when listing the item, GetItem returns this as an empty node For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. Max length: 5000. See (GeteBayDetails) ReturnPolicyDetails.Description for sites that support this field. |
| Item.ReturnPolicy.EAN | string | Optional |
The European Article Number (EAN) associated with the item, if any. Refer to the ReturnPolicyDetails node in GeteBayDetails to determine which sites support this 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 for sites that support this field. |
| 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.). Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (RefundOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem (and corresponding FixedPrice 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 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) RefundOption for sites that support this field, and applicable values. Applicable values: See RefundOptionsCodeType |
|
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 may initially show the return policy as unspecified. In a future release, the View Item page will be updated to indicate that returns are not accepted instead.) 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. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (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:
Applicable values: See ReturnsAcceptedOptionsCodeType |
|
Item.ReturnPolicy .ReturnsWithinOption |
token | Conditional |
The buyer can return the item within this period of time from the day they receive the item. Use the ReturnPolicy.Description field to explain the policy details. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (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_7), 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 for sites that support this field, and applicable values. Applicable values: See ReturnsWithinOptionsCodeType |
|
Item.ReturnPolicy .ShippingCostPaidByOption |
token | Optional |
The party who pays the shipping cost for a returned item. Use the ReturnPolicy.Description field to explain any additional details. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (ShippingCostPaidByOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this ShippingCostPaidByOption field when listing the item, some eBay sites may set a default value (like Buyer), and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See (GeteBayDetails) ShippingCostPaidByOption for sites that support this field, and applicable values. Applicable values: See ShippingCostPaidByOptionsCodeType |
|
Item.ReturnPolicy .WarrantyDurationOption |
token | Optional |
The warranty period. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (Initially, only the eBay India site supports this field.) (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 for sites that support this field, and applicable values. Applicable values: See WarrantyDurationOptionsCodeType |
|
Item.ReturnPolicy .WarrantyOfferedOption |
token | Optional |
Indicates whether a warranty is offered for the item. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (Initially, only the eBay India site supports this field.) (WarrantyOfferedCodeType defines all the possible values.) 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:
Applicable values: See WarrantyOfferedCodeType |
|
Item.ReturnPolicy .WarrantyTypeOption |
token | Optional |
Indicates the source or type of the warranty, if any. Applicable values: Use GeteBayDetails to determine which sites support this field, and the applicable values for each site. (Initially, only the eBay India site supports this field.) (WarrantyTypeOptionsCodeType defines all the possible values.) For AddItem, VerifyAddItem, and RelistItem: If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) but you do not pass in this WarrantyTypeOption field when listing the item, the eBay India site may set a default value, and the seller is obligated to honor this setting. Therefore, to avoid unexpected obligations, the seller should set a specific value for this field. For ReviseItem only: If the listing has bids or sales and/or ends within 12 hours, you can't change this value. See the parent ReturnPolicy node description for more details. See (GeteBayDetails) WarrantyTypeOption for sites that support this field, and applicable values. Applicable values: See WarrantyTypeOptionsCodeType |
| Item.ScheduleTime | dateTime | Optional |
Allows the user to specify the time that the listing becomes active on eBay. To schedule the listing start time, specify a time in the future in GMT format. In GetItem and related calls, the scheduled time is returned in StartTime. For ReviseItem, you can modify this value if the currently scheduled start time is in the future. When you schedule a start time, the start time is randomized within 15-minute intervals. Randomized start times applies to the following sites: AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK Also see the following article in the Knowledge Base: Why scheduled time is sometimes getting reset. Not applicable to Half.com. |
| Item.SecondaryCategory | CategoryType | Optional |
ID for second category in which the item is listed (also see Item.PrimaryCategory). For the AddItem family of calls: Listing an item in a second category is optional. Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. Not applicable to Half.com. On the eBay UK, Ireland, Germany, Austria, Switzerland, and Italy sites you can list Store Inventory listings in two categories. On the eBay US and other sites, you cannot list Store Inventory listings in two categories. You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. The Final Value Fee is based on the primary category in which the item is listed. Furthermore, you can list the same item in an eBay Motors Parts & Accessories category and in an eligible eBay category, as long as the primary category is associated with the site on which you are listing. That is, the two categories can be a mix of Motors Parts & Accessories and eBay site categories. (Real Estate, Mature Audience (adult), and Business & Industrial categories are not eligible for listing in two categories in this manner.) For example, if you list on Motors, the primary category could be 6750 (eBay Motors > Parts & Accessories > Apparel & Merchandise > Motorcycle > Jackets & Leathers), and the secondary category could be 57988 (eBay > Clothing, Shoes > Accessories > Men's Clothing > Outerwear). If you list on the main eBay site, the primary category could be 57988 and the secondary category could be 6750. 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. See Item.AttributeSetArray. When you revise an item, you can change the secondary category from a Motors Parts & Accessories category to an eBay category or vice versa if the listing has no bids (or no items have sold) and it does not end within 12 hours. For GetItemRecommendations only: For GetItemRecommendations, use this to control the category that will be searched for recommendations. Specify the category in which the item will be listed. See the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine. See Categories. |
|
Item.SecondaryCategory .CategoryID |
string | Required |
Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For GetPopularKeywords, -1 represents the root category. For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. Max length: 10. |
| Item.Seller | UserType | Conditional |
Container for information about this listing's seller. Not applicable to Half.com. Returned by GetItemsAwaitingFeedback if Buyer is making the request. |
| Item.Seller.MotorsDealer | boolean | Conditional | Indicates if item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only. |
| Item.SellerContactDetails | AddressType | Optional |
Contact information for sellers using the Classified Ad format for eBay Motors vehicles categories. To remove seller contact information when revising or relisting an item, use DeletedField. The seller contact details for the primary and secondary phone numbers cannot be deleted individually. To provide City, State, and Zip code information in SellerContactDetails use the following field: Item.SellerContactDetails.Street2 To delete the secondary phone number, for example, you must delete all of the secondary phone fields: Item.SellerContactDetails.Phone2AreaOrCityCode Item.SellerContactDetails.Phone2CountryCode Item.SellerContactDetails.Phone2CountryPrefix Item.SellerContactDetails.Phone2LocalNumber |
|
Item.SellerContactDetails .CompanyName |
string | Optional | User's company name. Only returned if available. Not applicable to Half.com. |
|
Item.SellerContactDetails .County |
string | Optional | County information for the user. This field applies to Classified Ad format listings and to the UK only. Not applicable to Half.com. |
|
Item.SellerContactDetails .Phone2AreaOrCityCode |
string | Optional | Area or City Code of a user's secondary phone number. This field applies to Classified Ad format listings only. |
|
Item.SellerContactDetails .Phone2CountryCode |
CountryCodeType | Optional |
Standard ISO code for the country of a user's secondary telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only.
Applicable values: See Phone2CountryCode. |
|
Item.SellerContactDetails .Phone2LocalNumber |
string | Optional |
The local number portion of the user's secondary phone number. This field applies to Classified Ad format listings only. Note: The full secondary phone number is constructed by combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix. Starting with API release 497, the full phone number can be entered in Phone2LocalNumber. Refer to the release notes for additional information. Max length: 30. |
|
Item.SellerContactDetails .PhoneAreaOrCityCode |
string | Optional | Area or City Code of a user's primary phone number. This field applies to Classified Ad format listings only. |
|
Item.SellerContactDetails .PhoneCountryCode |
CountryCodeType | Optional |
Standard ISO code for the country of the user's primay telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only.
Applicable values: See PhoneCountryCode. |
|
Item.SellerContactDetails .PhoneLocalNumber |
string | Optional |
The local number portion of the user's primary phone number. This field applies to Classified Ad format listings only. Note: The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix. Starting with API release 497, the full phone number can be entered in PhoneLocalNumber. Refer to the release notes for additional information. Max length: 30. |
|
Item.SellerContactDetails .Street |
string | Optional | A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com. |
|
Item.SellerContactDetails .Street2 |
string | Optional |
Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders). In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Max length: 100. |
| Item.SellerInventoryID | string | Optional |
Unique identifier for a Half.com item. Must be an alphanumeric value (with no symbols) that is unique across the seller's active (unsold) inventory on Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. Only returned from GetOrders if the seller specified a value when the item was listed. You cannot revise this field. Not applicable to eBay.com listings. Max length: 100. |
| Item.ShippingDetails | ShippingDetailsType | Conditional |
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. See:
|
|
Item.ShippingDetails .CalculatedShippingRate |
CalculatedShippingRateType | Conditional |
Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator. Not applicable to Half.com. |
|
Item.ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts |
AmountType (double) | Optional | Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only. |
| Item.ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .CalculatedShippingRate .MeasurementUnit |
MeasurementSystemCodeType | Conditional |
Specifies the unit type of the weight and dimensions of a shipping package. If MeasurementUnit is used, it overrides the system specified by measurementSystem. If MeasurementUnit and measurementSystem are not specified, the following defaults will be used: English: US Metric: CA, CAFR, AU CA and CAFR supports both English and Metric, while other sites only support the site's default. Use MeasurementUnit with weight and package dimensions. For example, to represent a 5 lbs 2 oz package: <MeasurementUnit>English</MeasurementUnit> <WeightMajor>5</WeightMajor> <WeightMinor>2</WeightMinor> Applicable values: • English (in/out) English system of measurement. • Metric (in/out) Metric system of measurement. |
|
Item.ShippingDetails .CalculatedShippingRate .OriginatingPostalCode |
string | Conditional | Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location. |
|
Item.ShippingDetails .CalculatedShippingRate .PackageDepth |
MeasureType (decimal) | Conditional |
Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs. |
|
Item.ShippingDetails .CalculatedShippingRate .PackageLength |
MeasureType (decimal) | Conditional | Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) |
|
Item.ShippingDetails .CalculatedShippingRate .PackageWidth |
MeasureType (decimal) | Conditional | Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) |
|
Item.ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts |
AmountType (double) | Optional | Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only. |
| Item.ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .CalculatedShippingRate .ShippingIrregular |
boolean | Optional | Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only. |
|
Item.ShippingDetails .CalculatedShippingRate .ShippingPackage |
ShippingPackageCodeType | Conditional |
The nature of the package used to ship the item(s). Required for calculated shipping only.
Applicable values: See ShippingPackage. |
|
Item.ShippingDetails .CalculatedShippingRate .WeightMajor |
MeasureType (decimal) | Conditional | WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service. For calculated shipping only. Required on input when calculated shipping is used. |
|
Item.ShippingDetails .CalculatedShippingRate .WeightMinor |
MeasureType (decimal) | Conditional | See the definition of WeightMajor. For calculated shipping only. Required on input when calculated shipping is used. |
| Item.ShippingDetails.CODCost | AmountType (double) | Conditional |
Valid only for the Italy site (site ID 101); contains the cash-on-delivery (COD) cost for COD shipping.
See Specifying the Cash on Delivery Option in Shipping Details. |
| Item.ShippingDetails.CODCost [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .ExcludeShipToLocation |
string | Conditional,
repeatable: [0..*] |
This field works in conjunction with Item.ShipToLocations and specifies an international country or region to where you will not ship the associated item. On input, repeat this element for each location that you want to exclude as a shipping destination for the associated item. As output, this field is repeated for each location to where you will not ship. 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. You can specify a default set of locations to where you will not ship items 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 specify any location with this field on input, 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. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails. You can repeat this call for each site on which you list. The location values are eBay regions and countries. Note that 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 specify both regions and countries that you wish to exclude from your shipping destinations. Note: To enable the display of your excluded ship-to locations in your item listings, you must enable Exclude Shipping Locations and Buyer Requirements in your My eBay Site Preferences. For details, see the KnowledgeBase Article HowTo: ExcludeShipToLocation. Applicable values: See CountryCodeType, ShippingRegionCodeType |
|
Item.ShippingDetails .InsuranceDetails |
InsuranceDetailsType | Optional |
Container for domestic insurance information. Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details. If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, depending on which subfields are used. Valid only on the following sites: AU, FR, and IT |
|
Item.ShippingDetails .InsuranceDetails.InsuranceFee |
AmountType (double) | Optional |
Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders). |
| Item.ShippingDetails .InsuranceDetails.InsuranceFee [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .InsuranceDetails .InsuranceOption |
InsuranceOptionCodeType | Optional |
Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders). Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance. (Not all values in InsuranceOptionCodeType apply to this field.) |
|
Item.ShippingDetails .InsuranceFee |
AmountType (double) | Optional |
Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request. Valid only on the following sites: AU, FR, and IT Applicable to Half.com for GetOrders. Default: 0.00. |
| Item.ShippingDetails .InsuranceFee [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .InsuranceOption |
InsuranceOptionCodeType | Optional |
Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored. Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged. This field is always returned with a request version lower than 635. With a request version of 635 or higher, this field is only returned if the value is other than NotOffered. Valid only on the following sites: AU, FR, and IT If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing. Applicable to Half.com Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance. (Not all values in InsuranceOptionCodeType apply to this field.) |
|
Item.ShippingDetails .InternationalInsuranceDetails |
InsuranceDetailsType | Optional |
Container for international insurance information. Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details. If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) 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: AU, FR, and IT |
|
Item.ShippingDetails .InternationalInsuranceDetails .InsuranceFee |
AmountType (double) | Optional |
Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders). |
| Item.ShippingDetails .InternationalInsuranceDetails .InsuranceFee [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .InternationalInsuranceDetails .InsuranceOption |
InsuranceOptionCodeType | Optional |
Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders). Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance. (Not all values in InsuranceOptionCodeType apply to this field.) |
|
Item.ShippingDetails .InternationalPromotionalShippingDiscount |
boolean | Conditional |
On input, this specifies whether to offer the promotional shipping discount for the listing's international shipping services (only applicable if the seller has a promotional shipping discount in effect at the moment). Returned on output only if the seller is making the call. This value indicates whether the promotional shipping discount is being offered for the international shipping services of this listing (if the listing is still active--this is only possible if the seller has a promotional shipping discount in effect at the moment) or whether the discount was offered at the time the listing ended. |
|
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). 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 instead of ItemType.ApplyShippingDiscount. |
|
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. If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international 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 three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
Item.ShippingDetails .InternationalShippingServiceOption .ShippingService |
token | Conditional |
An international shipping service offered for shipping the item. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping.
See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost |
AmountType (double) | Optional | Cost of shipping each additional item beyond the first item. Should be zero for single-item listings. Default value is 0.00. For flat shipping only. |
| Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost |
AmountType (double) | Conditional |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.
See Shipping. |
| Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .InternationalShippingServiceOption .ShippingServicePriority |
int | Conditional | Seller-preferred presentation order relative to other service options. Valid values are: 1, 2 and 3 (first, second and third choices). For flat and calculated shipping. |
|
Item.ShippingDetails .InternationalShippingServiceOption .ShipToLocation |
string | Conditional,
repeatable: [0..*] |
An international location or region to where the item seller will ship the item. Use GeteBayDetails to determine which locations are valid per site. These values are string equivalents of values found in ShippingRegionCodeType and CountryCodeType. For the AddItem family of calls, this field is required if any international shipping service is specified.
See ShipToLocation. Applicable values: See CountryCodeType, ShippingRegionCodeType |
|
Item.ShippingDetails .PaymentInstructions |
string | Optional |
Payment instructions (or message) from the seller to the buyer. These instructions appear on eBay's View Item page and on eBay's checkout page when the buyer pays for the item. Sellers usually use this field to specify payment instructions, how soon the item will shipped, feedback instructions, and other reminders that the buyer should be aware of when they bid on or buy an item. This field can be specified regardless of the shipping type eBay only allows 500 characters as input, but due to the way the eBay Web site UI treats characters, this field can return more than 500 characters in the response. Characters like & and ' (apostrophe/single quote) count as 5 characters each. Use DeletedField to remove this value when revising or relisting an item. Applicable to eBay Motors (usually used to elaborate on the return policy). Not applicable to Half.com. Max length: 1000. See:
|
|
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. |
| Item.ShippingDetails.SalesTax | SalesTaxType | Optional |
Sales tax details. US site only. Flat and calculated shipping. Not applicable to eBay Motors vehicle listings. Applicable to Half.com (for GetOrders). |
|
Item.ShippingDetails.SalesTax .SalesTaxPercent |
float | Optional |
Percent of an item's price to be charged as the sales tax for the transaction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). Applicable to Half.com (for GetOrders). |
|
Item.ShippingDetails.SalesTax .SalesTaxState |
string | Optional |
State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. Applicable to Half.com (for GetOrders). |
|
Item.ShippingDetails.SalesTax .ShippingIncludedInTax |
boolean | Optional |
(US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. Applicable to Half.com (for GetOrders). |
|
Item.ShippingDetails .ShippingDiscountProfileID |
string | Conditional | On input, this is the ID of the shipping discount to offer for the domestic shipping services (where the shipping discount is either of type FlatShippingDiscount or CalculatedShippingDiscount). On output, this is the ID of the shipping discount offered and corresponds to whichever is returned: FlatShippingDiscount or CalculatedShippingDiscount. Only returned if the calling user is the seller. If the user created a shipping discount profile, use the ShippingDiscountProfileID instead of ItemType.ApplyShippingDiscount. Only returned if the calling user is the seller. |
|
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: 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 three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
Item.ShippingDetails .ShippingServiceOptions .FreeShipping |
boolean | Optional | A seller offers free shipping by setting FreeShipping to true. This free shipping applies only to the first domestic shipping service. (It is ignored if set for any other shipping service.) If the seller has required shipping insurance as part of shipping (the seller set InsuranceOption to Required) and then the seller specified FreeShipping, eBay sets the insurance cost to 0. However, if the seller made shipping insurance optional, eBay preserves the cost of shipping insurance; it is up to the buyer whether to buy shipping insurance, regardless of whether the seller specified FreeShipping. |
|
Item.ShippingDetails .ShippingServiceOptions .ShippingService |
token | Conditional |
A domestic shipping service offered for shipping the item (for example, UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). If there are two or more services and one is "pickup", "pickup" must not be specified as the first service. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
Item.ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost |
AmountType (double) | Optional | The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items and should be zero for single-item listings. Default value is 0.00. For flat shipping only. Not applicable to Half.com. |
| Item.ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditional |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). |
| Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .ShippingServiceOptions .ShippingServicePriority |
int | Conditional | Seller-preferred presentation order relative to other service options. Valid values: 1 (1st choice), 2 (2nd choice), 3 (3rd choice). For flat and calculated shipping. Not applicable to Half.com. |
|
Item.ShippingDetails .ShippingServiceOptions .ShippingSurcharge |
AmountType (double) | Conditional | An additional fee to charge US buyers who ship via UPS 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 transactions in an order have a surcharge, surcharge is added only for those transactions. Flat rate shipping only. |
| Item.ShippingDetails .ShippingServiceOptions .ShippingSurcharge [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
Item.ShippingDetails .ShippingType |
ShippingTypeCodeType | Optional |
The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. Not applicable to Half.com. Applicable values: • Calculated (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. See "Specifying Freight Shipping" in the Shipping chapter for details on freight shipping. • NotSpecified (in/out) The seller did not specify the shipping type. (Not all values in ShippingTypeCodeType apply to this field.) |
|
Item .ShippingTermsInDescription |
boolean | Optional |
Indicates whether details about shipping costs and arrangements are specified in the item description. Not applicable to Half.com. |
| 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:
Applicable values: See CountryCodeType, ShippingRegionCodeType |
| Item.Site | SiteCodeType | Required |
The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (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, 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:
|
| 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 a transaction 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 Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
| Item.SkypeContactOption | SkypeContactOptionCodeType | Optional,
repeatable: [0..*] |
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 Skype Chat contact option. • CustomCode
• Voice (in/out) The Skype Voice contact option. |
| Item.SkypeEnabled | boolean | Optional | Specifies that Skype-related information is included with an item listing, including, for example, Skype Voice. Skype-related information provides buttons that enable potential buyers to contact sellers through Skype. Information about Skype is available at www.Skype.com. If all of the prerequisites for adding Skype buttons to listings are met (see the eBay Web Services Guide), you can make communication through Skype available in listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are specified. |
| Item.SkypeID | string | Optional | The Skype name of the seller. Requires that SkypeEnabled is set to true. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account. |
| Item.StartPrice | AmountType (double) | 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-type 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) and Store Inventory (StoresFixedPrice) listings: 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. |
| Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Optional |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| Item.Storefront | StorefrontType | Optional |
Contains information related to the item in the context of a seller's eBay Store. Applicable for auction formats, Basic Fixed Price, and Store Inventory format items listed by eBay Stores sellers. Not applicable to Half.com. |
|
Item.Storefront .StoreCategory2ID |
long | Optional |
Applicable for eBay Store sellers only. Numeric ID for a second custom category that the seller created in their eBay Store. eBay Stores sellers can create up to 300 custom categories for their stores. (One additional Store category cannot be customized and retains the value of "Other"). If you specify an invalid value, the values are the same for both the primary and secondary store categories, or if the seondary store category is specified but the primary is left blank (or other), the system resets the value to 0 (None). In short, the primary store category must be set to something meaningful and different from the second store category in order to set the secondary store category to a value other than 0. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID. |
|
Item.Storefront .StoreCategoryID |
long | Optional | Numeric ID for a custom category that the seller created in their eBay Store, if any. eBay Stores sellers can create up to three levels of custom categories for their stores. Items can only be listed in store categories that have no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the Other store category. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID. |
| Item.SubTitle | string | Optional |
Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees). Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle. When you revise a item, you can add, change, or remove the subtitle. Not applicable to Half.com. Max length: 55. See:
|
| Item.ThirdPartyCheckout | boolean | Optional |
Whether checkout for this is to be handled by a Third-Party Checkout application. Only for authorized Third-Party Checkout applications. 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 ThirdPartyCheckout must be true, AutoPay must be true, PayPalEmailAddress must be a valid PayPal email address for the seller, and PaymentMethods must be PayPal. For a non-Immediate Payment listing, if AutoPay is true, ThirdPartyCheckout is not supported. Not applicable to Half.com. See:
|
|
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. |
| 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.ExternalProductID or 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. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55. |
| Item.UseTaxTable | boolean | Optional |
Indicates whether the seller's tax table is to be used when applying and calculating taxes. If true, a tax table must exist for the seller, and the following tags should not be used: SalesTaxState, SalesTaxPercent, ShippingIncludedInTax. Not applicable to Half.com. |
| 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. |
| Item.VATDetails | VATDetailsType | Conditional |
Container for eBay's VAT features. A business seller can choose to offer an item exclusively to bidders and buyers that also represent businesses. Only applicable when the item is listed in a B2B-enabled category (on a site that supports B2B business features). Note: The India site (Global ID 203) does not accept VAT values in item listings. If you submit an item to the India site with a VAT value, eBay generates a warning message that indicates the listing was accepted, but the VAT value was removed. To include the VAT, relist the item with a Price value that includes the VAT. Sellers are solely responsible for compliance relating to tax legislation in India. Not applicable to Half.com. See:
|
| Item.VATDetails.BusinessSeller | boolean | Conditional | If true, this indicates that the seller is a business user and intends to use listing features that are offered to business users only. Applicable only to business sellers residing in Germany, Austria, or Switzerland who are listing in a B2B VAT- enabled category on the eBay Germany (DE), Austria (AT), or Switzerland (CH) sites. The seller must have a valid VAT ID registered with eBay. This must be set to true if RestrictedToBusiness is true. It has no effect (and it's not returned) if RestrictedToBusiness is false. If an item was not qualified as a business item when originally listed, but meets the conditions for business items when the item is revised or relisted, the seller can convert the item to a business item by specifying the appropriate VAT details. See the eBay Web Services guide for more information and additional rules. |
|
Item.VATDetails .RestrictedToBusiness |
boolean | Optional | If true, this indicates that the seller elects to offer the item exclusively to business users. If false (or not returned), this indicates that the seller elects to offer the item to all users. Applicable only to business sellers residing in Germany, Austria, or Switzerland who are listing in a B2B VAT-enabled category on the eBay Germany (DE), Austria (AT), or Switzerland (CH) sites. If this argument is true, the seller must have a valid VAT-ID registered with eBay, and BusinessSeller must also be true. |
| Item.VATDetails.VATPercent | float | Conditional |
VAT rate for the item, if any. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max applicable length is 6 characters, including the decimal (e.g., 12.345). The scale is 3 decimal places. (If you pass in 12.3456, eBay may round up the value to 12.346.) Note: The View Item page may display the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. Min: 0. Max: 30. |
| Input Detail Controls Samples Change History Top Errors for VerifyAddItem |
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).
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"?>
<VerifyAddItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Standard Output Fields -->
<Ack> AckCodeType </Ack>
<Build> string </Build>
<CorrelationID> string </CorrelationID>
<Errors> ErrorType
<ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
<ErrorCode> token </ErrorCode>
<ErrorParameters ParamID="string"> ErrorParameterType
<Value> string </Value>
</ErrorParameters>
<!-- ... more ErrorParameters nodes here ... -->
<LongMessage> string </LongMessage>
<SeverityCode> SeverityCodeType </SeverityCode>
<ShortMessage> string </ShortMessage>
<UserDisplayHint> boolean </UserDisplayHint>
</Errors>
<!-- ... more Errors nodes here ... -->
<HardExpirationWarning> string </HardExpirationWarning>
<Message> string </Message>
<Timestamp> dateTime </Timestamp>
<Version> string </Version>
<!-- Call-specific Output Fields -->
<Category2ID> string </Category2ID>
<CategoryID> string </CategoryID>
<DiscountReason> DiscountReasonCodeType </DiscountReason>
<!-- ... more DiscountReason nodes here ... -->
<ExpressItemRequirements> ExpressItemRequirementsType
<CombinedShippingDiscount> boolean </CombinedShippingDiscount>
<DomesticShippingCost> boolean </DomesticShippingCost>
<EligibleCheckout> boolean </EligibleCheckout>
<EligibleItemCondition> boolean </EligibleItemCondition>
<EligiblePayPalAccount> boolean </EligiblePayPalAccount>
<EligibleReturnPolicy> boolean </EligibleReturnPolicy>
<ExpressApproved> boolean </ExpressApproved>
<ExpressEligibleListingType> boolean </ExpressEligibleListingType>
<ExpressEnabledCategory> boolean </ExpressEnabledCategory>
<ExpressOptOut> boolean </ExpressOptOut>
<NoCharity> boolean </NoCharity>
<NoPreapprovedBidderList> boolean </NoPreapprovedBidderList>
<PayPalAccountAcceptsUnconfirmedAddress> boolean </PayPalAccountAcceptsUnconfirmedAddress>
<Picture> boolean </Picture>
<PriceAboveMinimum> boolean </PriceAboveMinimum>
<PriceBelowMaximum> boolean </PriceBelowMaximum>
<SellerExpressEligible> boolean </SellerExpressEligible>
<ShipFromEligibleCountry> boolean </ShipFromEligibleCountry>
</ExpressItemRequirements>
<ExpressListing> boolean </ExpressListing>
<Fees> FeesType
<Fee> FeeType
<Fee currencyID="CurrencyCodeType"> AmountType (double) </Fee>
<Name> string </Name>
<PromotionalDiscount currencyID="CurrencyCodeType"> AmountType (double) </PromotionalDiscount>
</Fee>
<!-- ... more Fee nodes here ... -->
</Fees>
<ItemID> ItemIDType (string) </ItemID>
</VerifyAddItemResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Standard Output Fields [Jump to call-specific fields] |
| Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.
Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.) |
| Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
| CorrelationID | string | Conditionally |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
| Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request.
See Error Handling. |
| Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. |
| Errors.ErrorCode | token | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. |
| Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
| Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | The index of the parameter in the list of parameter types returned within the error type. |
| Errors.ErrorParameters.Value | string | Conditionally | The value of the variable (e.g., the attribute set ID) |
| Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
| Errors.SeverityCode | SeverityCodeType | Conditionally |
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error |
| Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
| 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 Message. |
| Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
| Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response. |
| Call-specific Output Fields | |||
| Category2ID | string | Conditionally |
ID of the secondary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. Max length: 10. |
| CategoryID | string | Conditionally |
ID of the primary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. Max length: 10. |
| DiscountReason | DiscountReasonCodeType | Conditionally,
repeatable: [0..*] |
The nature of the discount, if a discount would have applied had this actually been listed at this time.
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." |
| ExpressItemRequirements | ExpressItemRequirementsType | Conditionally |
Deprecated as of version 579. No longer functional. Contains details about why an item does or doesn't qualify as an eBay Express listing. Only returned when IncludeExpressRequirements is true the request. The item requirements are assessed in this order: - SellerExpressEligible - ExpressOptOut - ExpressApproved - All other settings Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .CombinedShippingDiscount |
boolean | Conditionally |
Deprecated as of version 579. If true, the item offers a combined shipping discount. Only returned if the Express site has an item-level combined shipping discount requirement. (Some Express sites only require you to accept combined payments at the seller level, in your My eBay preferences.) Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .DomesticShippingCost |
boolean | Conditionally |
Deprecated as of version 579. If true, domestic shipping costs are specified for the item. If false, they aren't specified (and the item is therefore ineligible). Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .EligibleCheckout |
boolean | Conditionally |
Deprecated as of version 579. If true, indicates the item meets the site's eBay Express requirements for checkout. (A common case when this could be false would be when ThirdPartyCheckout is true but ThirdPartyCheckoutIntegration is false.) Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .EligibleItemCondition |
boolean | Conditionally |
Deprecated as of version 579. If true, the item specifies an eligible item condition. If false, the item doesn't specify an eligible item condition. Only returned if the category requires an item condition for Express. Some categories waive the item condition requirement. Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .EligiblePayPalAccount |
boolean | Conditionally |
Deprecated as of version 579. If true, the seller has an Express-eligible PayPal account. Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .EligibleReturnPolicy |
boolean | Conditionally |
Deprecated as of version 579. If true, the item is covered by a return policy that meets the site's requirements for Express. Only returned for Express Germany. (A return policy is optional for Express US.) Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .ExpressApproved |
boolean | Conditionally |
Deprecated as of version 579. If true, indicates eBay has marked the item as eligible for eBay Express based on direct evaluation. Only returned if true, and no other settings are returned in this case. Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .ExpressEligibleListingType |
boolean | Conditionally |
Deprecated as of version 579. If true, indicates the item listing format is eligible for Express. If false, the listing format is ineligible (and the item is therefore ineligible). Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .ExpressEnabledCategory |
boolean | Conditionally |
Deprecated as of version 579. If true, the item's primary category is enabled for Express. If false, the primary category is not enabled for Express (and the item is therefore ineligible). Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .ExpressOptOut |
boolean | Conditionally |
Deprecated as of version 579. If true, this field indicates the item was opted out of Express; that is, ExpressOptOut was true in the listing request. Only returned if true, and no other settings are returned in this case. Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .NoCharity |
boolean | Conditionally |
Deprecated as of version 579. If true, the item is not an eBay Giving Works item. Only returned if the site does not allow charity listings on Express. (In other words, if the site excludes charity listings from Express, then NoCharity=true means the item meets the eligibility requirement.) Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .NoPreapprovedBidderList |
boolean | Conditionally |
Deprecated as of version 579. If true, the item has no pre-approved bidder list. Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .PayPalAccountAcceptsUnconfirmedAddress |
boolean | Conditionally |
Deprecated as of version 579. If true, the PayPal account for the item accepts payments from a buyer with an unconfirmed address. If false, the account blocks unconfirmed addresses (and the item is therefore ineligible). Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .Picture |
boolean | Conditionally |
Deprecated as of version 579. If true, the item includes a picture. If false, the item doesn't include a picture. Only returned if the category requires a picture for Express. Some categories waive the picture requirement. Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .PriceAboveMinimum |
boolean | Conditionally |
Deprecated as of version 579. If true, the price of the item is above the minimum price allowed on Express. That is, the StartPrice, BuyItNowPrice, or CurrentPrice is above the minimum.) Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .PriceBelowMaximum |
boolean | Conditionally |
Deprecated as of version 579. If true, the price of the item is below the maximum price allowed on Express. (That is, the StartPrice, BuyItNowPrice, or CurrentPrice is below the maximum.) Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .SellerExpressEligible |
boolean | Conditionally |
Deprecated as of version 579. If false, indicates that an item is not Express-eligible because the seller is not Express-eligible. Only returned if false, and no other settings are returned in this case. Deprecation version: 579. See also Deprecated Objects. |
|
ExpressItemRequirements .ShipFromEligibleCountry |
boolean | Conditionally |
Deprecated as of version 579. If true, the country you specified for the item meets the specified site's shipping origin requirements for Express. Deprecation version: 579. See also Deprecated Objects. |
| ExpressListing | boolean | Conditionally |
Deprecated as of version 579. No longer functional. Indicates whether the item would be listed on eBay Express. See ExpressItemRequirements for hints about why this value is true or false for a given item. Deprecation version: 579. See also Deprecated Objects. |
| Fees | FeesType | Always |
Child Fee containers provide the listing feature names, fees, and possible discounts for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. There is no guarantee that a PromotionalDiscount returned with VerifyAddItem will be realized when the seller uses AddItem to list the same item. This is the result of the timing of certain promotions. Note: Starting with version 619, the behavior of VerifyAddItem changed to match that of AddItem. With a request version of 619 or higher, the value of Fees.Fee.Fee for VerifyAddItem represents the actual cost of the respective feature, with any discounts subtracted from the posted feature price. With a request version lower than 619, VerifyAddItem returns the full price of the feature in the Fee element, regardless of whether or not a discount was applied. |
| 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. |
| Fees.Fee.Fee | AmountType (double) | Always |
Amount of the fee that eBay will charge the member for the associated listing feature. See the eBay.com Web site online help for a current schedule of listing features and their associated fees.
See eBay.com Fees. |
| Fees.Fee.Fee [ attribute currencyID ] |
CurrencyCodeType | Always |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| Fees.Fee.Name | string | Always | Name of the listing feature, for identification purposes. See the Trading API guide for a list of current listing features names and associated fees. |
| Fees.Fee.PromotionalDiscount | AmountType (double) | Always |
This field exists in the response when the user has selected the features that participate in a promotional discount. See the eBay.com Web site online help for a current fee schedule.
See eBay.com Fees. |
| Fees.Fee.PromotionalDiscount [ attribute currencyID ] |
CurrencyCodeType | Always |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| ItemID | ItemIDType (string) | Always |
Represents the item ID for the new listing. VerifyAddItem does not actually list an item, so 0 is returned instead of a normal item ID. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). |
| Input Output Samples Change History Top Errors for VerifyAddItem |
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
| Input Output Detail Controls Change History Top Errors for VerifyAddItem |
An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for VerifyAddItem.
| Input Output Detail Controls Samples Top Errors for VerifyAddItem |
| Version | Description |
|---|---|
| 635 2009-09-16 |
|
| 627 2009-07-22 |
|
| 619 2009-05-27 |
|
| 615 2009-04-29 |
|
| 611 2009-04-01 |
|
| 605 2009-02-18 |
|
| 603 2009-02-04 |
|
| 601 2009-1-21 |
|
| 599 2009-1-07 |
|
| 585 2008-10-01 |
|
| 581 2008-09-03 |
|
| 573 2008-07-09 |
|
| 571 2008-06-25 |
|
| 565 2008-05-14 |
|
| 563 2008-04-30 |
|
| 561 2008-04-16 |
|
| 559 2008-04-02 |
|
| 555 2008-03-05 |
|
| 553 2008-02-20 |
|
| 551 2008-02-07 |
|
| 537 2007-10-31 |
|
| 533 2007-10-03 |
|
| All Versions All Dates |
|
| 481 2006-10-04 |
|
| 475 2006-8-23 |
|
This document was generated with a customized version of the apireferencedocs tool.
© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.