Returns a list of items a seller has listed for auction. Returns an array of zero, one, or multiple items. You can specify that the returned data include only items that start or end within a specified date range.
See:
GetSellerList Best Practices
Browsing a Seller's Items
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History Top Errors for GetSellerList |
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"?> <GetSellerListRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Standard Input Fields --> <DetailLevel> DetailLevelCodeType </DetailLevel> <!-- ... more DetailLevel nodes here ... --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <OutputSelector> string </OutputSelector> <!-- ... more OutputSelector nodes here ... --> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> <!-- Call-specific Input Fields --> <AdminEndedItemsOnly> boolean </AdminEndedItemsOnly> <CategoryID> int </CategoryID> <EndTimeFrom> dateTime </EndTimeFrom> <EndTimeTo> dateTime </EndTimeTo> <GranularityLevel> GranularityLevelCodeType </GranularityLevel> <IncludeVariations> boolean </IncludeVariations> <IncludeWatchCount> boolean </IncludeWatchCount> <MotorsDealerUsers> UserIDArrayType <UserID> UserIDType (string) </UserID> <!-- ... more UserID nodes here ... --> </MotorsDealerUsers> <Pagination> PaginationType <EntriesPerPage> int </EntriesPerPage> <PageNumber> int </PageNumber> </Pagination> <SKUArray> SKUArrayType <SKU> SKUType (string) </SKU> <!-- ... more SKU nodes here ... --> </SKUArray> <Sort> int </Sort> <StartTimeFrom> dateTime </StartTimeFrom> <StartTimeTo> dateTime </StartTimeTo> <UserID> UserIDType (string) </UserID> </GetSellerListRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Standard Input Fields [Jump to call-specific fields] |
| DetailLevel | DetailLevelCodeType | Optional,
repeatable: [0..*] |
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ItemReturnDescription (in) Returns Description, plus the ListingDesigner node and some additional information if applicable • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.) |
| ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- 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. |
| OutputSelector | string | Optional,
repeatable: [0..*] |
You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. |
| 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 | |||
| AdminEndedItemsOnly | boolean | Optional | Specifies whether to return only items that were administratively ended based on a policy violation. |
| CategoryID | int | Optional | The category ID for the items retrieved. If you specify CategoryID in a GetSellerList call, the response contains only items in the category you specify. |
| EndTimeFrom | dateTime | Conditional | Specifies the earliest (oldest) date to use in a date range filter based on item end time. Specify either the end-time range or the start-time range filter in every request. Each of the time ranges must be a value less than 120 days. |
| EndTimeTo | dateTime | Conditional | Specifies the latest (most recent) date to use in a date range filter based on item end time. Must be specified if EndTimeFrom is specified. |
| GranularityLevel | GranularityLevelCodeType | Optional |
Specifies the subset of item and user fields to return. See GetSellerList in the eBay Web Services guide for a list of the fields that are returned for each granularity level. For GetSellerList, use DetailLevel or GranularityLevel in a request, but not both. For GetSellerList, if GranularityLevel is specified, DetailLevel is ignored.
Applicable values: • Coarse (in) For each record in the response, retrieves less data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified. • CustomCode (in) • Fine (in) For each record in the response, retrieves more data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified. • Medium (in) For each record in the response, retrieves more data than Coarse and less data than Fine. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified. |
| IncludeVariations | boolean | Optional |
If true, the Variations node is returned for all multi-variation listings in the response. Please note that if the seller includes a large number of variations in many listings, using this flag may degrade the call's performance. Therefore, when you use this flag, you may need to reduce the total number of items you're requesting at once. For example, you may need to use shorter time ranges in the EndTime or StartTime filters, fewer entries per page in Pagination, and/or SKUArray. |
| IncludeWatchCount | boolean | Optional | Specifies whether to include WatchCount in Item nodes returned. WatchCount is only returned with DetailLevel ReturnAll. |
| MotorsDealerUsers | UserIDArrayType | Optional | Specifies the list of Motors Dealer sellers for which a special set of metrics can be requested. Applies to eBay Motors Pro applications only. |
| MotorsDealerUsers.UserID | UserIDType (string) | Optional,
repeatable: [0..*] |
Unique eBay user ID for the user. Applies to eBay Motors Pro applications only. |
| Pagination | PaginationType | Required | Contains the data controlling the pagination of the returned values: how many items are returned per page of data (per call) and the number of the page to return with the current call. |
| Pagination.EntriesPerPage | int | Required | Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders). |
| Pagination.PageNumber | int | Required | Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). |
| SKUArray | SKUArrayType | Optional |
Container for a set of SKUs. Filters (reduces) the response to only include active listings that the seller listed with any of the specified SKUs. If multiple listings include the same SKU, they are all returned (assuming they also match the other criteria in the GetSellerList request). SKUArray can be used to retrieve items listed by the user identified in AuthToken or in UserID. Note: Listings with matching SKUs are returned regardless of their Item.InventoryTrackingMethod settings. |
| SKUArray.SKU | SKUType (string) | Optional,
repeatable: [0..*] |
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 value 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. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. Note: AddFixedPriceItem and RelistFixedPriceItem are defined in the Merchant Data API (part of Large Merchant Services). Max length: 50. |
| Sort | int | Optional |
Specifies the order in which returned items are sorted (based on the end dates of the item listings). Valid values: 0 = No sorting 1 = Sort in descending order 2 = Sort in ascending order |
| StartTimeFrom | dateTime | Conditional | Specifies the earliest (oldest) date to use in a date range filter based on item start time. Specify either the end time range or start time range filter in every request. Each of the time ranges must be a value less than 120 days. |
| StartTimeTo | dateTime | Conditional | Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified. |
| UserID | UserIDType (string) | Optional | Specifies the seller whose items will be returned. UserID is an optional input. If not specified, retrieves listings for the user identified by the authentication token passed in the request. Note that since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about their own listings and bidders who know the user IDs of their sellers will be able to make this API call successfully. See Working with Anonymous User Informationin the eBay Web Services Guide for more information. |
| Input Detail Controls Samples Change History Top Errors for GetSellerList |
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"?>
<GetSellerListResponse 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>
</Errors>
<!-- ... more Errors nodes here ... -->
<HardExpirationWarning> string </HardExpirationWarning>
<Timestamp> dateTime </Timestamp>
<Version> string </Version>
<!-- Call-specific Output Fields -->
<HasMoreItems> boolean </HasMoreItems>
<ItemArray> ItemArrayType
<Item> ItemType
<ApplicationData> string </ApplicationData>
<AutoPay> boolean </AutoPay>
<BuyerGuaranteePrice currencyID="CurrencyCodeType"> AmountType (double) </BuyerGuaranteePrice>
<BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<Charity> CharityType
<CharityID> string </CharityID>
<CharityListing> boolean </CharityListing>
<CharityName> string </CharityName>
<CharityNumber> int </CharityNumber>
<DonationPercent> float </DonationPercent>
<LogoURL> string </LogoURL>
<Mission> string </Mission>
<Status> CharityStatusCodeType </Status>
</Charity>
<Country> CountryCodeType </Country>
<CrossBorderTrade> string </CrossBorderTrade>
<!-- ... more CrossBorderTrade nodes here ... -->
<Currency> CurrencyCodeType </Currency>
<Description> string </Description>
<DisableBuyerRequirements> boolean </DisableBuyerRequirements>
<ExtendedSellerContactDetails> ExtendedContactDetailsType
<ContactHoursDetails> ContactHoursDetailsType
<Hours1AnyTime> boolean </Hours1AnyTime>
<Hours1Days> DaysCodeType </Hours1Days>
<Hours1From> time </Hours1From>
<Hours1To> time </Hours1To>
<Hours2AnyTime> boolean </Hours2AnyTime>
<Hours2Days> DaysCodeType </Hours2Days>
<Hours2From> time </Hours2From>
<Hours2To> time </Hours2To>
<TimeZoneID> string </TimeZoneID>
</ContactHoursDetails>
</ExtendedSellerContactDetails>
<FreeAddedCategory> CategoryType
<CategoryID> string </CategoryID>
<CategoryName> string </CategoryName>
</FreeAddedCategory>
<GetItFast> boolean </GetItFast>
<GiftIcon> int </GiftIcon>
<HitCount> long </HitCount>
<HitCounter> HitCounterCodeType </HitCounter>
<IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
<InventoryTrackingMethod> InventoryTrackingMethodCodeType </InventoryTrackingMethod>
<ItemID> ItemIDType (string) </ItemID>
<ItemPolicyViolation> ItemPolicyViolationType
<PolicyID> long </PolicyID>
<PolicyText> string </PolicyText>
</ItemPolicyViolation>
<ListingCheckoutRedirectPreference> ListingCheckoutRedirectPreferenceType
<ProStoresStoreName> string </ProStoresStoreName>
<SellerThirdPartyUsername> string </SellerThirdPartyUsername>
</ListingCheckoutRedirectPreference>
<ListingDesigner> ListingDesignerType
<LayoutID> int </LayoutID>
<OptimalPictureSize> boolean </OptimalPictureSize>
<ThemeID> int </ThemeID>
</ListingDesigner>
<ListingDetails> ListingDetailsType
<Adult> boolean </Adult>
<BestOfferAutoAcceptPrice currencyID="CurrencyCodeType"> AmountType (double) </BestOfferAutoAcceptPrice>
<BindingAuction> boolean </BindingAuction>
<CheckoutEnabled> boolean </CheckoutEnabled>
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<HasPublicMessages> boolean </HasPublicMessages>
<HasReservePrice> boolean </HasReservePrice>
<HasUnansweredQuestions> boolean </HasUnansweredQuestions>
<MinimumBestOfferMessage> string </MinimumBestOfferMessage>
<MinimumBestOfferPrice currencyID="CurrencyCodeType"> AmountType (double) </MinimumBestOfferPrice>
<PayPerLeadEnabled> boolean </PayPerLeadEnabled>
<RelistedItemID> ItemIDType (string) </RelistedItemID>
<StartTime> dateTime </StartTime>
<TCROriginalItemID> ItemIDType (string) </TCROriginalItemID>
<ViewItemURL> anyURI </ViewItemURL>
<ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
</ListingDetails>
<ListingDuration> token </ListingDuration>
<ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
<!-- ... more ListingEnhancement nodes here ... -->
<ListingSubtype2> ListingSubtypeCodeType </ListingSubtype2>
<ListingType> ListingTypeCodeType </ListingType>
<Location> string </Location>
<MotorsGermanySearchable> boolean </MotorsGermanySearchable>
<PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
<!-- ... more PaymentMethods nodes here ... -->
<PictureDetails> PictureDetailsType
</PictureDetails>
<PrimaryCategory> CategoryType
<CategoryID> string </CategoryID>
<CategoryName> string </CategoryName>
</PrimaryCategory>
<PrivateListing> boolean </PrivateListing>
<ProxyItem> boolean </ProxyItem>
<Quantity> int </Quantity>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<ReturnPolicy> ReturnPolicyType
<Description> string </Description>
<EAN> string </EAN>
<Refund> string </Refund>
<RefundOption> token </RefundOption>
<ReturnsAccepted> string </ReturnsAccepted>
<ReturnsAcceptedOption> token </ReturnsAcceptedOption>
<ReturnsWithin> string </ReturnsWithin>
<ReturnsWithinOption> token </ReturnsWithinOption>
<ShippingCostPaidBy> string </ShippingCostPaidBy>
<ShippingCostPaidByOption> token </ShippingCostPaidByOption>
<WarrantyDuration> string </WarrantyDuration>
<WarrantyDurationOption> token </WarrantyDurationOption>
<WarrantyOffered> string </WarrantyOffered>
<WarrantyOfferedOption> token </WarrantyOfferedOption>
<WarrantyType> string </WarrantyType>
<WarrantyTypeOption> token </WarrantyTypeOption>
</ReturnPolicy>
<ReviseStatus> ReviseStatusType
<ItemRevised> boolean </ItemRevised>
</ReviseStatus>
<SecondaryCategory> CategoryType
<CategoryID> string </CategoryID>
<CategoryName> string </CategoryName>
</SecondaryCategory>
<SellerContactDetails> AddressType
</SellerContactDetails>
<SellingStatus> SellingStatusType
<AdminEnded> boolean </AdminEnded>
<BidCount> int </BidCount>
<BidIncrement currencyID="CurrencyCodeType"> AmountType (double) </BidIncrement>
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<HighBidder> UserType
<AboutMePage> boolean </AboutMePage>
<BuyerInfo> BuyerType
<ShippingAddress> AddressType
<Country> CountryCodeType </Country>
<PostalCode> string </PostalCode>
</ShippingAddress>
</BuyerInfo>
<eBayGoodStanding> boolean </eBayGoodStanding>
<EIASToken> string </EIASToken>
<Email> string </Email>
<FeedbackPrivate> boolean </FeedbackPrivate>
<FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
<FeedbackScore> int </FeedbackScore>
<IDVerified> boolean </IDVerified>
<NewUser> boolean </NewUser>
<RegistrationDate> dateTime </RegistrationDate>
<Site> SiteCodeType </Site>
<Status> UserStatusCodeType </Status>
<UserAnonymized> boolean </UserAnonymized>
<UserID> UserIDType (string) </UserID>
<UserIDChanged> boolean </UserIDChanged>
<UserIDLastChanged> dateTime </UserIDLastChanged>
<VATStatus> VATStatusCodeType </VATStatus>
</HighBidder>
<LeadCount> int </LeadCount>
<ListingStatus> ListingStatusCodeType </ListingStatus>
<MinimumToBid currencyID="CurrencyCodeType"> AmountType (double) </MinimumToBid>
<PromotionalSaleDetails> PromotionalSaleDetailsType
<EndTime> dateTime </EndTime>
<OriginalPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalPrice>
<StartTime> dateTime </StartTime>
</PromotionalSaleDetails>
<QuantitySold> int </QuantitySold>
<ReserveMet> boolean </ReserveMet>
<SecondChanceEligible> boolean </SecondChanceEligible>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<AllowPaymentEdit> boolean </AllowPaymentEdit>
<ApplyShippingDiscount> boolean </ApplyShippingDiscount>
<CalculatedShippingRate> CalculatedShippingRateType
<InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
<OriginatingPostalCode> string </OriginatingPostalCode>
<PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
<ShippingIrregular> boolean </ShippingIrregular>
<ShippingPackage> ShippingPackageCodeType </ShippingPackage>
<WeightMajor> MeasureType (decimal) </WeightMajor>
<WeightMinor> MeasureType (decimal) </WeightMinor>
</CalculatedShippingRate>
<ExcludeShipToLocation> string </ExcludeShipToLocation>
<!-- ... more ExcludeShipToLocation nodes here ... -->
<InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
<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 ... -->
<PaymentEdited> boolean </PaymentEdited>
<SalesTax> SalesTaxType
<SalesTaxPercent> float </SalesTaxPercent>
<SalesTaxState> string </SalesTaxState>
<ShippingIncludedInTax> boolean </ShippingIncludedInTax>
</SalesTax>
<SellerExcludeShipToLocationsPreference> boolean </SellerExcludeShipToLocationsPreference>
<ShippingServiceOptions> ShippingServiceOptionsType
<ExpeditedService> boolean </ExpeditedService>
<ShippingService> token </ShippingService>
<ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
<ShippingServicePriority> int </ShippingServicePriority>
<ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
<ShippingTimeMax> int </ShippingTimeMax>
<ShippingTimeMin> int </ShippingTimeMin>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
<TaxTable> TaxTableType
<TaxJurisdiction> TaxJurisdictionType
<JurisdictionID> string </JurisdictionID>
<SalesTaxPercent> float </SalesTaxPercent>
<ShippingIncludedInTax> boolean </ShippingIncludedInTax>
</TaxJurisdiction>
<!-- ... more TaxJurisdiction nodes here ... -->
</TaxTable>
<ThirdPartyCheckout> boolean </ThirdPartyCheckout>
</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>
<StoreURL> anyURI </StoreURL>
</Storefront>
<ThirdPartyCheckoutIntegration> boolean </ThirdPartyCheckoutIntegration>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<TotalQuestionCount> long </TotalQuestionCount>
<Variations> VariationsType
<Variation> VariationType
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
</Variation>
<!-- ... more Variation nodes here ... -->
</Variations>
<WatchCount> long </WatchCount>
</Item>
<!-- ... more Item nodes here ... -->
</ItemArray>
<ItemsPerPage> int </ItemsPerPage>
<PageNumber> int </PageNumber>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
<ReturnedItemCountActual> int </ReturnedItemCountActual>
<Seller> UserType
<AboutMePage> boolean </AboutMePage>
<eBayGoodStanding> boolean </eBayGoodStanding>
<Email> string </Email>
<FeedbackPrivate> boolean </FeedbackPrivate>
<FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
<FeedbackScore> int </FeedbackScore>
<IDVerified> boolean </IDVerified>
<MotorsDealer> boolean </MotorsDealer>
<NewUser> boolean </NewUser>
<RegistrationDate> dateTime </RegistrationDate>
<SellerInfo> SellerType
<AllowPaymentEdit> boolean </AllowPaymentEdit>
<CheckoutEnabled> boolean </CheckoutEnabled>
<CIPBankAccountStored> boolean </CIPBankAccountStored>
<GoodStanding> boolean </GoodStanding>
<MerchandizingPref> MerchandizingPrefCodeType </MerchandizingPref>
<QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
<SafePaymentExempt> boolean </SafePaymentExempt>
<SellerLevel> SellerLevelCodeType </SellerLevel>
<StoreOwner> boolean </StoreOwner>
<StoreURL> anyURI </StoreURL>
<TopRatedSeller> boolean </TopRatedSeller>
</SellerInfo>
<Site> SiteCodeType </Site>
<Status> UserStatusCodeType </Status>
<UserAnonymized> boolean </UserAnonymized>
<UserID> UserIDType (string) </UserID>
<UserIDChanged> boolean </UserIDChanged>
<UserIDLastChanged> dateTime </UserIDLastChanged>
<VATStatus> VATStatusCodeType </VATStatus>
</Seller>
</GetSellerListResponse>
| 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. |
| HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
| Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, 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 | |||
| HasMoreItems | boolean | Conditionally |
If true, there are more items yet to be retrieved. Additional GetSellerList calls with higher page numbers or more items per page must be made to retrieve these items. Not returned if no items match the request.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| ItemArray | ItemArrayType | Always |
Contains the list of the seller's items, one ItemType object per item. Returns empty if no items are available that match the request.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| ItemArray.Item | ItemType | Conditionally,
repeatable: [0..*] |
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has a transactional relationship with that buyer. For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| ItemArray.Item.ApplicationData | string | Conditionally |
Returns custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField. Not applicable to Half.com, use SellerInventoryID instead. Max length: 32. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item.AutoPay | boolean | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See:
|
|
ItemArray.Item .BuyerGuaranteePrice |
AmountType (double) | Conditionally |
For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item .BuyerGuaranteePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
| ItemArray.Item.BuyerProtection | BuyerProtectionCodeType | Conditionally |
Indicates the status of the item's eligibility for the PayPal Buyer Protection program. Not applicable to Half.com. Applicable values: • CustomCode (out) Reserved for internal or future use. • ItemEligible (out) Item is eligible per standard criteria. • ItemIneligible (out) Item is ineligible (e.g., category not applicable). • ItemMarkedEligible (out) Item marked eligible per other criteria. • ItemMarkedIneligible (out) Item marked ineligible per special criteria (e.g., seller's account closed). • NoCoverage (out) For the Australia site, indicates that there is no PayPal Buyer Protection coverage. Coverage details would be in the following sections of the View Item page: the Buy Safely section and the Payment Details section. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item.BuyItNowPrice | AmountType (double) | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine, Medium. See:
|
| ItemArray.Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
| ItemArray.Item.Charity | CharityType | Conditionally |
Identifies a Giving Works listing and the benefiting nonprofit charity organization selected by the charity seller, if any. If specified, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods). When you revise an item, you can add a charity to a non-charity listing, but you cannot remove or change the charity designation. The rules for adding a charity to a listing depend on the listing type. For an auction listing, you can revise an item to add a charity if there are more than 12 hours left for the listing (whether or not the item has bids). For a fixed-price listing, you can revise an item to add a charity if there are more than 12 hours left for the listing, and the item has not been sold. 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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See:
|
|
ItemArray.Item.Charity .CharityID |
string | Conditionally |
A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Charity .CharityListing |
boolean | Conditionally |
If true, indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item's purchase price to a selected nonprofit organization.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Charity .CharityName |
string | Conditionally |
The name of the benefiting nonprofit charity organization selected by the charity seller. Max length: 150. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Charity .CharityNumber |
int | Conditionally |
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.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Charity .DonationPercent |
float | Conditionally |
The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.Charity.LogoURL | string | Conditionally |
The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.Charity.Mission | string | Conditionally |
The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing. Max length: 511. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.Charity.Status | CharityStatusCodeType | Conditionally |
The status of the nonprofit charity organization.
Applicable values: • CustomCode (out) Reserved for internal or future use. • NoLongerValid (out) The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider. • Valid (out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.Country | CountryCodeType | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse. |
|
ItemArray.Item .CrossBorderTrade |
string | Conditionally,
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.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item.Currency | CurrencyCodeType | Conditionally |
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: See Currency. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item.Description | string | Conditionally |
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). DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .DisableBuyerRequirements |
boolean | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .ExtendedSellerContactDetails |
ExtendedContactDetailsType | Conditionally |
Extended contact information for sellers using the Classified Ad format. Specifies the days and hours when the seller can be contacted. To remove seller contact information when revising or relisting an item, use DeletedField.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails |
ContactHoursDetailsType | Conditionally |
All fields related to contact hours including time ranges and user-designated time zone.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours1AnyTime |
boolean | Conditionally |
Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours1Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours1From and Hours1To will be ignored. In the case of this field being false, the values provided Hours1From and Hours1To will be considered.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours1Days |
DaysCodeType | Conditionally |
Indicates the range of days for which the primary contact hours specified by Hours1AnyTime or Hours1From and Hours1To apply. If a value of None is provided for this field, the values provided for Hours1AnyTime, Hours1From, Hours1To are ignored.
Applicable values: • CustomCode (in/out) Reserved for internal or future use. • EveryDay (in/out) Seller can be contacted any day during the specified contact hours. • None (in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored. • Weekdays (in/out) Seller can be contacted Monday through Friday during the specified contact hours. • Weekends (in/out) Seller can be contacted Saturday or Sunday during the specified contact hours. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours1From |
time | Conditionally |
Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails.Hours1To |
time | Conditionally |
Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours2AnyTime |
boolean | Conditionally |
Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours2Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours2From and Hours2To will be ignored. In the case of this field being false, the values provided Hours2From and Hours2To will be considered.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours2Days |
DaysCodeType | Conditionally |
Indicates the range of days for which the secondary contact hours specified by Hours2AnyTime or Hours2From and Hours2To apply. If a value of None is provided for this field, the values provided for Hours2AnyTime, Hours2From, Hours2To are ignored. Note: You cannot set Hours2Days to EveryDay. If Hours1Days is set to EveryDay, secondary contact hours do not apply. Hours2Days cannot be set to the same value as Hours1Days. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • EveryDay (in/out) Seller can be contacted any day during the specified contact hours. • None (in/out) Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored. • Weekdays (in/out) Seller can be contacted Monday through Friday during the specified contact hours. • Weekends (in/out) Seller can be contacted Saturday or Sunday during the specified contact hours. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails .Hours2From |
time | Conditionally |
Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours2Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails.Hours2To |
time | Conditionally |
Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .ExtendedSellerContactDetails .ContactHoursDetails .TimeZoneID |
string | Conditionally |
Indicates the local time zone of the values provided for Hours1From/Hours1To and Hours2From/Hours2To. If you specify a contact hours time range with Hours1From and Hours1To, you must provide a local time zone. Use GeteBayDetails to retrieve a complete list of the TimeZoneID values supported by eBay.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item .FreeAddedCategory |
CategoryType | Conditionally |
ID for a second category that eBay added as a free promotion. You cannot add this yourself. Only returned if the item was listed in a single category and eBay added a free second category. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .FreeAddedCategory.CategoryID |
string | Conditionally |
Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For 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. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .FreeAddedCategory .CategoryName |
string | Conditionally |
Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel). In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings. Max length: 30. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.GetItFast | boolean | Conditionally |
Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Not supported for UK Store Inventory format items. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. See:
|
| ItemArray.Item.GiftIcon | int | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item.HitCount | long | Conditionally |
The number of page views for the item. This number is calculated by eBay and cannot be set via the API. Returned if the hit counter type is BasicStyle, RetroStyle, or HiddenStyle. For HiddenStyle, HitCount is returned only if the requestor is the item's seller.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item.HitCounter | HitCounterCodeType | Always |
Indicates whether an optional hit counter is displayed on the item's listing page and, if so, what type. See HitCounterCodeType for specific values. Not applicable to Half.com. Applicable values: • BasicStyle (in/out) A basic style hit counter. • CustomCode (in/out) Reserved for internal or future use • GreenLED (in/out) A green LED, computer-style hit counter (US only). Non-US sites will return errors if they use GreenLED as input, and should use RetroStyle instead. • Hidden (in/out) A hidden hit counter (US only). The number of page views will only be available to the item's seller. For faster "View Item" page loads, use HiddenStyle. • HiddenStyle (in/out) A hidden hit counter. The number of page views will only be available to the item's seller. • HonestyStyle (in/out) A basic style hit counter (US only). Non-US sites will return errors if they use HonestyStyle as input, and should use BasicStyle instead. • NoHitCounter (in/out) No hit counter. The number of page views will not be available. • RetroStyle (in/out) A retro, computer-style hit counter. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item .IntegratedMerchantCreditCardEnabled |
boolean | Conditionally |
Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. A payment gateway account is used by sellers to accept online credit cards (Visa, MasterCard, American Express, and Discover).
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item .InventoryTrackingMethod |
InventoryTrackingMethodCodeType | Conditionally |
Indicates whether you prefer to track your eBay listings by eBay Item ID or by your own SKU. Not applicable to Half.com. Applicable values: • CustomCode (in/out) Reserved for internal or future use • ItemID (in/out) The seller prefers to track the listing by its eBay item ID. This is the default for all listings. • SKU (in/out) The seller prefers to track the listing by their own SKU. When you track by SKU, it means you can pass your SKU instead of the eBay item ID in other calls that support SKU as an input field. If you choose SKU as your tracking preference for a listing, the value in Item.SKU must be unique across your active listings. You cannot create new listings with the same Item.SKU value while the listing is active (that is, until the existing listing with that SKU has ended). However, you can use ReviseInventoryStatus to update the quantity and/or price for the existing SKU as needed. DetailLevel: ItemReturnDescription, ReturnAll. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
| ItemArray.Item.ItemID | ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item .ItemPolicyViolation |
ItemPolicyViolationType | Conditionally |
Specifies the details of policy violations if the item was administratively canceled.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .ItemPolicyViolation.PolicyID |
long | Conditionally |
Policy ID of the violated policy which resulted in item being administratively canceled.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item .ItemPolicyViolation .PolicyText |
string | Conditionally |
Brief information of the violated policy which resulted in item being administratively canceled.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item .ListingCheckoutRedirectPreference |
ListingCheckoutRedirectPreferenceType | Conditionally |
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.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .ListingCheckoutRedirectPreference .ProStoresStoreName |
string | Conditionally |
The name of the store, if ThirdPartyCheckout is true. To remove this value when revising or relisting an item, use DeletedField. Max length: 200. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .ListingCheckoutRedirectPreference .SellerThirdPartyUsername |
string | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ListingDesigner | ListingDesignerType | Conditionally |
Contains the detail data for the Listing Designer theme and template (if either are used), which can optionally be used to enhance the appearance of the description area of an item's description. See ListingDesignerType for its child elements. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ListingDesigner .LayoutID |
int | Conditionally |
Identifies the Layout template to use when displaying the item's description. Call GetDescriptionTemplates for valid IDs. Set to false in GetDescriptionTemplates (or do not specify LayoutID) to get the standard layout. If a Listing Designer layout is used (except standard layout), PhotoDisplayType must be false (or not be specified). When relisting an item, LayoutID is removed from the listing if you specify ListingDesignerType without LayoutID. Alternatively, to remove this value when revising or relisting an item, use DeletedField.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ListingDesigner .OptimalPictureSize |
boolean | Conditionally |
If true, indicates that the item's picture will be enlarged to fit description of the item.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ListingDesigner .ThemeID |
int | Conditionally |
ID for the Listing Designer theme template to use when displaying the item's description. When relisting, if you specify ListingDesignerType without ThemeID, ThemeID is removed from the listing. Alternatively, to remove this value when revising or relisting an item, use DeletedField.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ListingDetails | ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ListingDetails .Adult |
boolean | Conditionally |
If true, the item is listed in a Mature category. Users must accept the Mature Category agreement on the eBay site to retrieve items listed in Mature categories. (Users do not need to sign this agreement to be able to list items in Mature Categories.)
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine, Medium. |
|
ItemArray.Item.ListingDetails .BestOfferAutoAcceptPrice |
AmountType (double) | Conditionally |
The price at which best offers are automatically accepted. Similar in use to MinimumBestOfferPrice. If a buyer submits a best offer that is above this value, the offer is automatically accepted by the seller. Applies only to items listed in categories that support the BestOfferAutoAcceptPrice feature. Best Offer must be enabled for the item, and only the seller who listed the item will see BestOfferAutoAcceptPrice in a call response. On the US eBay Motors site (site ID 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.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ListingDetails .BestOfferAutoAcceptPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ListingDetails .BindingAuction |
boolean | Conditionally |
Applicable for Real Estate auctions only. If true, buyers and sellers are expected to follow through on the sale. If false, bids for the Real Estate auction are only expressions of interest.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine, Medium. |
|
ItemArray.Item.ListingDetails .CheckoutEnabled |
boolean | Conditionally |
Indicates whether checkout is enabled for this item. If true, indicates that the seller elects to allow the item purchase to go through the checkout process, if the buyer chooses to do so.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine, Medium. See Checkout. |
|
ItemArray.Item.ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine, Medium. |
| ItemArray.Item.ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
| ItemArray.Item.ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
| ItemArray.Item.ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ListingDetails .EndTime |
dateTime | Conditionally |
Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended. In GetSearchResults, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times. In GetSearchResults, the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item.ListingDetails .HasPublicMessages |
boolean | Conditionally |
Indicates whether the item has any publicly displayed messages. Use GetMemberMessages to retrieve public messages for the item if this flag indicates that there are any.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ListingDetails .HasReservePrice |
boolean | Conditionally |
If true, the seller specified a value in ReservePrice.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine, Medium. |
|
ItemArray.Item.ListingDetails .HasUnansweredQuestions |
boolean | Conditionally |
Indicates whether the item has any unanswered questions. Use GetMemberMessages to retrieve unanswered questions for the item if this flag indicates that there are any.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ListingDetails .MinimumBestOfferMessage |
string | Conditionally |
Deprecated as of version 547. No longer functional. 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. DetailLevel: ItemReturnDescription, ReturnAll. Deprecation version: 547. See also Deprecated Objects. |
|
ItemArray.Item.ListingDetails .MinimumBestOfferPrice |
AmountType (double) | Conditionally |
Specifies the minimum acceptable best offer price. If a buyer submits a best offer that is below this value, the offer is automatically declined by the seller. Applies only to items listed in categories that support the Best Offer Auto-Decline feature. Best Offer must be enabled for the item, and only the seller who listed the item can see this value. To remove this value when revising or relisting an item, use DeletedField.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ListingDetails .MinimumBestOfferPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ListingDetails .PayPerLeadEnabled |
boolean | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ListingDetails .RelistedItemID |
ItemIDType (string) | Conditionally |
Indicates the new item ID for a re-listed item. When an item is re-listed, the item ID for the new (re-list) item is added to the old (expired) listing to provide buyers a means to navigate to the new listing. This value only appears when the old listing is retrieved. Output only.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ListingDetails .StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item.ListingDetails .TCROriginalItemID |
ItemIDType (string) | Conditionally |
Indicates the item ID of the original item listing from which a Transaction Confirmation Request (TCR) was created. This value is only returned when the data for a TCR is retrieved.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item.ListingDetails .ViewItemURL |
anyURI | Conditionally |
The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. If you enabled affiliate tracking in a search-related call (for example, if you used the AffiliateTrackingDetails container in an applicable call), ViewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network). In search results (like the GetSearchResults response), this link to the View Item page is configured to select the applicable variation. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ListingDetails .ViewItemURLForNaturalSearch |
anyURI | Conditionally |
This URL takes you to the same View Item page as ViewItemURL, but this URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines. The URL includes the item title along with other optimizations. To note, "?" (question mark) optimizes to "_W0QQ", "&" (ampersand) optimizes to "QQ", and "=" (equals sign) optimizes to "Z". If you are an eBAy affiliate, use this URL to promote your affiliate information. Note: This URL may include additional query parameters that don't appear in ViewItemURL and vice versa. You should not modify the query syntax. For example, eBay won't recognize the URL if you change QQ to ?. In search results (like the GetSearchResults response), if the result is a variation from a multi-variation listing, this link to the View Item page is configured to select the applicable variation. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ListingDuration | token | Conditionally |
Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time. The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable). The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information. When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours. Required for Half.com (but only specify GTC). DetailLevel: ItemReturnDescription, ReturnAll. See:
Applicable values: See ListingDurationCodeType |
|
ItemArray.Item .ListingEnhancement |
ListingEnhancementsCodeType | Conditionally,
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. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ListingSubtype2 | ListingSubtypeCodeType | Conditionally |
Indicates a specific type of lead generation format listing, such as classified ad or local market best offer listing. Only applicable when ListingType=LeadGeneration. Note: ListingSubtype2 replaces the deprecated ListingSubtype field. If both are specified in a request, ListingSubtype2 takes precedence.
Applicable values: • ClassifiedAd (in/out) General classified ad listing subtype. • CustomCode (in/out) Reserved for internal or future use • LocalMarketBestOfferOnly (in/out) General LocalMarketBestOfferOnly listing subtype. DetailLevel: ItemReturnDescription, ReturnAll. See:
|
| ItemArray.Item.ListingType | ListingTypeCodeType | Conditionally |
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. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601.
• 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.) DetailLevel: ItemReturnDescription, ReturnAll. See:
|
| ItemArray.Item.Location | string | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item .MotorsGermanySearchable |
boolean | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.PaymentMethods | BuyerPaymentMethodCodeType | Conditionally,
repeatable: [0..*] |
Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. 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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. See:
|
| ItemArray.Item.PictureDetails | PictureDetailsType | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| ItemArray.Item.PrimaryCategory | CategoryType | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See:
|
|
ItemArray.Item.PrimaryCategory .CategoryID |
string | Conditionally |
Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For 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. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.PrimaryCategory .CategoryName |
string | Conditionally |
Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel). In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings. Max length: 30. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.PrivateListing | boolean | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ProxyItem | boolean | Conditionally |
Some listings on the eBay platform originate from eBay affiliates. Depending on the relationship the affiliate has with eBay, there are times when the affiliate retains ownership of the listing. When this occurs the representation of the listing on eBay is considered a proxy item. Proxy items can only be edited using API requests from the applications that originally listed them.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item.Quantity | int | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item.ReservePrice | AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support 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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. See:
|
| ItemArray.Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
| ItemArray.Item.ReturnPolicy | ReturnPolicyType | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See:
|
|
ItemArray.Item.ReturnPolicy .Description |
string | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See (GeteBayDetails) ReturnPolicyDetails.Description for sites that support this field. |
|
ItemArray.Item.ReturnPolicy .EAN |
string | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See (GeteBayDetails) ReturnPolicyDetails.EAN for sites that support this field. |
|
ItemArray.Item.ReturnPolicy .Refund |
string | Conditionally |
Display string that buyer applications can use to present RefundOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the Refund.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use RefundOption instead.) DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ReturnPolicy .RefundOption |
token | Conditionally |
Indicates how the seller will compensate the buyer for a returned item. Use the ReturnPolicy.Description field to explain the policy details (such as how quickly the seller will process the refund, whether the seller must receive the item before processing the refund, and other useful details.). 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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See (GeteBayDetails) RefundOption for sites that support this field, and applicable values. Applicable values: See RefundOptionsCodeType |
|
ItemArray.Item.ReturnPolicy .ReturnsAccepted |
string | Conditionally |
Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ReturnsAccepted.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.) DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ReturnPolicy .ReturnsAcceptedOption |
token | Conditionally |
Indicates whether the seller allows the buyer to return the item. This field is required when ReturnPolicy is specified. (If you specify ReturnsNotAccepted, the View Item page may initially show the return policy as unspecified. In a future release, the View Item page will be updated to indicate that returns are not accepted instead.) 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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See:
Applicable values: See ReturnsAcceptedOptionsCodeType |
|
ItemArray.Item.ReturnPolicy .ReturnsWithin |
string | Conditionally |
Display string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ReturnsWithin.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use ReturnsWithinOption instead.) DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ReturnPolicy .ReturnsWithinOption |
token | Conditionally |
The buyer can return the item within this period of time from the day they receive the item. Use the ReturnPolicy.Description field to explain the policy details. Applicable values: 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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See (GeteBayDetails) ReturnsWithinOption for sites that support this field, and applicable values. Applicable values: See ReturnsWithinOptionsCodeType |
|
ItemArray.Item.ReturnPolicy .ShippingCostPaidBy |
string | Conditionally |
Display string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the ShippingCostPaidBy.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use ShippingCostPaidByOption instead.) DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ReturnPolicy .ShippingCostPaidByOption |
token | Conditionally |
The party who pays the shipping cost for a returned item. Use the ReturnPolicy.Description field to explain any additional details. Applicable values: 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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See (GeteBayDetails) ShippingCostPaidByOption for sites that support this field, and applicable values. Applicable values: See ShippingCostPaidByOptionsCodeType |
|
ItemArray.Item.ReturnPolicy .WarrantyDuration |
string | Conditionally |
Display string that buyer applications can use to present WarrantyDurationOption in a more user-friendly format to buyers. For example, For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the WarrantyDuration.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use WarrantyDurationOption instead.) DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ReturnPolicy .WarrantyDurationOption |
token | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See (GeteBayDetails) WarrantyDurationOption for sites that support this field, and applicable values. Applicable values: See WarrantyDurationOptionsCodeType |
|
ItemArray.Item.ReturnPolicy .WarrantyOffered |
string | Conditionally |
Display string that buyer applications can use to present WarrantyOfferedOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the WarrantyOffered.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use WarrantyOfferedOption instead.) DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ReturnPolicy .WarrantyOfferedOption |
token | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See:
Applicable values: See WarrantyOfferedCodeType |
|
ItemArray.Item.ReturnPolicy .WarrantyType |
string | Conditionally |
Display string that buyer applications can use to present WarrantyTypeOption in a more user-friendly format to buyers. For example, in GetItem and related calls, this value is usually localized and can contain spaces. If necessary, you can predict the choice of values based on the WarrantyType.Description options returned by GeteBayDetails. Not applicable as input to the AddItem family of calls. (Use WarrantyTypeOption instead.) DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ReturnPolicy .WarrantyTypeOption |
token | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See (GeteBayDetails) WarrantyTypeOption for sites that support this field, and applicable values. Applicable values: See WarrantyTypeOptionsCodeType |
| ItemArray.Item.ReviseStatus | ReviseStatusType | Conditionally |
An output value only, indicates whether an item has been revised since the listing became active and, if so, which among a subset of properties have been changed by the revision. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ReviseStatus .ItemRevised |
boolean | Conditionally |
If true, indicates the item was revised since the listing became active. Output only.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .SecondaryCategory |
CategoryType | Conditionally |
ID for second category in which the item is listed (also see Item.PrimaryCategory). For the AddItem family of calls: Listing an item in a second category is optional. Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. Not applicable to Half.com. 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. DetailLevel: ItemReturnDescription, ReturnAll. See Categories. |
|
ItemArray.Item .SecondaryCategory.CategoryID |
string | Conditionally |
Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For 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. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .SecondaryCategory .CategoryName |
string | Conditionally |
Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel). In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings. Max length: 30. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item .SellerContactDetails |
AddressType | Conditionally |
Contact information for sellers using the Classified Ad format for eBay Motors vehicles categories. To remove seller contact information when revising or relisting an item, use DeletedField. The seller contact details for the primary and secondary phone numbers cannot be deleted individually. To provide City, State, and Zip code information in SellerContactDetails use the following field: Item.SellerContactDetails.Street2 To delete the secondary phone number, for example, you must delete all of the secondary phone fields: Item.SellerContactDetails.Phone2AreaOrCityCode Item.SellerContactDetails.Phone2CountryCode Item.SellerContactDetails.Phone2CountryPrefix Item.SellerContactDetails.Phone2LocalNumber DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.SellingStatus | SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .AdminEnded |
boolean | Conditionally |
If included in the response as true, indicates that the listing was administratively canceled due to a violation of eBay's listing policies and that the item can be relisted using RelistItem. Note that GetItem returns an error (invalid item ID) in the response if Item.SellingStatus.AdminEnded is true and the requesting user is not the seller of the item.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.SellingStatus .BidCount |
int | Conditionally |
Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .BidIncrement |
AmountType (double) | Conditionally |
Smallest amount a bid must be above the current high bid. Only applicable to competitive-bid item listings (Chinese auctions). Returns zero (0.00) for Ad type, eBay Stores Inventory (Stores Fixed-price), and Basic Fixed-Price (Fixed Price Item) listings.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
| ItemArray.Item.SellingStatus .BidIncrement [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
| ItemArray.Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.SellingStatus .CurrentPrice |
AmountType (double) | Conditionally |
For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
| ItemArray.Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.SellingStatus .HighBidder |
UserType | Conditionally |
For ended Chinese auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, basic fixed price (FixedPriceItem) and ended Store Inventory (StoresFixedPrice) listings, this field is a container for the user ID of the purchaser. This field isn't returned for auctions with no bids, or for active fixed price listings, or for active Store Inventory listings. In the case of PlaceOffer, for chinese auctions, this field is a container for the high bidder's user ID. In the PlaceOffer response, the following applies: For multiple-quantity, fixed-price listings, the high bidder is only returned if there is just one transaction (or only for the first transaction that is created).
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.AboutMePage |
boolean | Conditionally |
If true, indicates that the user has set up an About Me page.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.BuyerInfo |
BuyerType | Conditionally |
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.BuyerInfo .ShippingAddress |
AddressType | Conditionally |
Contains the address of the buyer in the transaction, to which the seller would ship the item(s). See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.BuyerInfo .ShippingAddress.Country |
CountryCodeType | Conditionally |
The country code of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Applicable values: See Country. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.BuyerInfo .ShippingAddress.PostalCode |
string | Conditionally |
User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Max length: 12. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.eBayGoodStanding |
boolean | Conditionally |
If true, indicates that the user is in good standing with eBay.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.EIASToken |
string | Conditionally |
Unique identifier for the user that does not change when the eBay user name is changed. Use when an application needs to associate a new eBay user name with the corresponding eBay user. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.Email |
string | Conditionally |
Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Based on Trust and Safety policies, the time is unspecified and can vary by site. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.SellingStatus .HighBidder.FeedbackPrivate |
boolean | Conditionally |
Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.FeedbackRatingStar |
FeedbackRatingStarCodeType | Conditionally |
Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.
Applicable values: • Blue (out) Blue Star, feedback score 50-99. • CustomCode (out) Reserved for internal or future use. • Green (out) Green Star, feedback score 5,000-9,999. • GreenShooting (out) Green Shooting Star, feedback score 500,000-999,999. • None (out) No graphic displayed, feedback score 0-9. • Purple (out) Purple Star, feedback score 500-999. • PurpleShooting (out) Purple Shooting Star, feedback score 50,000-99,999. • Red (out) Red Star, feedback score 1,000-4,999 • RedShooting (out) Red Shooting Star, feedback score 100,000-499,999. • SilverShooting (out) Silver Shooting Star, feedback score 1,000,000 and above. • Turquoise (out) Turquoise Star, feedback score 100-499. • TurquoiseShooting (out) Turquoise Shooting Star, feedback score 25,000-49,999. • Yellow (out) Yellow Star, feedback score 10-49. • YellowShooting (out) Yellow Shooting Star, feedback score 10,000-24,999. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.FeedbackScore |
int | Conditionally |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.IDVerified |
boolean | Conditionally |
Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.NewUser |
boolean | Conditionally |
If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.RegistrationDate |
dateTime | Conditionally |
Indicates the date the specified user originally registered with eBay. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.Site |
SiteCodeType | Conditionally |
eBay site the user is registered with. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Applicable values: See Site. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.Status |
UserStatusCodeType | Conditionally |
Indicates the user's registration/user status.
Applicable values: • AccountOnHold (out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items • Confirmed (out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category • CreditCardVerify (out) User has completed registration and confirmation, but is pending a verification of credit card information • CreditCardVerifyHalfOptIn (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the verification of credit card information is still pending • CustomCode (out) Reserved for internal or future use • Deleted (out) Records for the specified user have been deleted • Ghost (out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay • Guest (out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow. • InMaintenance (out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status • Merged (out) User record has been merged with another account record for the same user • RegistrationCodeMailOut (out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email • Suspended (out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement • TermPending (out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user • Unconfirmed (out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email • UnconfirmedExpress Deprecated as of version 579.
• UnconfirmedHalfOptIn (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending • Unknown (out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem (Not all values in UserStatusCodeType apply to this field.) DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.UserAnonymized |
boolean | Always |
Indicates whether or not the User container has been made anonymous. If true, some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed. Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.UserID |
UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized. For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.UserIDChanged |
boolean | Conditionally |
If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser). Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.UserIDLastChanged |
dateTime | Conditionally |
Date and time the user's data was last changed (in GMT). Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .HighBidder.VATStatus |
VATStatusCodeType | Conditionally |
Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).
Applicable values: • CustomCode (out) Reserved for internal or future use • NoVATTax (out) VAT is not applicable • VATExempt (out) Residence in a country with VAT and user is registered as VAT-exempt • VATTax (out) Residence in a country with VAT and user is not registered as VAT-exempt DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. See VAT-exempt Sellers. |
|
ItemArray.Item.SellingStatus .LeadCount |
int | Conditionally |
Applicable to Ad type listings only. Indicates how many leads to potential buyers are associated with this item. Returns 0 (zero) for listings in other formats. You must be the seller of the item to retrieve the lead count.
DetailLevel: ReturnAll. |
|
ItemArray.Item.SellingStatus .ListingStatus |
ListingStatusCodeType | Conditionally |
Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.
Applicable values: • Active (out) The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing. • Completed (out) The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding Buy It Now purchases) require the listing status to be Completed before the Final Value Fee is returned. • Custom (out) Reserved for internal or future use. • CustomCode (out) Reserved for internal or future use. • Ended (out) The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .MinimumToBid |
AmountType (double) | Conditionally |
Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to competitive-bid item listings (Chinese auctions). Returns null for basic Fixed Price (FixedPriceItem), Store Inventory (StoresFixedPrice), and Ad type listings. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. 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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
| ItemArray.Item.SellingStatus .MinimumToBid [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.SellingStatus .PromotionalSaleDetails |
PromotionalSaleDetailsType | Conditionally |
If a seller has reduced the price of a listed item with the Promotional Price Display feature, this field contains the original price of the discounted item, along with the start-time and end-time of the discount.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.SellingStatus .PromotionalSaleDetails .EndTime |
dateTime | Conditionally |
End time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.SellingStatus .PromotionalSaleDetails .OriginalPrice |
AmountType (double) | Conditionally |
Original price of an item whose price a seller has reduced with the Promotional Price Display feature.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.SellingStatus .PromotionalSaleDetails .OriginalPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.SellingStatus .PromotionalSaleDetails .StartTime |
dateTime | Conditionally |
Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.SellingStatus .QuantitySold |
int | Conditionally |
For most listings, this is the total number of items purchased so far (in the listing's lifetime). (If the seller has not changed the original quantity, subtract from the value returned in Quantity to calculate the number of items still available for purchase.) If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .ReserveMet |
boolean | Conditionally |
Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.SellingStatus .SecondChanceEligible |
boolean | Conditionally |
Part of the Second Chance Offer feature, indicates whether the seller can extend a second chance offer for the item.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
| ItemArray.Item.ShippingDetails | ShippingDetailsType | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See:
|
|
ItemArray.Item.ShippingDetails .AllowPaymentEdit |
boolean | Conditionally |
Instead of using this tag, see the PaymentEdited tag. Originally, the AllowPaymentEdit tag specified whether the seller allows the buyer to edit the payment amount for the transaction. (Sellers enabled this property in their My eBay user preferences on the eBay site.) ShippingDetails.AllowPaymentEdit is no longer being populated by calls to GetItemTransactions. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .ApplyShippingDiscount |
boolean | Conditionally |
Whether the seller specifies that a shipping discount is to be applied (in the event that an item's transaction is later combined with others into a single order). Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.ShippingDetails .CalculatedShippingRate |
CalculatedShippingRateType | Conditionally |
Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts |
AmountType (double) | Conditionally | Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only. |
| ItemArray.Item.ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ShippingDetails .CalculatedShippingRate .OriginatingPostalCode |
string | Conditionally |
Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts |
AmountType (double) | Conditionally |
Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ShippingDetails .CalculatedShippingRate .ShippingIrregular |
boolean | Conditionally |
Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .CalculatedShippingRate .ShippingPackage |
ShippingPackageCodeType | Conditionally |
The nature of the package used to ship the item(s). Required for calculated shipping only.
Applicable values: See ShippingPackage. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .CalculatedShippingRate .WeightMajor |
MeasureType (decimal) | Conditionally |
WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service. For calculated shipping only. Required on input when calculated shipping is used.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .CalculatedShippingRate .WeightMinor |
MeasureType (decimal) | Conditionally |
See the definition of WeightMajor. For calculated shipping only. Required on input when calculated shipping is used.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .ExcludeShipToLocation |
string | Conditionally,
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. DetailLevel: ItemReturnDescription, ReturnAll. Applicable values: See CountryCodeType, ShippingRegionCodeType |
|
ItemArray.Item.ShippingDetails .InsuranceOption |
InsuranceOptionCodeType | Conditionally |
Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored. Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged. This field is 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. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.ShippingDetails .InternationalShippingServiceOption |
InternationalShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions. If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes. 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. DetailLevel: ItemReturnDescription, ReturnAll. 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). |
|
ItemArray.Item.ShippingDetails .InternationalShippingServiceOption .ShippingService |
token | Conditionally |
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.
DetailLevel: ItemReturnDescription, ReturnAll. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
ItemArray.Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
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.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.
DetailLevel: ItemReturnDescription, ReturnAll. See Shipping. |
| ItemArray.Item.ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ShippingDetails .InternationalShippingServiceOption .ShippingServicePriority |
int | Conditionally |
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.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .InternationalShippingServiceOption .ShipToLocation |
string | Conditionally,
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.
DetailLevel: ItemReturnDescription, ReturnAll. See ShipToLocation. Applicable values: See CountryCodeType, ShippingRegionCodeType |
|
ItemArray.Item.ShippingDetails .PaymentEdited |
boolean | Conditionally |
Whether the seller allows the buyer to edit the payment amount for the transaction. (Sellers enable this property in their My eBay user preferences on the eBay site.) Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .SalesTax |
SalesTaxType | Conditionally |
Sales tax details. US site only. Flat and calculated shipping. Not applicable to eBay Motors vehicle listings. Applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.ShippingDetails .SalesTax.SalesTaxPercent |
float | Conditionally |
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). DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.ShippingDetails .SalesTax.SalesTaxState |
string | Conditionally |
State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. Applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .SalesTax .ShippingIncludedInTax |
boolean | Conditionally |
(US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. Applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.ShippingDetails .SellerExcludeShipToLocationsPreference |
boolean | Conditionally |
Sellers can set up a global Exclude Ship-To List through their My eBay account. The Exclude Ship-To List defines the countries to where the seller does not ship, by default. This flag returns true if the Exclude Ship-To List is enabled by the seller for the associated item. If false, the seller's Exclude Ship-To List is either not set up, or it has been overridden by the seller when they listed the item with ExcludeShipToLocation fields. In the response, ExcludeShipToLocation fields detail the locations to where the seller will not ship the item, regardless of the value returned in this field. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
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. DetailLevel: ItemReturnDescription, ReturnAll. 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). |
|
ItemArray.Item.ShippingDetails .ShippingServiceOptions .ExpeditedService |
boolean | Conditionally |
Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingService |
token | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items and should be zero for single-item listings. Default value is 0.00. For flat shipping only. Not applicable to Half.com.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingServicePriority |
int | Conditionally |
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.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingSurcharge |
AmountType (double) | Conditionally |
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.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingSurcharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingTimeMax |
int | Conditionally |
The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .ShippingServiceOptions .ShippingTimeMin |
int | Conditionally |
The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .TaxTable |
TaxTableType | Conditionally |
Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned. For GetItem, a tax table is returned if it exists when: - DetailLevel is set to ReturnAll or ItemReturnDescription (in this case, the value of IncludeTaxTable does not matter). - IncludeTaxTable is set to true and DetailLevel is not set or it is set to ItemReturnAttributes. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.ShippingDetails .TaxTable.TaxJurisdiction |
TaxJurisdictionType | Conditionally,
repeatable: [0..*] |
Sales tax details for zero or more jurisdictions (states, provinces, etc). For GetTaxTable: If DetailLevel is not specified, information is returned only for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned, but are empty. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.ShippingDetails .TaxTable.TaxJurisdiction .JurisdictionID |
string | Conditionally |
Representative identifier for the jurisdiction. Typically an abbreviation (for example, CA for California).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item.ShippingDetails .TaxTable.TaxJurisdiction .SalesTaxPercent |
float | Conditionally |
The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). For GetTaxTable: this tag has no value if the user's tax table has not been set. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item.ShippingDetails .TaxTable.TaxJurisdiction .ShippingIncludedInTax |
boolean | Conditionally |
Whether shipping costs are to be part of the base amount that is taxed. For GetTaxTable: This tag is empty if the user did not previously provide information. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemArray.Item.ShippingDetails .ThirdPartyCheckout |
boolean | Conditionally |
Whether checkout for this is to be handled by a Third-Party Checkout application. The counterpart in the AddItem family of calls is Item.ThirdPartyCheckout. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item .ShippingTermsInDescription |
boolean | Conditionally |
Indicates whether details about shipping costs and arrangements are specified in the item description. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.ShipToLocations | string | Conditionally,
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See:
Applicable values: See CountryCodeType, ShippingRegionCodeType |
| ItemArray.Item.Site | SiteCodeType | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. See:
|
| ItemArray.Item.SKU | SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after 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. DetailLevel: ItemReturnDescription, ReturnAll. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
ItemArray.Item .SkypeContactOption |
SkypeContactOptionCodeType | Conditionally,
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. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.SkypeEnabled | boolean | Conditionally |
Specifies that Skype-related information is included with an item listing, including, for example, Skype Voice. Skype-related information provides buttons that enable potential buyers to contact sellers through Skype. Information about Skype is available at www.Skype.com. If all of the prerequisites for adding Skype buttons to listings are met (see the eBay Web Services Guide), you can make communication through Skype available in listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are specified.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.SkypeID | string | Conditionally |
The Skype name of the seller. Requires that SkypeEnabled is set to true. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.StartPrice | AmountType (double) | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
| ItemArray.Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
| ItemArray.Item.Storefront | StorefrontType | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.Storefront .StoreCategory2ID |
long | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.Storefront .StoreCategoryID |
long | Conditionally |
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.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item.Storefront .StoreURL |
anyURI | Conditionally |
The URL of the seller's eBay Store page. GetProducts only returned a default URL at the time of this writing.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item .ThirdPartyCheckoutIntegration |
boolean | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.TimeLeft | duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
| ItemArray.Item.Title | string | Conditionally |
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. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Coarse, Fine, Medium. |
|
ItemArray.Item .TotalQuestionCount |
long | Conditionally |
The number of questions asked about this item. Applies to eBay Motors Pro applications only.
DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.Variations | VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price (or Store Inventory Format) listing. For example, a single listing could contain multiple items of the same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation can have its own quantity and price. For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no transactions, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0. As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing. For GetItem and related calls Only returned when a listing has variations. For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified. For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.) DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Variations .Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Variations .Variation.Quantity |
int | Conditionally |
For AddFixedPriceItem and related calls: On input, this should be the number of items available for sale that are associated with this variation. If you set Quantity to zero when you create a new listing (or relist), the variation is dropped from the listing. For GetItem and related calls: On output, this is the total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract QuantitySold from this value. For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Variations .Variation.SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Variations .Variation.SellingStatus .QuantitySold |
int | Conditionally |
For most listings, this is the total number of items purchased so far (in the listing's lifetime). (If the seller has not changed the original quantity, subtract from the value returned in Quantity to calculate the number of items still available for purchase.) If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ItemReturnDescription, ReturnAll. GranularityLevel: Fine. |
|
ItemArray.Item.Variations .Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. eBay preserves the SKU on the variation, enabling you to obtain it before and after a transaction is created. All SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU (if specified). If Item.InventoryTrackingMethod is set to true, the SKU values must be specified and they must be unique across all the seller's active listings. Only returned if the seller specified a SKU for the variation. Max length: 70. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Variations .Variation.StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.Variations .Variation.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
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. |
|
ItemArray.Item.Variations .Variation.VariationSpecifics |
NameValueListArrayType | Conditionally |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can't add or change names or values in variation specifics (because the set of variation specifics serves as a unique identifier). However, you can delete or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (transactions). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ItemReturnDescription, ReturnAll. See:
|
|
ItemArray.Item.Variations .Variation.VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Variations .Variation.VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For 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. DetailLevel: ItemReturnDescription, ReturnAll. |
|
ItemArray.Item.Variations .Variation.VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For 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). DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemArray.Item.WatchCount | long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. DetailLevel: ItemReturnDescription, ReturnAll. |
| ItemsPerPage | int | Conditionally |
Indicates the number of items that are being returned per page of data (i.e., per call). Will be the same as the value specified in the Pagination.EntriesPerPage input. Only returned if items are returned.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| PageNumber | int | Conditionally |
Indicates which page of data was just returned. Will be the same as the value specified in the Pagination.PageNumber input. (If the input is higher than the total number of pages, the call fails with an error.) Only returned if items are returned.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| PaginationResult | PaginationResultType | Always |
Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
PaginationResult .TotalNumberOfEntries |
int | Always |
Indicates the total number of entries that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no entries are available.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
PaginationResult .TotalNumberOfPages |
int | Always |
Indicates the total number of pages of data that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no pages are available.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| ReturnedItemCountActual | int | Always |
Indicates the total number of items returned (i.e., the number of ItemType objects in ItemArray).
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| Seller | UserType | Always |
Indicates the seller whose items are returned. The seller is the eBay member whose UserID was passed in the request. If UserID was not specified, the seller is the user who made the request (identified by eBayAuthToken).
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.AboutMePage | boolean | Always |
If true, indicates that the user has set up an About Me page.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.eBayGoodStanding | boolean | Always |
If true, indicates that the user is in good standing with eBay.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.Email | string | Conditionally |
Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Based on Trust and Safety policies, the time is unspecified and can vary by site. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. |
| Seller.FeedbackPrivate | boolean | Always |
Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.FeedbackRatingStar | FeedbackRatingStarCodeType | Always |
Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.
Applicable values: • Blue (out) Blue Star, feedback score 50-99. • CustomCode (out) Reserved for internal or future use. • Green (out) Green Star, feedback score 5,000-9,999. • GreenShooting (out) Green Shooting Star, feedback score 500,000-999,999. • None (out) No graphic displayed, feedback score 0-9. • Purple (out) Purple Star, feedback score 500-999. • PurpleShooting (out) Purple Shooting Star, feedback score 50,000-99,999. • Red (out) Red Star, feedback score 1,000-4,999 • RedShooting (out) Red Shooting Star, feedback score 100,000-499,999. • SilverShooting (out) Silver Shooting Star, feedback score 1,000,000 and above. • Turquoise (out) Turquoise Star, feedback score 100-499. • TurquoiseShooting (out) Turquoise Shooting Star, feedback score 25,000-49,999. • Yellow (out) Yellow Star, feedback score 10-49. • YellowShooting (out) Yellow Shooting Star, feedback score 10,000-24,999. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.FeedbackScore | int | Always |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.IDVerified | boolean | Always |
Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.MotorsDealer | boolean | Conditionally |
Indicates if item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.NewUser | boolean | Always |
If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.RegistrationDate | dateTime | Always |
Indicates the date the specified user originally registered with eBay. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.SellerInfo | SellerType | Always |
Contains information about the user as a seller, such as whether the seller is authorized to list Live Auction items or opts to have items cross-promoted. This field is replaced by the SellerBusinessType field if the user is a business seller with a site ID of 77 (Germany), 3 (UK), 205 (Ireland) or 100 (Motors). See SellerType or SellerBusinessCodeType for the child elements. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Coarse, Fine, Medium. |
|
Seller.SellerInfo .AllowPaymentEdit |
boolean | Always |
Indicates whether the user as a seller by default allows buyers to edit the total cost of an item (while in checkout). (Sellers enable this property in their My eBay user preferences on the eBay site.)
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
|
Seller.SellerInfo .CheckoutEnabled |
boolean | Always |
Indicates whether the user as a seller has the option set to default new item listings to go through checkout. (Sellers enable this property in their My eBay user preferences on the eBay site.)
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
|
Seller.SellerInfo .CIPBankAccountStored |
boolean | Always |
If true, indicates that the user has stored bank account information with eBay in order to use the "CIP in checkout" feature. Applicable to all eBay sites that support CIP as a payment method.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.SellerInfo.GoodStanding | boolean | Always |
If true, indicates that the user is in good standing with eBay. (One of the requirements for listing a new item with Immediate Payment.)
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
|
Seller.SellerInfo .MerchandizingPref |
MerchandizingPrefCodeType | Always |
Indicates whether the seller participates in the Merchandising Manager feature. If so, the seller can set up rules for cross-promoting items from the seller's store. If not, eBay cross-promotes items as the seller's items are being viewed or purchased.
Applicable values: • CustomCode (out) Reserved for internal or future use. • OptIn (out) Seller allows item cross-promotion. • OptOut (out) Seller does not allow item cross-promotion. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
|
Seller.SellerInfo .QualifiesForB2BVAT |
boolean | Always |
Indicates whether the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
|
Seller.SellerInfo .SafePaymentExempt |
boolean | Always |
If true, the user is currently exempt from the requirement to offer at least one safe payment method (PayPal/PaisaPay or one of the credit cards specified in Item.PaymentMethods) when listing items. This value should only return true for sellers who registered before January 17, 2007. Otherwise, it should return false. This setting overrides both the site and category values for SafePaymentRequired. Default: false. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.SellerInfo.SellerLevel | SellerLevelCodeType | Always |
The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list.
Applicable values: • Bronze (out) Bronze (lowest tier) • CustomCode (out) Reserved for internal or future use • Gold (out) Gold (between Silver and Platinum) • None (out) Not a PowerSeller (eBay has not yet evaluated your PowerSeller status, or you have not chosen to be a member of the PowerSeller program, or you lost your PowerSeller status due to a policy violation.) • Platinum (out) Platinum (between Gold and Titanium) • Silver (out) Silver (between Bronze and Gold) • Titanium (out) Titanium (highest tier) DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.SellerInfo.StoreOwner | boolean | Conditionally |
Indicates whether the user has an eBay Store (boolean value).
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.SellerInfo.StoreURL | anyURI | Conditionally |
URL for the user's eBay Store, if the user is a Store owner. Blank if not.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
|
Seller.SellerInfo .TopRatedSeller |
boolean | Conditionally |
Coming soon. Whether seller is certified as a Top-Rated Seller, and is qualified for benefits such as final value fee discount and increased visibility in fixed-price searches. Returned when seller is a Top-Rated Seller.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.Site | SiteCodeType | Always |
eBay site the user is registered with. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Applicable values: See Site. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.Status | UserStatusCodeType | Always |
Indicates the user's registration/user status.
Applicable values: • AccountOnHold (out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items • Confirmed (out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category • CreditCardVerify (out) User has completed registration and confirmation, but is pending a verification of credit card information • CreditCardVerifyHalfOptIn (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the verification of credit card information is still pending • CustomCode (out) Reserved for internal or future use • Deleted (out) Records for the specified user have been deleted • Ghost (out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay • Guest (out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow. • InMaintenance (out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status • Merged (out) User record has been merged with another account record for the same user • RegistrationCodeMailOut (out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email • Suspended (out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement • TermPending (out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user • Unconfirmed (out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email • UnconfirmedExpress Deprecated as of version 579.
• UnconfirmedHalfOptIn (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending • Unknown (out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem (Not all values in UserStatusCodeType apply to this field.) DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.UserAnonymized | boolean | Always |
Indicates whether or not the User container has been made anonymous. If true, some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed. Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true. GranularityLevel: Fine. |
| Seller.UserID | UserIDType (string) | Always |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized. For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.UserIDChanged | boolean | Always |
If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser). Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.UserIDLastChanged | dateTime | Always |
Date and time the user's data was last changed (in GMT). Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. |
| Seller.VATStatus | VATStatusCodeType | Always |
Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).
Applicable values: • CustomCode (out) Reserved for internal or future use • NoVATTax (out) VAT is not applicable • VATExempt (out) Residence in a country with VAT and user is registered as VAT-exempt • VATTax (out) Residence in a country with VAT and user is not registered as VAT-exempt DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. GranularityLevel: Fine. See VAT-exempt Sellers. |
| Input Output Samples Change History Top Errors for GetSellerList |
The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)
The none column indicates the fields that are returned when you do not specify a DetailLevel.
Please avoid using a DetailLevel of ReturnAll with GetSellerList when possible.
Many item details, such as item descriptions and listing enhancements, are unlikely to change. After an initial request for detailed information about items, subsequent requests can omit the DetailLevel field and thus obtain only the information about items that is likely to change. (Alternatively, consider using GetSellerEvents instead of GetSellerList.) If you need to use ReturnAll to retrieve all details for a set of items, please use a smaller EntriesPerPage value to limit the number of items returned per call. Also, use a shorter time range in EndTimeFrom and EndTimeTo for better performance.
| Y | The field is always returned. |
| (Y) | The field is conditionally returned. See the field description for clarification of conditions. |
| - | The field is not returned. |
The GranularityLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of GranularityLevel.)
The none column indicates the fields that are returned when you do not specify a GranularityLevel.
| Y | The field is always returned. |
| (Y) | The field is conditionally returned. See the field description for clarification of conditions. |
| - | The field is not returned. |
| Input Output Detail Controls Change History Top Errors for GetSellerList |
An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetSellerList.
| Input Output Detail Controls Samples Top Errors for GetSellerList |
| Version | Description |
|---|---|
| 635 2009-09-16 |
|
| 629 2009-08-05 |
|
| 619 2009-05-27 |
|
| 605 2009-02-18 |
|
| 603 2009-02-04 |
|
| 599 2009-1-07 |
|
| 581 2008-09-03 |
|
| 573 2008-07-09 |
|
| 567 2008-05-28 |
|
| 563 2008-04-30 |
|
| 561 2008-04-16 |
|
| 559 2008-04-02 |
|
| 557 2008-03-19 |
|
| 555 2008-03-05 |
|
| 553 2008-02-20 |
|
| 551 2008-02-06 |
|
| 537 2007-10-31 |
|
| 507 2007-04-04 |
|
| 503 2007-03-07 |
|
| 499 2007-02-07 |
|
| 497 2007-01-24 |
|
| 491 2006-12-13 |
|
| 489 2006-11-29 |
|
| 483 2006-10-18 |
|
| 477 2006-09-06 |
|
| 471 2006-7-26 |
|
| 469 2006-7-12 |
|
| 465 2006-06-14 |
|
| 463 2006-5-31 |
|
| 459 2006-05-03 |
|
| 455 2006-5-5 |
|
| 453 2006-3-22 |
|
| 439 2005-12-14 |
|
| 427 2005-09-21 |
|
| 425 2005-9-7 |
|
| 419 2005-7-27 |
|
| 415 2005-5-29 |
|
| 411 2005-6-1 |
|
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.