Base type definition of the request payload, which can carry any type
of payload content plus optional versioning information and detail level requirements.
All concrete request types are derived from the abstract request type.
The naming convention we use for the concrete type names is the name of the service
(the verb or call name) followed by "RequestType": VerbNameRequestType
If you pass a value in MessageID in a request,
we'll return the same value in CorrelationID in the response.
If you're making a lot of calls, you can use this for tracking that a
response is returned for every request and to match
particular responses to particular requests. (In this case, specify
a different value for each request.) You can specify any value
that is useful to you.
No
Base type definition of a response payload that can carry any
type of payload content with following optional elements:<br>
- timestamp of response message<br>
- application-level acknowledgement<br>
- application-level (business-level) errors and warnings
This value represents the date and time when eBay processed the
request. The time zone of this value is <a href="types/simpleTypes.html#dateTime">GMT</a>
and the format is the
ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ).
See the "dateTime" type for information about this
time format and converting to and from the GMT time zone.
Always
Indicates whether the call was successfully processed by eBay.
Always
PartialFailure
A list of application-level errors or warnings (if any) that were raised
when eBay processed the request. <br>
<br>
Application-level errors occur due to
problems with business-level data on the client side or on the eBay
server side. For example, an error would occur if the request contains
an invalid combination of fields, or it is missing a required field,
or the value of the field is not recognized. An error could also occur
if eBay encountered a problem in our internal business logic while
processing the request.<br>
<br>
Only returned if there were warnings or errors.
Conditionally
This refers to the particular 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.
Always
The release version that eBay used to process the request.
<br>
<br>
<span class="tablenote"><b>Note:</b>
This is usually the latest release version, as specified in the
release notes. (eBay releases the API to international sites
about a week after we release it to the US site.) </span><br>
<br>
If a field in the response returns the token "CustomCode", it usually
means that the field is a code type (a token or enumeration),
and that in your request URL (or HTTP header) you specified a
version that is older than the version in which the token was added
to the call.
Always
Schema Versioning Strategy
http://developer.ebay.com/DevZone/XML/docs/HowTo/eBayWS/eBaySchemaVersioning.html
If you pass a value in MessageID 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. Only returned if MessageID was used.
Conditionally
AckCodeType - Type declaration to be used by other schema. This code identifies
the acknowledgement code types that eBay could use to communicate the status of
processing a (request) message to an application. This code would be used as part
of a response message that contains an application-level acknowledgement element.
(out) Request processing succeeded
(out) Request processing failed
(out) Request processing completed with warning information
being included in the response message
(out) Request processing completed with some failures.
See the Errors data to determine which portions of the request failed.
(out) Reserved for internal or future use.
Basic type for specifying monetary amounts. A double value (e.g.,
1.00 or 1.0) is meaningful as a monetary amount when accompanied by a
specification of the currency, in which case the value specifies
the amount in that currency. An AmountType expresses both the value
(a double) and the currency. Details such as prices, fees, costs,
and payments are specified as amount types.
Currency in which the monetary amount is specified.
See CurrencyCodeType for applicable values.
INR, CAD, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, GBP
GetShippingCosts
Conditionally
INR, CAD, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, GBP
GetSingleItem
Conditionally
INR, CAD, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, GBP
FindItems
Conditionally
INR, CAD, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, GBP
FindItemsAdvanced
Conditionally
IncludeSelector: Details
INR, CAD, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, GBP
FindItemsAdvanced
No
INR, CAD, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, GBP
GetItemStatus
Always
GetUserAlerts
GetPublicAlerts
No
Conditionally
CommentTypeCodeType - Type declaration to be used by other schema.
These are the possible codes to specify the types of feedback/comment.
Additional information about feedback is available in the online Help of the eBay site.
Positive feedback. Increases total feedback score.
Neutral feedback. No effect on total feedback score.
Negative feedback. Decreases total feedback score.
Withdrawn feedback. Removes the effect of the original
feedback on total feedback score. Comments from withdrawn feedback
are still visible.
Applies to the eBay Motors site only. Feedback is withdrawn based on
the decision of a third party.
Reserved for internal or future use.
Defines the standard 3-letter ISO 4217 currency code set.
However, only certain currency codes are currently valid for use on eBay.
The valid codes are documented below with the notation "(in/out)".
Other codes in this list are for future use.
The documentation below specifies English names for each currency.
Alternatively, use GeteBayDetails to retrieve the names programmatically.
A reference: http://www.xe.com/iso4217.htm
Indian Rupee.
Applicable to listings on the India site (site ID 203).
Canadian Dollar.
Applicable to listings on the Canada site (site ID 2)
(Items listed on the Canada site can also specify USD.)
Chinese Yuan Renminbi.
Hong Kong Dollar.
Applicable to listings on the Hong Kong site (site ID 201).
Australian Dollar.
Applicable to listings on the Australia site (site ID 15).
Swiss Franc.
Applicable to listings on the Switzerland site (site ID 193).
Malaysian Ringgit.
Applicable to listings on the Malaysia site (site ID 207).
Euro.
Applicable to listings on these site:
Austria (site 16), Belgium_French (site 23),
France (site 71), Germany (site 77), Italy (site 101), Belgium_Dutch (site 123),
Netherlands (site 146), Spain (site 186), Ireland (site 205).
Philippines Peso.
Applicable to listings on the Philippines site (site ID 211).
Poland, Zloty.
Applicable to listings on the Poland site (site ID 212).
US Dollar.
Applicable to listings on the US (site ID 0), eBayMotors (site 100), and Canada (site 2) sites.
Singapore Dollar.
Applicable to listings on the Singapore site (site 216).
Swedish Krona.
Applicable to listings on the Sweden site (site 218).
New Taiwan Dollar.
Pound Sterling.
Applicable to listings on the UK site (site ID 3).
Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
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.
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.
(out) Reserved for internal or future use.
A variable that contains specific information about the context of this error.
For example, if you pass in an attribute set ID that does not match
the specified category, the attribute set ID might be returned as an error parameter.
Use error parameters to flag fields that users need to correct.
Also use error parameters to distinguish between errors when multiple
errors are returned.
The value of the variable.
Conditionally
The index of the parameter in the error.
Conditionally
These are request errors (as opposed to system errors) that occur due to problems
with business-level data (e.g., an invalid combination of arguments) that
the application passed in.
A brief description of the condition that raised the error.
Conditionally
Errors by Number
Errors/ErrorMessages.html
A more detailed description of the condition that raised the error.
Conditionally
Errors by Number
Errors/ErrorMessages.html
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.
Conditionally
Errors by Number
Errors/ErrorMessages.html
This field is not currently in use for eBay Shopping Web Services.
Indicates whether the error message text is intended to be displayed to
an end user or intended only to be parsed by the application.
If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for
the application, and the application should translate the error into a more appropriate message.
Indicates whether the error caused the request to fail.<br>
<br>
If the request fails and the source of the problem is within the
application (such as a missing required element), please change the
application before you retry the request. If the problem is due to
end-user input data, please alert the end-user to the problem and
provide the means for them to correct the data. Once the problem in the
application or data is resolved, you can attempt to re-send the request
to eBay.<br>
<br>
If the source of the problem is on eBay's side, you 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.<br>
<br>
When a warning occurs, the error is returned in addition to the business
data. In this case, you do not need to retry the request (as the
original request was successful). However, depending on the cause or
nature of the warning, you might need to contact either the end user or
eBay to effect a long term solution to the problem to prevent it from
reoccurring in the future.
Conditionally
Errors by Number
Errors/ErrorMessages.html
Checklist for Going Live
http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ErrorHandlingGuidelines
more information (in the eBay Trading Web Services guide)
Some warning and error messages return one or more variables that
contain contextual information about the error. This is often the
field or value that triggered the error.
You can usually predict where these will
occur by looking at the "replaceable_value" indicators in our
Errors by Number page.
Conditionally
Errors by Number
Errors/ErrorMessages.html
API errors are divided between two classes: system errors and request errors.
Conditionally
Errors by Number
Errors/ErrorMessages.html
FeedbackRatingStarCodeType - Type declaration to be used by other
schema. The color of a feedback score star visually denotes the
range in which the member's summary feedback score falls. The score
is the net positive feedback minus the net negative feedback left
for the member.
No graphic displayed, feedback score 0-9.
Yellow Star, feedback score 10-49.
Blue Star, feedback score 50-99.
Turquoise Star, feedback score 100-499.
Purple Star, feedback score 500-999.
Red Star, feedback score 1,000-4,999
Green Star, feedback score 5,000-9,999.
Yellow Shooting Star, feedback score 10,000-24,999.
Turquoise Shooting Star, feedback score 25,000-49,999.
Purple Shooting Star, feedback score 50,000-99,999.
Red Shooting Star, feedback score 100,000-499,999.
Green Shooting Star, feedback score 500,000-900,000.
Silver Shooting Star, feedback score 1,000,000 and above.
Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
Type of seller account. This value can be returned if the German site (site ID
77) or eBay Motors site (site ID 100) is specified.
Type of seller account not defined.
Private seller account.
Commercial seller account.
(out) Reserved for internal or future use.
SellerLevelCodeType - Type declaration to be used by other schema.
Indicates the user's eBay PowerSeller tier.
(out) Bronze
(out) Silver
(out) Gold
(out) Platinum
(out) Titanium
(out) Diamond
(out) None
(out) Reserved for internal or future use
SeverityCodeType - Type declaration to be used by other schema. This code
identifies the severity of an API error. A code indicates whether there is an API-
level error or warning that needs to be communicated to the client.
(out) The request was processed successfully, but something occurred
that may affect your application or the user. For example, eBay may have
changed a value the user sent in. In this case, eBay returns a normal,
successful response and also returns the warning.
(out) The request that triggered the error was not processed
successfully. When a serious application-level error occurs, the error
is returned instead of the business data.
(out) Reserved for internal or future use
Type to contain the data for one eBay user. Depending on the context, the user
might be the seller or the buyer in a transaction, or the bidder or winning bidder
in a listing. An object of this type is returned by a number of calls, including
the GetUser call.
The user's unique eBay user ID.
<br />
<br />
When reporting UserIDs in bidding situations (such was when listing
the high bidder in an auction), eBay replaces the UserID value with
an anonymous bidder name value, such as "a***o".
GetMultipleItems
GetSingleItem
Seller
Always
IncludeSelector: Details
GetMultipleItems
GetSingleItem
GetItemStatus
HighBidder
Conditionally
IncludeSelector: Details
GetUserProfile
IncludeSelector: none
Always
FindItemsAdvanced
Always
IncludeSelector: SellerInfo
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. If a bidder's user information is made
anonymous, the value -99 is returned.
GetMultipleItems
GetSingleItem
GetItemStatus
HighBidder
Conditionally
IncludeSelector: Details
FindItemsAdvanced
Always
IncludeSelector: SellerInfo
GetUserProfile
Always
IncludeSelector: none
Visual indicator of user's feedback score.
GetMultipleItems
GetSingleItem
Seller
Always
IncludeSelector: Details
GetMultipleItems
GetSingleItem
GetItemStatus
HighBidder
Conditionally
IncludeSelector: Details
GetUserProfile
Always
IncludeSelector: none
FindItemsAdvanced
Always
IncludeSelector: SellerInfo
The aggregate feedback score of a user. A user's feedback score is the net
positive feedback minus the net negative feedback left for the user.
<br>
<br>
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 aggregate feedback score of a user represents 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, then FeedbackScore
is not returned and FeedbackPrivate is returned with a value of true.
<br>
<br>
If a bidder's user information is made anonymous, the value -99 is returned.
GetMultipleItems
GetSingleItem
Seller
Always
IncludeSelector: Details
GetMultipleItems
GetSingleItem
GetItemStatus
HighBidder
Conditionally
IncludeSelector: Details
GetUserProfile
IncludeSelector: none
Always
FindHalfProducts
Conditionally
IncludeSelector: Items
FindItemsAdvanced
Always
IncludeSelector: SellerInfo
Indicates whether eBay has made this user's information anonymous.
This occurs when the listing prices (reserve, current, or Buy It Now)
reach or exceed a certain amount (such as $200 USD at the time of this
writing).
<br>
<br>
If true, certain other fields about this user are not returned, or their values
include no identifying characteristics. (The rules are explained in the
description of each field.) If false, all user-specific fields contain the user's
actual data.
GetSingleItem
GetMultipleItems
Conditionally
HighBidder
IncludeSelector: Details
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.
GetUserProfile
IncludeSelector: none
Always
The date the specified user originally registered with eBay. If a bidder's user
information is made anonymous, the value -99 is returned.
GetUserProfile
IncludeSelector: none
Always
The eBay site with which the user is registered. If a bidder's user information is
made anonymous, the value -99 is returned.
GetUserProfile
IncludeSelector: none
Always
The registration-related status of the user.
GetUserProfile
IncludeSelector: none
Always
Type of seller account.
GetUserProfile
IncludeSelector: none
Always
The URL of the seller's eBay Store page.
GetUserProfile
IncludeSelector: Details
Conditionally
The name of the seller's eBay Store.
GetUserProfile
IncludeSelector: Details
Conditionally
URL for seller's other items.
GetUserProfile
IncludeSelector: none
Always
A link to the user's AboutMe page.
GetUserProfile
IncludeSelector: none
Always
A link to the URL of the user's MyWorld page.
GetUserProfile
IncludeSelector: Details
Conditionally
Location of a user's image on the MyWorld page (small version).
GetUserProfile
IncludeSelector: Details
Conditionally
Location of a user's image on the MyWorld page (large version).
GetUserProfile
IncludeSelector: Details
Conditionally
The URL of reviews and guides.
GetUserProfile
IncludeSelector: Details
Conditionally
The URL of feedback details.
GetUserProfile
IncludeSelector: none
Always
A seller's positive feedback score. The percentage value of a seller's
positive feedback is calculated by dividing the seller's positive feedback
score by their negative feedback score. The last 12 months of feedback
scores are taken into consideration for this calculation.
GetMultipleItems
GetSingleItem
Seller
Always
IncludeSelector: Details
FindItemsAdvanced
Always
IncludeSelector: SellerInfo
FindHalfProducts
Conditionally
IncludeSelector: Items
The user's eBay PowerSeller tier. No longer returned for the US, DE/AT/CH, and
UK/IE sites. Note that SellerLevel may be suppressed for other sites, as well.
GetUserProfile
Conditionally
IncludeSelector: none
Returned when 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.
GetUserProfile
Conditionally
IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory
ComingSoon
GetMultipleItems
GetSingleItem
Seller
Conditionally
IncludeSelector: Details
eBay sites (by the country in which each resides) on
which a user is registered and on which items can be listed.
USA, site ID 0, abbreviation US, currency USD.
Canada, site ID 2, abbreviation CA, currencies CAD and USD.
United Kingdom, site ID 3, abbreviation UK, currency GBP.
Australia, site ID 15, abbreviation AU, currency AUD.
Austria, site ID 16, abbreviation AT, currency EUR.
Belgium (French), site ID 23, abbreviation BEFR, currency EUR.
France, site ID 71, abbreviation FR, currency EUR.
Germany, site ID 77, abbreviation DE, currency EUR.
Italy, site ID 101, abbreviation IT, currency EUR.
Belgium (Dutch), site ID 123, abbreviation BENL, currency EUR.
Netherlands, site ID 146, abbreviation NL, currency EUR.
Spain, site ID 186, abbreviation ES, currency EUR.
Switzerland, site ID 193, abbreviation CH, currency CHF.
Taiwan, site ID 196, abbreviation TW, currency TWD.
eBay Motors, site ID 100, currency USD.
Hong Kong, site ID 201, abbreviation HK, currency HKD.
Singapore, site ID 216, abbreviation SG, currency SGD.
India, site ID 203, abbreviation IN, currency INR.
China, site ID 223, abbreviation CN, currency CNY.
Ireland, site ID 205, abbreviation IE, currency EUR.
Malaysia, site ID 207, abbreviation MY, currency MYR.
Philippines, site ID 211, abbreviation PH, currency PHP.
Poland, site ID 212, abbreviation PL, currency PLN.
Sweden, site ID 218, abbreviation SE, currency SEK.
Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
CanadaFrench, site ID 210, abbreviation CAFR, currencies CAD and USD.
Indicates the order of sorting.
Sorts results in ascending (low to high) order.
Sorts results in descending (high to low) order.
Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
A means for identifying a person's role in doing business on eBay.
Acting as buyer.
Acting as seller.
Reserved for future use
These codes indicate the current state or status of a an eBay
user account.
(out) User properties have never been set; this value should
seldom, if ever, be returned and typically represents a
problem
(out) User has been suspended from selling and buying, such as
for violations of eBay terms or agreement
(out) User has completed online registration and has properly
responded to confirmation email; most users should fall
in this category
(out) User has completed online registration, but has either
not responded to confirmation email or has not yet been
sent the confirmation email
(out) Registered users of AuctionWeb (pre-eBay) who never
re-registered on eBay
(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
(out) Records for the specified user have been deleted
(out) User has completed registration and confirmation, but is
pending a verification of credit card information
(out) User's account is on hold, such as for non-payment of
amounts due eBay; user cannot sell or buy items
(out) User record has been merged with another account record
for the same user
(out) User has completed online registration and has been sent
the confirmation email, but has not yet responded to the
confirmation email
(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
(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
(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
(out) Half.com User; user has completed the registration for Half.com
and opted to automatically also be registered with eBay, but the
registration confirmation is still pending
(out) Reserved for internal or future use
Contains the data for one user address. This is the base type for a
number of user addresses, including seller payment address, buyer
shipping address and buyer and seller registration address.
User's name for the address.
Also applicable to Half.com (for GetOrders).
64
GetItem
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetUserContactDetails
Always
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
A concatenation of Street1 and Street2, primarily for RegistrationAddress.
Not applicable to Half.com.
GetBidderList
Conditionally
ShippingAddress
GetItem
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
AddItem
RelistItem
ReviseItem
VerifyAddItem
No
Line 1 of the user's street address.
Also applicable to Half.com (for GetOrders).
100
GetBidderList
Conditionally
ShippingAddress
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
GetItem
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItem
SellerContactDetails
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Line 2 of the user's address (such as an apartment number).
Returned if the user specified a second street value for their address.
Also applicable to Half.com (for GetOrders).<br>
In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable).
100
GetBidderList
Conditionally
ShippingAddress
GetItem
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
AddItem
RelistItem
ReviseItem
VerifyAddItem
No
The name of the user's city.
Also applicable to Half.com (for GetOrders).
64
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
GetBidderList
Conditionally
ShippingAddress
GetItem
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
GetUserContactDetails
Always
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
County information for the user.
This field applies to Classified Ad format listings and to the UK only.
Not applicable to Half.com.
AddItem
RelistItem
ReviseItem
VerifyAddItem
No
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
The region of the user's address.
Also applicable to Half.com (for GetOrders).
64
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
GetBidderList
Conditionally
ShippingAddress
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
ShippingAddress
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetUserContactDetails
Always
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
The name of the user's country.
Also applicable to Half.com (for GetOrders).
GetBidderList
Conditionally
ShippingAddress
GetItem
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
User's primary phone number. This may return a value of
"Invalid Request" if you are not authorized to see the
user's phone number.
Also applicable to Half.com (for GetOrders).
GetItem
RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress
Conditionally
GetBidderList
ShippingAddress
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetUserContactDetails
Always
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Country Prefix of the secondary phone number. This value is derived from
inputs supplied for PhoneCountryCode.
This field applies to Classified Ad format listings only.
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
Area or City Code of a user's primary phone number.
This field applies to Classified Ad format listings only.
AddItem
RelistItem
ReviseItem
VerifyAddItem
No
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
The local number portion of the user's primary phone number.
This field applies to Classified Ad format listings only.
<br>
<b>Note:</b> The full primary phone number is constructed by
combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix.
Starting with API release 497, the full phone number can be entered in
PhoneLocalNumber. Refer to the release notes for additional information.
30
AddItem
RelistItem
ReviseItem
VerifyAddItem
No
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
Country prefix of a user's secondary phone number. This value is derived from
inputs supplied for Phone2CountryCode.
This field applies to Classified Ad format listings only.
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
Area or City Code of a user's secondary phone number.
This field applies to Classified Ad format listings only.
AddItem
RelistItem
ReviseItem
VerifyAddItem
No
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
The local number portion of the user's secondary phone number.
This field applies to Classified Ad format listings only.
<br>
<b>Note:</b> The full secondary phone number is constructed by
combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix.
Starting with API release 497, the full phone number can be entered in
Phone2LocalNumber. Refer to the release notes for additional information.
30
AddItem
RelistItem
ReviseItem
VerifyAddItem
No
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
User's postal code.
<br>
<br>
If not provided as input for GetCart or SetCart, eBay uses the country associated
with the SiteID in effect when the call is made.
<br>
<br>
Also applicable to Half.com (for GetOrders).
12
GetBidderList
Conditionally
GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally
GetSellerList
HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally
GetItem
RegistrationAddress
ShippingAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
ShippingAddress
DetailLevel: none, ReturnAll
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetMyeBaySelling
SoldList
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally
GetAllBidders
GetHighBidders
Always
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
ID assigned to the address in the eBay database.
For GetOrders, applies only to Half.com.
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
ID assigned to the address by the owner of the address (fitting
only if the address is owned by PayPal; see AddressOwner).
Also applicable to Half.com (for GetOrders).
20
GetOrders
DetailLevel: none
Always
GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally
GetItemTransactions
GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally
Seller's international name that is associated with the payment address.
Only applicable to SellerPaymentAddress.
Not applicable to Half.com.
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetBidderList
Conditionally
ShippingAddress
International state and city for the seller's payment address.
Only applicable to SellerPaymentAddress.
Not applicable to Half.com.
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetBidderList
Conditionally
ShippingAddress
Seller's international street address that is associated with the payment address.
Only applicable to SellerPaymentAddress.
Not applicable to Half.com.
GetUser
Conditionally
SellerPaymentAddress
DetailLevel: ReturnAll
GetBidderList
Conditionally
ShippingAddress
User's company name. Only returned if available.
Not applicable to Half.com.
GetUserContactDetails
Always
GetBidderList
Conditionally
ShippingAddress
AddItem
RelistItem
ReviseItem
VerifyAddItem
No
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails
Conditionally
GetUser
Conditionally
RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the first name of the seller (in a business
card format) if the seller's SellerBusinessCodeType
is set to 'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the last name of the seller (in a business
card format) if the seller's SellerBusinessCodeType
is set to 'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Applicable to sites that support the Detailed Seller Ratings feature.
The AverageRatingDetailsType contains the average detailed seller ratings in an area. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers.
The area of a specific average detailed seller rating.
Users retrieve detailed ratings as averages of the ratings left by buyers.
When buyers leave an overall Feedback rating (positive, neutral, or negative)
for a seller, they also can leave ratings in four areas:
item as described, communication, shipping time, and charges for shipping and handling.
GetUserProfile
IncludeSelector: FeedbackHistory
Conditionally
An average detailed seller rating applying to the area in the corresponding RatingDetail field.
GetUserProfile
IncludeSelector: FeedbackHistory
Conditionally
The number of detailed seller ratings in the area
in the corresponding RatingDetail field.
GetUserProfile
IncludeSelector: FeedbackHistory
Conditionally
Displays the seller's information (in a business card format)
as part of the data returned in the GetSingleItem call if the
seller's SellerBusinessCodeType is set to 'Commercial'. Note
that this option is only available for sites that have
Business Seller options enabled.
Displays the Address of the seller (in a business card
format) as part of the data returned in the
GetSingleItem call if the seller's SellerBusinessCodeType
is set to 'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the fax number of the seller (in a business card
format) as part of the data returned in the
GetSingleItem call if the seller's SellerBusinessCodeType
is set to 'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the email address of the seller (in a business
card format) as part of the data returned in the
GetSingleItem call if the seller's
SellerBusinessCodeType is set to 'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the AdditionalContactInformation of the seller
(in a business card format) as part of the data returned
in the GetSingleItem call if the seller's
SellerBusinessCodeType is set to 'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the TradeRegistrationNumber of the seller (in a
business card format) as part of the data returned in the
GetSingleItem call if the seller's SellerBusinessCodeType
is set to 'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the LegalInvoice of the seller (in a business card
format) as part of the data returned in the GetSingleItem
call if the seller's SellerBusinessCodeType is set to
'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the TermsAndConditions of the seller (in a business card
format) as part of the data returned in the GetSingleItem call
if the seller's SellerBusinessCodeType is set to 'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the VATDetails of the seller (in a business card
format) as part of the data returned in the GetSingleItem
call if the seller's SellerBusinessCodeType is set to
'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Identifies payment methods used by a buyer to pay a
seller. On item listings, identifies one of the payment methods
seller will accept for the item. Available payment methods can
differ by site and item. Payment methods are not applicable to eBay
Real Estate ad format listings.
Escrow, PrePayDelivery, CODPrePayDelivery, PostalTransfer
No payment method specified.
For example, no payment methods would be specified for Ad format listings.
Money order/cashiers check.
Not applicable to US/CA eBay Motors listings.
American Express.
Not applicable to US/CA eBay Motors listings.
Payment instructions are contained in the item's description.
Credit card.
Not applicable to Real Estate or US/CA eBay Motors listings.
Personal check.
Cash on delivery.
Only applicable to the following eBay sites: AT (16), BEFR (24),
BENL (123), CH (193), DE (77), ES (186), FR (71), HK (201), IN (203),
IT (101), PL (212), and SG (216).
Not applicable to Real Estate listings.
Visa/Mastercard. These qualify as safe payment methods.
Not applicable to US/CA eBay Motors listings.
PaisaPay (for India site only). This qualifies as a safe payment method.
Other forms of payment.
Not applicable to US/CA eBay Motors listings
(see PaymentSeeDescription instead).
PayPal is accepted as a payment method. This qualifies as a safe payment method. <br>
<br>
If PayPal is specified for US/CA eBay Motors vehicles, it is for
the vehicle deposit (not for purchasing the vehicle).
Discover card.
Not applicable to US/CA eBay Motors listings.
This payment method is equivalent to the PayOnPickup payment method.
CashOnPickup applies even for listings on the eBay US site that refer to "Pay on pickup."
Direct transfer of money.
Not applicable to US/CA eBay Motors listings.
If the seller has bank account information on file, and
MoneyXferAcceptedInCheckout = true, then the bank account
information will be displayed in Checkout.
All other online payments.
Not applicable to US/CA eBay Motors listings.
Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
Loan check option (applicable only to the US eBay Motors site,
except in the Parts and Accessories category, and the eBay Canada site for motors).
Cash-in-person option. Applicable only to US and Canada eBay Motors vehicles,
(not the Parts and Accessories category).
Elektronisches Lastschriftverfahren (direct debit).
Only applicable to Express Germany.
PaisaPayEscrow EMI (Equal Monthly Installment) payment method.
The PaisaPayEscrowEMI payment method is only for the India site (site ID 203).
The Moneybookers payment method.
For more information, see http://www.moneybookers.com/partners/us/ebay.
Only applicable to the US site (and
to the Parts and Accessories category of the US eBay Motors site).
The Paymate payment method. For more information,
see http://www.paymate.com/eBay.
Only applicable to the US site (and
to the Parts and Accessories category of the US eBay Motors site).
The ProPay payment method. US site only. For more information,
see http://www.Propay.com/eBay.
For all payment intermediated transactions, If the authenticated caller is a seller then Standard Payment Method is returned to as Payment Method Used to sellers.
OrderArray.Order.CheckoutStatus.PaymentMethod (GetOrders, GetOrderTransaction) and OrderArray.Order
.TransactionArray.Transaction.Status (For all the 4 APIs).
The COD (Cash on Demand) or POP (Pay on Pickup) should be shown as is to the buyers and sellers, these payment methods are not intermediated.
Information about zero or more buying guides and the site's buying guide hub.
Buying guides contain content about particular product areas, categories, or subjects
to help buyers decide which type of item to purchase based on their particular interests.
Multiple buying guides can be returned. See the eBay Web Services Guide for additional information.
Information that identifies a buying guide. A buying guide contains content about particular
product areas, categories, or subjects to help buyers decide which type of item
to purchase based on their particular interests.
Buying guides are useful to buyers who do not have a specific product in mind.
For example, a digital camera buying guide could help a buyer determine what kind of
digital camera is right for them.
FindReviewsAndGuides
Conditionally
URL of the buying guide home page for the site being searched.
Your application can present this URL as a link. Optionally,
you can use a value like "See all buying guides" as the link's
display name.
FindReviewsAndGuides
Always
Information that identifies a buying guide. A buying guide provides content about particular
product areas, categories, or subjects to help buyers decide which type of item
to purchase based on their particular interests.
Buying guides are useful to buyers who do not have a specific product in mind.
For example, a digital camera buying guide could help a buyer determine what kind of
digital camera is right for them.
Display name of the buying guide. <br>
<br>
FindReviewsAndGuides only returns 20 characters, followed by "..." if the name is
longer than 20 characters. For the full title, see BuyingGuide.Title
instead.
FindReviewsAndGuides
Conditionally
URL for the buying guide. Your application can
present this as a link. Use the value of Name or Title as the link's display name.
FindReviewsAndGuides
Conditionally
Identifies the category (if any) that is associated
with the buying guide. For FindReviewsAndGuides, this can be a category that is higher or lower in the hierarchy
than the category specified in the request. For a matching categories search,
you can use this information to determine the order that the buying guides are
returned in when multiple guides are found.
Optionally, you can use this information to determine where to present
the buying guide link in your application.
10
FindReviewsAndGuides
Conditionally
The title of the buying guide.
55
FindReviewsAndGuides
Conditionally
The text of the guide. If the guide is longer than
2000 characters, the text is cut off and it ends with "...".
See BuyingGuide.URL for a link to the full text of the review.
2000
FindReviewsAndGuides
Conditionally
The time and date when the guide was posted.
FindReviewsAndGuides
Conditionally
The author's eBay user ID.
FindReviewsAndGuides
Conditionally
Information about an eBay catalog product.
The name of the domain in which the product was found.
If the product is mapped to multiple domains, eBay returns
the most applicable domain (as determined by eBay).
Always returned when Product is returned.
FindProducts
Always
IncludeSelector: none
Fully qualified URL for optional information about the product,
such as a movie's description or film credits. This information
is hosted through the eBay Web site and it cannot be edited.
Portions of the content are protected by copyright.
Applications can include this URL as a link in product search results
so that end users can view additional descriptive details about
the product. This is usually always returned when Product is returned,
but it may be safest to check for the existence of this field.
FindProducts
Always
IncludeSelector: none
If true, your application can attempt to display stock photos that
are returned. If false, your application should not attempt to display
any stock photos that are returned. This recommendation is useful for
catalog data related to products like coins, where stock photos are not
necessarily applicable or available. An application with a graphical
user interface can use this flag to determine
when to hide customized stock photo widgets.
Always returned when Product is returned.
FindProducts
Always
IncludeSelector: none
The eBay or external IDs associated with the product. Use the Reference
value as input to search for the same product in the future, or
use the ISBN, EAN, or UPC value (if returned).
The ISBN, EAN, and UPC values can also be useful as keys
if your application is comparing products across different sites.
Always returned when Product is returned.
FindProducts
Always
IncludeSelector: none
Total number of listings on the requested eBay site that use
stock information from this catalog product. This value can be greater
than the number of listings returned in ItemArray. To retrieve more
listings, use the <a href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html">Finding API</a>.
Only returned when you search by ProductID (and you pass
Items or Details in IncludeSelector).
0
FindProducts
Conditionally
IncludeSelector: Items, Details
A list of name/value pairs that are included in the product's
pre-filled Item Specifics. These indicate common aspects or
characteristics of the product, such as Publisher (for a book).
Also see ProductID for ISBN, UPC, or EAN values, if applicable.
This is usually returned. (We are not aware of any cases in which this
node is not be returned. However, it may be safest to check for the
existence of this node.)
FindProducts
Always
IncludeSelector: none
The total number of reviews that are available for this product
on the eBay Web site. This can be greater than the number of
reviews returned by FindProducts. In a future release, we will provide
the capability to retrieve details about reviews.
Always returned when Product is returned.
FindProducts
Always
IncludeSelector: none
0
Fully qualified URL for a stock image (if any) that is associated
with the eBay catalog product. The URL is for the image eBay
usually displays in product search results (usually 70px tall).
It may be helpful to calculate the dimensions of the photo
programmatically before displaying it.
Only returned if a URL is available for the product.
FindProducts
Conditionally
IncludeSelector: none
The title of the product, as specified in the catalog.
Always returned when Product is returned.
FindProducts
Always
IncludeSelector: none
Indicates that the product has changed or will soon change (usually due to a
migration from one catalog to another catalog). Typically, this field is returned
for up to 90 days for a given product. After that, the product either no longer
returns this field or the product is no longer returned (depending on the state
change). As of mid-2008, this data is primarily applicable to catalogs used by the
US, Germany, Austria, and Switzerland sites. Other sites may undergo catalog
changes in the future.
FindProducts
Conditionally
IncludeSelector: none
Container for a list of categories.
Contains details about a category.
GetCategoryInfo
IncludeSelector: none, ChildCategories
Always
Contains details about a category.
The numeric ID of a category on eBay.
<br>
<br>
Use an ID of -1 to retrieve the root category and the top-level (level 1) meta
categories. You can determine other CategoryIDs from the response from this
call, or from a specific item (retrieved from another call like
GetSingleItem), or from the eBay website.
GetCategoryInfo
IncludeSelector: none, ChildCategories
Always
The level where the category fits in the site's category hierarchy.
For example, if this field has a value of 2, then the category is 2
levels below the root category.
<br>
<br>
Note that the value of CategoryLevel will always be 1 level below the level
of the requested category. To retrieve a category's children, pass its
CategoryID back into the request.
<br>
GetCategoryInfo
IncludeSelector: none, ChildCategories
Always
Display name of the category as it would appear on
the eBay Web site.
GetCategoryInfo
IncludeSelector: none, ChildCategories
Always
Category ID identifying a category that is an ancestor of
the category indicated in CategoryID.
GetCategoryInfo
IncludeSelector: none, ChildCategories
Always
Display name of the category indicated in CategoryParentID.
The total quantity of matching items in the category.
In the FindItemsAdvanced response, matching categories at the same level
(i.e., sibling categories) are sorted by ItemCount. That is, if the request
specifies that fewer categories or subcategories should be returned,
the ones with the most matching items are returned first.
The fully qualified category display name as it would appear on the
eBay site (e.g., Home & Garden:Kitchen:Tools & Gadgets).
GetCategoryInfo
IncludeSelector: none, ChildCategories
Always
The fully qualified category ID (e.g., 11700:20625:20635 for Home &
Garden:Kitchen:Tools & Gadgets).
GetCategoryInfo
IncludeSelector: none, ChildCategories
Always
If true, indicates that the category indicated in CategoryID is a leaf
category, in which items may be listed (if the category is not also
expired or virtual).
GetCategoryInfo
IncludeSelector: none, ChildCategories
Always
CharityStatusCodeType - Type declaration to be used by other schema.
Indicates the nonprofit status of the nonprofit charity organization registered with the dedicated eBay Giving Works provider.
(out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider.
(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.
(out) Reserved for internal or future use.
Identifies a Giving Works listing and benefiting nonprofit charity organization.
Currently supported through the US and eBay Motors sites only. The Ad Format and
Mature Audiences categories are not supported.
Not applicable for US eBay Motors, international, Real Estate, and Tickets.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
A unique identification number assigned by eBay to
registered nonprofit charity organizations.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
The name of the benefiting nonprofit charity organization selected by the
charity seller.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
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.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
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.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
The stated mission of the nonprofit charity
organization. This mission is displayed in the Giving Works
item listing.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
The URL of the nonprofit charity organization. This
URL is displayed in the Giving Works item listing.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
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.
The status of the nonprofit charity organization.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Defines the standard 2-letter ISO 3166 country code set, plus
some additional country codes that eBay uses.
(The additional codes appear at the end of this code list and
are noted as non-ISO.)
For English names that correspond to each code (e.g., KY="Cayman Islands"),
see the ISO site:
http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html
QP
French Polynesia. Includes Tahiti.
NOTE: APO/FPO was defined in eBay list previously
but they are not defined in ISO 3166. This country
will remain on eBay country code list for backward
compatibility.
NOTE: Guernsey was defined in eBay list previously
but they are not defined in ISO 3166. This country
will remain on eBay country list for backward
compatibility.
NOTE: Jan Mayen was defined in eBay list previously
but they are not defined in ISO 3166. This country
will remain on eBay country list for backward
compatibility.
NOTE: Jersey was defined in eBay list previously
but they are not defined in ISO 3166. This country
will remain on eBay country list for backward
compatibility.
Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
Contains the discount pricing details for an item, including the original
retail price and the display treatment to be used for the item. The pricing
treatment displayed for a discounted item depends on the values specified
in this container when the item is listed. Discount pricing treatments
(Strikethrough Pricing and Minimum Advertised Price) apply to only fixed
price, BIN items. Sellers can apply Discount Pricing to both MSKU and
Non-MSKU items.
This field specifies the price to which the discounted-price display
treatment will be applied (for example, a strikethrough price). The
discounted price of an item (specified in the CurrentPrice field) is
the BIN price and is less than the OriginalRetailPrice of the item.
<br /><br />
See <a href=
"http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DiscountPricing">
Displaying Discount Pricing Information to Buyers</a> for
guidelines on displaying STP and MAP items.
GetSingleItem
GetMultipleItems
FindPopularItems
Conditionally
A value equal to the agreed upon minimum advertised price.
<br><br>
The minimum advertised price is an agreed upon price that is set by the
suppliers/OEMs and the retailers/sellers. The minimum advertised price
is the lowest price for which an item can be advertised. Large volume
sellers can negotiate with the suppliers/OEMs to offer certain items
below the set minimum advertised price. eBay does not maintain or
validate the agreed upon minimum advertised price; the seller is
responsible for setting this value in accordance with their agreement
with the supplier/OEMs. MAP pricing treatments apply to only fixed price,
BIN items listed on the eBay US site.
GetSingleItem
GetMultipleItems
FindPopularItems
Conditionally
If an item listing qualifies it to be listed as a MAP item
(PricingTreatment returns MAP), the item price cannot be directly
displayed on the page containing the item. When listing a MAP item,
the seller stipulates how they want the buyer to view the price of the
item by setting this field to either PreCheckout or DuringCheckout. If
this feild is not set for a MAP item, the treatment defaults to PreCheckout.
<br /><br />
If this field is set to PreCheckout, the buyer must click a link (or
button) to view the item price on a different page (such as in a pop-up
window). If this field is set to DuringCheckout, the StartPrice must be
shown only when the buyer in the eBay checkout flow.
<br /><br />
MAP items are supported only on the eBay US site.
GetSingleItem
GetMultipleItems
FindPopularItems
Conditionally
This field denotes whether or not an item qualifies for a discount
pricing treatment display. If a seller lists an item with
DiscountPriceInfo values, the item response container will include
a DiscountPriceInfo container with this field set to either
STP, MAP, or None. If this field is set to MAP, you must abide
by the rules for displaying MAP items, as described in
MinimumAdvertisedPriceExposure.
<br /> <br />
<span class="tablenote"><b>Important:</b>
For listings that return PricingTreatment set to MAP, you are
legally required to follow the rules for displaying the price of
the item to potential buyers. You are bound by the terms of the
API License Agreement to follow these rules. Refer to the
API License Agreement for consequences of non-compliance.
</span>
GetSingleItem
GetMultipleItems
FindPopularItems
Conditionally
Used by the eBay UK and eBay Germany (DE) sites, this field indicates
that the discount price (specified as CurrentPrice) is the price for
which the seller offered the same (or similar) item for sale on eBay
within the previous 30 days. The discount price is always in reference
to the seller's own price for the item.
<br /><br />
In the event both soldOffeBay and soldOneBay fields are set, soldOneBay
takes precedence.
GetSingleItem
GetMultipleItems
FindPopularItems
Conditionally
Used by the eBay UK and eBay Germany (DE) sites, this field indicates
that the discount price (specified as currentPrice) is the price for
which the seller offered the same item for sale on a web site or offline
store other than eBay in the previous 30 days. The discount price is
always in reference to the seller's own price for the item.
<br /><br />
In the event both soldOffeBay and soldOneBay fields are set, soldOneBay
takes precedence.
GetSingleItem
GetMultipleItems
FindPopularItems
Conditionally
Distance, used for a proximity search.
A generic type used for histograms.
Each histogram entry shows how many matching products
were found in each matching domain. A domain is like a high-level
category, or a group of categories whose items share the same basic
product characteristics.
FindHalfProducts
FindProducts
Always
IncludeSelector: DomainHistogram
Indicates the type of external product ID being used to identify a
stock product.
ExternalProductID.Value contains an ISBN value.
Required when you pass an ISBN as the external product ID.
(This value is also applicable to Half.com listings.)
ExternalProductID.Value contains a UPC value.
Required when you pass a UPC as the external product ID.
(This value is also applicable to Half.com listings.)
ExternalProductID.Value contains an eBay catalog product ID.
Required when you pass an eBay product ID
as the external product ID.
Not applicable with FindItemsAdvanced or FindProducts.
ExternalProductID.Value contains an EAN value.
Required when you pass an EAN as the external product ID.
ExternalProductID.Value contains a set of keywords that uniquely identify the product.
Only applicable when listing event ticket.
See the eBay Web Services guide for information about valid
ticket keywords for an external product ID.
Required when you pass a set of keywords as the external product ID.
Not applicable with FindItemsAdvanced or FindProducts.
With FindItemsAdvanced, use TicketFinder instead.
Reserved for future use.
Reserved for internal or future use
Contains an ISBN value, EAN value, UPC value, ticket keywords, or eBay
catalog product ID, plus other meta-data. For event tickets, this type
can contain a set of keywords that uniquely identify the product. Only
applicable to certain categories that support Pre-filled Item
Information.
An industry-standard value that uniquely identifies the product. The
valid values are dictated by the Type property.
Required if Type is specified.
Max length 13 for ISBN, 13 for EAN,
12 for UPC, and 4000 for ProductID. No max length for ticket keywords
(but passing too much data can result in "no match found"
errors).<br>
<br>
<b>For AddItem and related calls:</b>
If the primary and secondary categories are both catalog-enabled,
the value must apply to the primary category.
Event tickets listings support a set of keywords
that uniquely identify the listing. The ticket keywords specify the
event name (the title shown on the ticket), venue name, and event
date and time. See the eBay Web Services guide for more information
and validation rules. For convenience, you can pass an eBay product ID
as input (not limited to media categories).<br>
<br>
Required for Half.com listing use cases, and this can only be an
ISBN, UPC, or EAN value.<br>
<br>
<b>For FindProducts input only:</b>
Only ISBN, EAN, and UPC values are currently supported as
input.<br>
<br>
<b>For FindProducts and GetSellerPayments output only:</b>
Also see AlternateValue, which is returned if the catalog defines multiple
ISBN values (e.g., one for ISBN-13 and one for ISBN-10). Please note that
some catalogs return ISBN values that are not 10 or 13 characters, and some
values contain non-alphanumeric symbols (e.g., $).
See description
AddItem
GetItemRecommendations
VerifyAddItem
Item.ExternalProductID
Conditionally
FindProducts
Conditionally
Conditionally
GetSellerPayments
Conditionally
Applicable for listing use cases only (not buy-side searching).
Indicates what eBay should do if more than one product matches
the value passed in Value. Only takes effect when more than one
match is found. If true, the response should include an error
and all matching product IDs. If false, the response should include
an error but should not return the matching product IDs.
This field is also applicable when listing Half.com items.
AddItem
GetItemRecommendations
VerifyAddItem
No
Item.ExternalProductID
The kind of identifier being used. The choices listed are for requests, are
are required if Value is specified. For Half.com listing use cases, only
ISBN, UPC, and EAN are supported.<br>
<br>
FindProducts supports ISBN, UPC, and EAN.
AddItem
GetItemRecommendations
VerifyAddItem
Item.ExternalProductID
MPN
Conditionally
FindProducts
ISBN, UPC, EAN
Conditionally
Conditionally
GetSellerPayments
ISBN, UPC, EAN
Conditionally
An industry-standard value that provides an alternate identification for
the product, if any. Currently, this only returns an alternate ISBN
value. If the catalog defines both an ISBN-13 and ISBN-10,
then the ISBN-13 is returned in Value and the ISBN-10 is returned in
AlternateValue. (That is, the ISBN-13 is considered to be the preferred
identifier.) If the catalog only defines one ISBN, it is returned in
Value (and AlternateValue is not returned). Please note that some
catalogs return ISBN values that are not 10 or 13 characters,
and some values contain non-alphanumeric symbols (e.g., $).
4000
FindProducts
GetSellerPayments
Conditionally
Detailed feedback information for a user. Conveys the score for the
feedback, the textual comment, and other information.
eBay user ID for the user who left the feedback.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Feedback score of the user in CommentingUser.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Text message left by the user in CommentingUser. Used to provide a more
in-depth description of the user's opinion of the transaction.
Returned as text in the language that the
comment was originally left in.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Date and time (in GMT) that the feedback was submitted to eBay.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Type of feedback. Can be Positive, Neutral, Negative, or Withdrawn (see the
CommentTypeCodeType code list). Positive feedbacks add to the user's total
feedback score, negative feedbacks lower the score, and neutral feedbacks do
not affect the score (but do affect the overall picture of the user's online
reputation).
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Textual comment that the user targeted by feedback may leave
in response or rebuttal to the feedback.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Explanation a user can give to a response.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
The ID that uniquely identifies the item listing.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Indicates whether the user who was the feedback recipient was a Buyer or the
Seller for that transaction.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Name of the listing for which feedback was provided.
Returned as CDATA.
Not returned if a listing ended more than 90 days ago.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
The final price for the item, associated with
the currency identified by the currencyId attribute of the AmountType.
Not returned if a listing ended more than 90 days ago.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Unique identifier for the feedback entry.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Unique identifier for the transaction about which
this feedback entry was left.
This field is not returned in the case of TransactionIDs from Chinese auction listings,
because a value of zero is used for TransactionIDs in such cases.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Indicates whether eBay replaced the comment with a message
that the comment was removed.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Indicates whether eBay replaced the response with a message
that the response was removed.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Indicates whether eBay replaced the follow-up with a message
that the follow-up was removed.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Specifies if a user's feedback score is or is not countable. This field is
returned only when a user's feedback score is not countable (value is false).
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Specifies all feedback summary information (except Score). Contains
objects that each convey feedback counts for
positive, negative, neutral, and total feedback counts - for various
time periods each. Also conveys counts of bid retractions for the
predefined time periods.
Bid retractions count, for multiple predefined time periods preceding
the call.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
Negative feedback entries count, for multiple predefined time periods preceding
the call.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
Neutral feedback entries count, for multiple predefined time periods preceding
the call.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
Positive feedback entries count, for multiple predefined time periods
preceding the call.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
Total feedback score, for multiple predefined time periods preceding the
call.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
Total number of negative Feedback comments received by the user, including weekly repeats.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
Total number of positive Feedback comments received by the user, including weekly repeats.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
Container for information about detailed seller ratings (DSRs)
that buyers have left for a seller.
Sellers have access to the number of ratings they've received, as well as
to the averages of DSRs they've received in each
DSR area (i.e., to the average of ratings in the item-description area, etc.).
GetUserProfile
IncludeSelector: FeedbackHistory
Conditionally
Number of neutral comments received from suspended users.
GetUserProfile
IncludeSelector: FeedbackHistory
Conditionally
Total number of neutral Feedback comments received by the user, including weekly repeats.
GetUserProfile
IncludeSelector: FeedbackHistory
Conditionally
Contains the data for one type of feedback for one predefined time
period. Parent FeedbackPeriodArrayType object indicates the type of
feedback counted: positive, neutral, negative, or total.
Indicates the time period for the feedback count. Returns a value indicating
the number of days prior to the call for which feedbacks of the particular
type are counted.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
Count of the feedbacks received by the user for the time period prior to the
call indicated in PeriodInDays.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
Applicable to sites that support the Detailed Seller Ratings feature.
The FeedbackRatingDetailCodeType is the list of areas for detailed seller ratings. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers.
Detailed seller rating in the area of "item as described."
Detailed seller rating in the area of "communication."
Detailed seller rating in the area of "shipping time." Inapplicable to
motor vehicle items.
Detailed seller rating in the area of "charges for shipping and handling."
Inapplicable to motor vehicle items.
(out) Reserved for internal or future use.
Searches Half.com for stock product information (stock description
and Item Specifics), such as information about a particular
kind of DVD or book. Also, retrieves up to 30 Half.com listings associated
with a product.
Searches Half.com for stock product information (stock description
and Item Specifics), such as information about a particular
kind of DVD or book. Also, retrieves up to 30 Half.com listings associated
with a product.
HalfFinding
http://developer.ebay.com/devzone/half-finding/CallRef
findHalfItems
Searches Half.com for items associated with the specified product ID,
returning as many as 1500 items per product.
IncludeSelector
Defines standard subsets of fields to return within the
response.<br>
<br>
If you don't specify this field, the call returns a default
set of fields, focusing on product details only
(see the "Detail Controls" link below). If you specify this
field, the additional fields you retrieve can affect the call's
response time (performance).<br>
<br>
<b>Applicable values</b>:
<p class="ename">• Items</p>
<p class="edef">Include a brief set of item fields
in the response.
Only applicable when you are searching by ProductID.
Not applicable with QueryKeywords.</p>
<p class="ename">• DomainHistogram</p>
<p class="edef">Include the DomainHistogram in
the response. The histogram lists the number of matching
products found and the domains in which they were found.
(A domain is like a high-level category.)
When many matching products are found, you may see
significantly slower response times when you include
the histogram.</p>
<br>
<br>
Use a comma to specify multiple values. (In this case,
the results are cumulative.) See "FindHalfProducts Samples"
for an example of how to use this field.<br>
<br>
See "Detail Controls" for a complete list of
fields that can be returned for each selector.
Yes
FindHalfProducts
No
If true, only retrieve data for products that have been used to
pre-fill active listings on the Half.com site.
If false, retrieve all products that match the query.
This is useful when you use QueryKeywords and you only want to
find products that have associated items (that is, where ItemArray
would not be empty).<br>
<br>
By default, AvailableItemsOnly does not retrieve an ItemArray; it only controls
which products are returned (or counted). When you use QueryKeywords in your
request, only products are returned, ItemArray is never returned.
To retrieve an ItemArray, use a ProductID in your request instead of a
QueryKeyword and specify Items in the IncludeSelector field.
false
FindHalfProducts
No
A domain to search in. This is like searching a section of
a catalog. If not specified, the product search is conducted
across all domains.
DomainName is an unbounded field. If you are using a URL, and you want
to specify multiple values, use an index value (not a comma).
For example, to specify DomainName=Textbooks,Education,
specify DomainName(0)=Textbooks,%20Education.
To determine valid domain names,
first use this call with QueryKeywords. Domain names are returned
for each product (and summarized in the domain histogram, if you
specify DomainHistogram in IncludeSelector).<br>
<br>
A domain is a named grouping of categories whose items share
common product characteristics. For example, all bound books
have a binding or format (e.g., Hardcover), but audiobooks don't.
So audiobooks would have their own domain.
To limit your search to audiobooks, you would specify Audiobooks
as the domain.<br>
<br>
Only useful when QueryKeywords is specified. If you use this with
ProductID, AND logic is applied. In this case, if you specify an
ID that doesn't match the domain (as Half.com has defined it),
no matching product will be found. Therefore, we recommend that
you only use DomainName with QueryKeywords.
FindHalfProducts
No
Use this to retrieve product details for one specific product.
Specify the ID as a string, and use the type attribute to
indicate the nature of the ID you are specifying.
<br>
<br>
In general, you can request up to 10 IDs of the same type by
separating them with commas, as in the following: 014633155310,014633145496.
However, if you specify a ProductID type of Reference (which specifies
a global reference ID for an eBay catalog product), only one ID in
ProductID can be used.
<br>
<br>
The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.
<br>
ItemCount is only returned when ProductID is used in the request
and the IncludeSelector is set to Items or Details.
4000
FindHalfProducts
Conditionally
One or more keywords to search for. When you use a keyword search,
Half.com searches the product catalogs for matching words in the
product title, description, and/or Item Specifics, and it returns
a list of matching products, with no items. To retrieve
items, use ProductID instead. (If you don't already have a
product ID, you can get product IDs from the
response after conducting a keyword search.)<br>
<br>
If specified, you must pass in at least 3 alphanumeric characters.<br>
<br>
The words "and" and "or" are treated like any other word.
Only use "and", "or", or "the" if you are searching for products
containing these words.
To use AND or OR logic, use Half.com's standard search string
modifiers. Wildcards (+, -, or *) are also supported.
Be careful when using spaces before or after modifiers and
wildcards.<br>
<br>
Some keyword queries can result in response times of 30 seconds or
longer. If more than 2000 matches are found, the call fails with
an error. If this kind of error occurs, refine the search by
passing in more keywords and/or by using DomainName to restrict
the search to certain domains (such as DVDs).
If you are searching for a particular book, DVD, CD, or video game
and you already know its ISBN or EAN (for a book) or UPC,
consider using ProductID instead to retrieve more
precise results. <br>
<br>
The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.
<br>
When QueryKeywords is used in the request, ItemCount is not returned.
350
FindHalfProducts
Conditionally
The ID of a specific seller.
Specify this value in combination with ProductID
if you want search results to be filtered so that the items returned
are only items in a specific product, sold by a specific seller.
To specify SellerID, use SellerID and ProductID together.
FindHalfProducts
No
Sorts the list of products returned. This is mostly only useful
with QueryKeywords. (When you use ProductID, Half.com usually only returns one product.)
Popularity
FindHalfProducts
No
Sorts the list of products returned.
Descending
FindHalfProducts
No
Specifies the maximum number of products to return per page
in a single call. This is mostly only useful
with QueryKeywords. (When you use ProductID, Half.com usually only
returns one product, and up to 30 items for that product.)
1
20
1
FindHalfProducts
No
Specifies which page of data to return in the current call.
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).
Use this only when specifying QueryKeywords.
1
2000
1
FindHalfProducts
No
Returns stock product information in Half.com catalogs, such as
information about a particular DVD or book. Optionally,
also returns items that match the product.
A histogram that lists the number of matching products found
and the domains in which they were found.
A <i>domain</i> is essentially
a set of categories that share certain common features
(as determined by Half.com). Each domain has its own name and ID.
FindHalfProducts
IncludeSelector: DomainHistogram
Always
The number of the page of data returned. If many products
are found and multiple pages of results are available, use
this in combination with ApproximatePages and HasMore to decide
which page to retrieve next. As FindHalfProducts only returns
up to 2000 products, the maximum possible value is theoretically
2000 (if you were to set EntriesPerPage to 1 in the request).
1
2000
FindHalfProducts
IncludeSelector: none
Always
The total number of pages that can be returned, given the same
query and filters in the request. As FindHalfProducts only returns
up to 2000 products, the maximum possible value is theoretically
2000 (if you were to set MaxEntries to 1 in the request).
1
2000
FindHalfProducts
IncludeSelector: none
Always
If true, more pages of results are available.
That is, PageNumber is less than ApproximatePages.
FindHalfProducts
IncludeSelector: none
Always
The total number of matching products found.
(If more than 2000 products are found, the call fails
with an error.)
0
2000
FindHalfProducts
IncludeSelector: none
Always
An set of Half.com catalog products. This contains stock information about a
particular DVD, book, or other product.
When you use QueryKeywords in the request, FindHalfProducts returns a
maximum of 20 products per page.
When you use ProductID in the request, FindHalfProducts usually only
returns 1 product. ItemCount is only returned if you use ProductID with
IncludeSelector set to Items or Details.
(If more than one product matches the same ProductID,
FindHalfProducts will return all of those products. As of the time
of this writing, we expect this to be a rare case.)
20
FindHalfProducts
IncludeSelector: none
Always
A URL for product search results that corresponds to your search request. This is similar to ItemSearchURL in FindItems and FindItemsAdvanced.
FindHalfProducts
IncludeSelector: none, Details, SearchDetails, ItemSpecifics, SellerInfo, ExpansionItemCount, CategoryHistogram
Find popular items
Searches for popular items based on a category or keyword.
Returns WatchCount in addition to item information.
FindPopularSearches
Specify CategoryID to restrict your query to a specific category.
Up to 10 categories may be specified.
If you are using a URL, and you want to specify
more than one CategoryID, separate the values with a comma.
For example, to specify Fiction Books and
Children's Books, specify CategoryID=377,279.
<br>
<br>
If the specified category ID doesn't match an existing category
for the site, an invalid-category error message is returned.
To determine valid categories:<br>
Use <b>findItemsAdvanced</b> from the <a href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html">Finding API</a> with CategoryHistogram value in the OutputSelector field
to retrieve matching categories. Then make another
<b>findItemsAdvanced</b> call with the ID of a matching category.
<br>
<br>
CategoryID can be used in combination with QueryKeywords and CategoryIDExclude.
To retrieve the most popular items across all categorys, do not submit a CategoryID.
10
FindPopularItems
Conditionally
A query that specifies a string for searching titles of items on eBay.
If you are using a URL, then to search for multiple words,
use "%20". For example, use Harry%20Potter to search for items
containing those words in any order.
You can incorporate wildcards into a multi-word search, as in the following: ap*%20ip*.
The words "and" and "or" are treated like any other word. Only use "and",
"or", or "the" if you are searching for listings containing these words.
QueryKeywords can be used in combination with CategoryID and CategoryIDExclude.
3
350 (characters)
FindPopularItems
Conditionally
Specify this value if you want search results to be filtered so that the popular
items returned do not include items that belong to a specific category.
<br>
<br>
CategoryIDExclude is an unbounded field.
If you are using a URL, you can separate multiple values with a comma.
For example, if you want to specify
Records and SuperAudio CDs, specify
CategoryIDExclude=306,46354.
<br>
<br>
If you use CategoryIDExclude, it must be used in with QueryKeywords or CategoryID.
The CategoryIDExclude input field need not be used if you specified the
CategoryID input field.
FindPopularItems
No
Specifies the maximum number of entries to return in a single call.
100
0
FindPopularItems
No
Popular items, detail level is default for simple item type. addition with WatchCount.
A list of active items that were listed with the requested product.
FindPopularItems
Always
Retrieves the words most frequently used by eBay users when searching for listings.
These keywords are generated weekly by eBay. Thus, calls retrieve static data.
FindPopularSearches is not available for the following sites: FR, HK, MY, PH, PL, SG, SE.
Finds the words more frequently used by eBay users when searching for listings.
If you use keywords, this call returns available alternative keywords in addition to
popular related keywords.
FindPopularItems
Specify CategoryID to restrict your query to a specific category.
Up to 10 categories may be specified.
If you are using URL parameters, and you want to specify
multiple values, use a comma.
For example, if you want to specify Fiction Books and
Children's Books, specify CategoryID=377,279.
<br>
<br>
If the specified category ID doesn't match an existing category
for the site, an invalid-category error message is returned.
To determine valid categories:<br>
Use <b>findItemsAdvanced</b> from the <a href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html">Finding API</a> with CategoryHistogram value in the OutputSelector field
to retrieve matching categories. Then make another
<b>findItemsAdvanced</b> call with the ID of a matching category.
<br>
<br>
CategoryID can be used in combination with QueryKeywords and IncludeChildCategories.
When IncludeChildCategories is 'true' and used in conjunction with CategoryID,
one and only one CategoryID is allowed. Otherwise, up
to 10 CategoryIDs are allowed.
To retrieve the most popular keywords for a root category, set one of
the CategoryIDs to -1, or do not include CategoryID in the Request.
10
FindPopularSearches
No
This field allows the user to specify one or more search terms, and then
retrieve up to five related search terms and up to five alternative search
terms. If you are using URL parameters, use the "%20" URL encoding to represent
a space. For example, use
Harry%20Potter to search for items containing these words in any order.
<br>
<br>
QueryKeywords can be used in combination with CategoryID and IncludeChildCategories.
FindPopularSearches
No
The maximum number of keywords to be retrieved per category
for this call.
FindPopularSearches
No
1
100
20
Specifies the maximum number of PopularSearchResults per page in
the returned list. If not specified, the default returns 20 results per page.
FindPopularSearches
20
No
Specifies the number of the page of data to return in the current call.
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).
FindPopularSearches
1
No
If true, only one CategoryID can be specified, and keywords
are returned for that category and its subcategories.
When IncludeChildCategories is true and used in conjunction with
CategoryID, one and only one CategoryID is allowed.
<br>
<br>
If false, keywords are returned only for the categories
identified by CategoryID. The default is false.
FindPopularSearches
false
No
Contains the keyword data for the requested categories. A category's data are contained
in a CategoryArrayType object if there is no error (one or more CategoryType objects).
Returns category data as well as related search data.
Returns most popular search words by category. For each
category, the CategoryID, CategoryName, CategoryParentID, and CategoryParentName,
are returned, as well as QueryKeywords, related, and alternate searches.
FindPopularSearches
Always
Indicates the page of data returned by the current call. For instance,
for the first set of items can be returned, this field has a value of
one.
FindPopularSearches
Conditionally
Indicates the total number of pages of data
that could be returned by repeated requests. Returned with a
value of 0 if no pages are available.
FindPopularSearches
Conditionally
Searches for stock product information.
Searches for stock product information (stock description
and Item Specifics), such as information about a particular
kind of DVD or camera. Also, retrieves up to 200 eBay listings associated
with a product.
FindItemsAdvanced
IncludeSelector
Defines standard subsets of fields to return within the
response.<br>
<br>
If you don't specify this field, the call returns a default
set of fields, focusing on product details only
(see the "Detail Controls" link below). If you specify this
field, the additional fields you retrieve can affect the call's
response time (performance).<br>
<br>
<b>Applicable values</b>:
<p class="ename">• Details</p>
<p class="edef">Include all available item fields
in the response. Only applicable when you are searching by
ProductID. Not applicable with QueryKeywords.</p>
<p class="ename">• DomainHistogram</p>
<p class="edef">Include the DomainHistogram in
the response. The histogram lists the number of matching
products found and the domains in which they were found.
(A domain is like a high-level category.)
When many matching products are found, you may see
significantly slower response times when you include
the histogram.</p>
<p class="ename">• Items</p>
<p class="edef">Include a brief set of item fields
in the response.
Only applicable when you are searching by ProductID.
Not applicable with QueryKeywords.</p>
<br>
<br>
Use a comma to specify multiple values. (In this case,
the results are cumulative.) See "FindProducts Samples"
for an example of how to use this field.<br>
<br>
See "Detail Controls" for a complete list of
fields that can be returned for each selector.
Yes
FindProducts
No
If true, only retrieve data for products that have been used to
pre-fill active listings on the specified eBay site.
If false, retrieve all products that match the query.
This is useful when you use QueryKeywords and you only want to
find products that have associated items (that is, where ItemArray
would not beempty).<br>
<br>
This does not retrieve ItemArray; this only controls which
products are returned (or counted). To retrieve ItemArray,
pass Items in IncludeSelector.
false
FindProducts
No
A domain to search in. This is like searching a section of
a catalog. If not specified, the product search is conducted
across all domains.
DomainName is an unbounded field. If you are using a URL, and you want
to specify multiple values, use an index value (not a comma).
For example, to specify DomainName=Textbooks,Education,
specify DomainName(0)=Textbooks,%20Education.
To determine valid domain names,
first use this call with QueryKeywords. Domain names are returned
for each product (and summarized in the domain histogram, if you
specify DomainHistogram in IncludeSelector).<br>
<br>
A domain is a named grouping of categories whose items share
common product characteristics. For example, all bound books
have a binding or format (e.g., Hardcover), but audiobooks don't.
So audiobooks would have their own domain.
To limit your search to audiobooks, you would specify Audiobooks
as the domain.<br>
<br>
Only useful when QueryKeywords is specified. If you use this with
ProductID, AND logic is applied. In this case, if you specify an
ID that doesn't match the domain (as eBay has defined it),
no matching product will be found. Therefore, we recommend that you only use DomainName with QueryKeywords.
FindProducts
No
Use this to retrieve product details for one specific product.
Specify the ID as a string, and use the type attribute to
indicate the nature of the ID you are specifying.
<br>
<br>
The request requires a single one of these three elements: QueryKeywords,
ProductID, or CategoryID, and can only include one of the three.
4000
FindProducts
Conditionally
One or more keywords to search for. When you use a keyword search,
eBay searches the product catalogs for matching words in the
product title, description, and/or Item Specifics, and it returns
a list of matching products, with no items. To retrieve
items, use ProductID instead. (If you don't already have a
product ID, you can get product IDs from the
response after conducting a keyword search.)<br>
<br>
If specified, you must pass in at least 3 alphanumeric characters.<br>
<br>
The words "and" and "or" are treated like any other word.
Only use "and", "or", or "the" if you are searching for products
containing these words.
To use AND or OR logic, use eBay's standard search string
modifiers. Wildcards (+, -, or *) are also supported.
Be careful when using spaces before or after modifiers and
wildcards.<br>
<br>
Some keyword queries can result in response times of 30 seconds or
longer. If more than 2000 matches are found, the call fails with
an error. If this kind of error occurs, refine the search by
passing in more keywords and/or by using DomainName to restrict
the search to certain domains (such as DVDs).
If you are searching for a particular book, DVD, CD, or video game
and you already know its ISBN or EAN (for a book) or UPC,
consider using ProductID instead to retrieve more
precise results. <br>
<br>
The request requires a single one of these three elements: QueryKeywords,
ProductID, or CategoryID, and can only include one of the three.
350
FindProducts
Conditionally
Sorts the list of products returned. This is mostly only useful
with QueryKeywords. (When you use ProductID, eBay usually only
returns one product.)
Also see SortOrder. If ProductSort and SortOrder are not
specified, products are sorted by popularity in descending order.
Popularity
FindProducts
No
Sorts search results in ascending or descending order.
Only applicable with ProductSort. If you specify ProductSort
without SortOrder, the order defaults to Descending for
all criteria except Title (which defaults to Ascending).
Descending
FindProducts
No
Specifies the maximum number of products to return per page
in a single call. This is mostly only useful
with QueryKeywords. (When you use ProductID, eBay usually only
returns one product, and up to 200 items for that product.)
1
20
1
FindProducts
No
Specifies which page of data to return in the current call.
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).
1
2000
1
FindProducts
No
Include a Category ID number in your request to restrict your
query to a specific category.
<br>
The request requires a single one of these three elements: QueryKeywords,
ProductID, or CategoryID, and can only include one of the three.
10
FindProducts
Conditionally
Specifies whether or not to remove duplicate items from search results.
When set to true, and there are duplicate items for an item in the
search results, the subsequent duplicates will not appear in the
results.
Item listings are considered duplicates in the following
conditions: <br>
<ul>
<li>Items are listed by the same seller</li>
<li>Items have exactly the same item title</li>
<li>Items have similar listing formats</li>
<ul>
<li>Auctions: Auction Items, Auction BIN items, Multi-Quantity
Auctions, and Multi-Quantity Auctions BIN items</li>
<li>Fixed Price: Fixed Price, Multi-quantity Fixed Price, Fixed
Price with Best Offer, and Store Inventory Format items</li>
<li>Classified Ads</li>
</ul>
</ul><br>
For Auctions, items must also have the same price and number of bids to
be considered duplicates.
<br>
Filtering of duplicate item listings is not supported on all sites.
For FindProducts, this filter only works when IncludeSelector is set to Items or Details.
false
FindProducts
No
Returns stock product information in eBay catalogs, such as
information about a particular DVD or camera. Optionally,
also returns items that match the product.
The total number of pages that can be returned, given the same
query and filters in the request. As FindProducts only returns
up to 2000 products, the maximum possible value is theoretically
2000 (if you were to set MaxEntries to 1 in the request).
1
2000
FindProducts
Always
IncludeSelector: none
If true, more pages of results are available.
That is, PageNumber is less than ApproximatePages.
FindProducts
Always
IncludeSelector: none
A histogram that lists the number of matching products found and the domains
in which they were found. A <i>domain</i> describes a set of
categories that share certain common characteristics (as determined by eBay).
Each domain has its own name and ID. Only returned when you specify
DomainHistogram in IncludeSelector.
FindProducts
Always
IncludeSelector: DomainHistogram
A list of active items that were listed with the requested
product.
<br />
<br />
<span class="tablenote"><strong>Note:</strong>
ItemArray is returned only when you use ProductID in the search request
(not QueryKeywords) and you set IncludeSelector to Details or Items.
Returned only if eBay has currently matching items.
</span>
<br />
FindProducts
Conditionally
IncludeSelector: Items, Details
The number of the page of data returned. If many products
are found and multiple pages of results are available, use
this in combination with ApproximatePages and MoreResults
to decide which page to retrieve next. As FindProducts only
returns up to 2000 products, the maximum possible value is
theoretically 2000 (if you were to set MaxEntries to 1 in the
request).
1
2000
FindProducts
Always
IncludeSelector: none
An eBay catalog product. This contains stock information about a particular
DVD, camera, set of golf clubs, or other product. When you use QueryKeywords
in the request, FindProducts returns a maximum of 20 products per page. When
you use ProductID in the request, FindProducts usually only returns 1 product
by default. (If more than one product matches the same ProductID, FindProducts
will return all of those products. As of the time of this writing, we expect
this to be a rare case.)
20
FindProducts
Always
IncludeSelector: none
The total number of matching products found. (If more than 2000 products are
found, the call fails with an error.)
0
2000
FindProducts
Always
IncludeSelector: none
Indicates whether there are duplicated items not returned by this
response when HideDuplicateItems is true in the request.
FindProducts
Conditionally
IncludeSelector: Items, Details
Splitting include reviews and guides from GetProducts.
Searches reviews and guides based on product, category, or user. The response provides
information about each user or product's reviews and guides.
FindItemsAdvanced, FindProducts, GetCategoryInfo
Use this to retrieve reviews (not guides) for one specific product.
Specify the ID as a string, and use the type attribute
to indicate the nature of the ID you are specifying.
Same as FindProducts, supports Reference, ISBN, UPC, EAN.
<br>
<br>
ProductID can be used in combination with UserID to return Reviews and Guides.
ProductID and CategoryID cannot be used together.
FindReviewsAndGuides
No
Retrieves reviews and guides written by the specified user.
<br>
<br>
UserID can be combined with either ProductID or CategoryID but not both (as
ProductID and CategoryID cannot be used together).
FindReviewsAndGuides
No
Specify a single CategoryID to restrict your query to a specific Guide category.
<br>
<br>
If the specified category ID doesn't match an existing category
for the site, an invalid-category error message is returned.
To determine valid categories:<br>
Use <b>findItemsAdvanced</b> from the <a href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html">Finding API</a> with CategoryHistogram value in the OutputSelector field
to retrieve matching categories. Then make another
FindReviewsAndGuides call with the ID of a matching category.
<br>
<br>
CategoryID can be used in combination with UserID to return Reviews and Guides.
ProductID and CategoryID cannot be used together.
FindReviewsAndGuides
No
Specifies the maximum number of reviews per page (not guides) in the returned list. If not
specified, the default returns 5 results per page.
FindReviewsAndGuides
5
20
No
Specifies the number of the page of data to return in the current call.
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).
FindReviewsAndGuides
No
Include ReviewSort in your request if you want to sort by a parameter,
such as CreationTime. See the SortOrder field for values for specifying
that results are returned in ascending or descending order.
(By default, results are returned in descending order.)
FindReviewsAndGuides
No
Sorts search results in ascending or descending order, in conjunction
with the value you specify in ReviewsSort. The default is descending
order.
<br> <br>
For example, for the ReviewsSort value of CreationTime,
and a SortOrder value of Descending, the most recently created
reviews are returned first.
Descending
FindReviewsAndGuides
No
Find reviews and guides response type.
Number of returned reviews.
FindReviewsAndGuides
Always
Number of returned buying guides.
FindReviewsAndGuides
Always
Rank of reviewer if using user search.
FindReviewsAndGuides
Conditionally
Number of helpfulness votes if using user search.
FindReviewsAndGuides
Conditionally
The eBay or external IDs associated with the product.
Use the Reference value as input to search for the same product
in the future, or use the ISBN, EAN, or UPC value (if returned).
The ISBN, EAN, and UPC values can also be useful as keys if your
application is comparing products across different sites. Always
returned when Product is returned.
FindReviewsAndGuides
Conditionally
URL to the reviews and guides page.
FindReviewsAndGuides
Always
The number of the page of data returned. If many products
are found and multiple pages of results are available, use
this in combination with TotalPages to decide
which page to retrieve next. As FindProducts only returns
up to 2000 products, the maximum possible value is theoretically
2000 (if you were to set MaxResultsPerPage to 1 in the request).
1
2000
FindReviewsAndGuides
Always
Indicates the total number of pages of data
that could be returned by repeated requests. Returned with a
value of 0 if no pages are available.
FindReviewsAndGuides
Always
Contains information for up to 5 buying guides that match the
query. Buying guides provide useful information about shopping
in a particular domain, like Digital Cameras.
For example, a digital camera buying guide
could help a buyer determine what kind of digital camera
is right for them.
If no buying guides are associated with the product, this only
returns a link to the buying guide hub (the main Guides page).
Count limited by MaxResultsPerPage in request.
FindReviewsAndGuides
Always
Contains information about review details. Count limited by MaxResultsPerPage in request.
FindReviewsAndGuides
Conditionally
Number of helpfulness votes if using user search.
FindReviewsAndGuides
Conditionally
This call will give you the ability to retrieve high level
Category information, relevant for a buy-side application.
Use an ID of -1 to retrieve the root category and the top-level (level
1) meta categories. You can determine other CategoryIDs from the
response from this call, or from a specific item (retrieved from
another call like GetSingleItem), or from the eBay
website.
19 (Note: The eBay database specifies 38. Currently, Category ID's are usually 9 to 12 digits)
GetCategoryInfo
Yes
Defines standard subsets of fields to return within the
response. If you don't specify this field, the call returns
a default set of fields. If you specify this field, the
additional fields (child categories) you retrieve can affect
the call's response time (decrease performance).
<b>Applicable values</b>:
<p class="ename">• ChildCategories</p>
<p class="edef">Include the first level of child categories for
the specified parent.</p>
No
Detail Controls
#detailControls
GetCategoryInfo Samples
#samples
GetCategoryInfo
No
Contains the category data for the eBay site specified as input. The category
data is returned as a CategoryArrayType object, that contains zero, one, or
multiple CategoryType objects. Each CategoryType object contains the detail data
for one category. Other fields indicate how many categories are returned in a call, when the category hierarchy was last updated, and the version of the category hierarchy (all three of which can differ from one eBay site to the next).
List of the returned categories. The category array contains one CategoryType
object for each returned category. Returns empty if no detail level is specified.
GetCategoryInfo
IncludeSelector: none
Always
Indicates the number of categories returned (i.e., the number of CategoryType
objects in CategoryArray).
GetCategoryInfo
IncludeSelector: none
Always
Indicates the last date and time that eBay modified the category hierarchy for the
specified eBay site.
GetCategoryInfo
IncludeSelector: none
Always
Indicates the version of the category hierarchy on the
specified eBay site.
GetCategoryInfo
IncludeSelector: none
Always
Contains a single ItemID or an array of ItemIDs.
Allows you to get the status for a group of items. Returns status information such as ListingStatus and End Time for all items that are listed in the request.
Duplicated items are returned as a single item.
The item ID that uniquely identifies the item listing for which to retrieve the data. You can provide a maximum of 20 ItemIDs. Use a comma to separate ItemIDs.
19 (Note: The eBay database specifies 38. However, Item IDs are usually 9 to 12 digits)
GetItemStatus
Yes
Returns status information for all items in a list. Some of the Item information
is returned in an SimpleItemArrayType object, that can include zero, one, or multiple ItemType objects.
Collection of Item status objects in an SimpleItemArrayType object, that can include zero, one, or multiple ItemType objects.
GetItemStatus
Always
Retrieves publicly available data for one or more listings. Use this call to retrieve much of the information that is visible on a listing's View Item page on the eBay Web site, such as title, prices, and basic shipping costs. Provide ItemID for every item for which you want information. This call returns the same minimal information that is returned by GetSingleItem, for each item with no IncludeSelector specified. (Use GetShippingCosts to retrieve more detailed shipping cost information for a given item.) Duplicated items are returned as a single item.
GetSingleItem
The item ID that uniquely identifies the item listing for which to
retrieve the data. You can provide a maximum of 20 item IDs. When making a
URL request, repeating ItemID parameters must be specified as an indexed
array (e.g., <code>...&ItemID(0)=130310421484&ItemID(1)=
300321408208& ItemID(2)=370214653822...</code>).
<br><br>
Alternatively, as a shortcut for URL requests, you can specify the item
IDs as a comma-separated list in a single ItemID parameter (e.g., ...<
code>&ItemID=130310421484,300321408208,370214653822...</code>
) for convenience.
<br><br>
You can determine an item's ID by calling findItemsAdvanced (<a
href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html"
>Finding API</a>) or from the eBay Web site. Provide ItemID for
every item for which you want information.
19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
(findItemsAdvanced) item.itemId
http://www.developer.ebay.com/DevZone/finding/CallRef/findItemsAdvanced.html#Response.searchResult.item.itemId
GetMultipleItems
Yes
Defines standard subsets of fields to return within the
response.<br>
<br>
If you don't specify this field, the call returns a default
set of fields (see the "Detail Controls" link below). If you specify this field, the additional
fields you retrieve can affect the call's response time
(performance).<br>
<br>
<b>Applicable values</b>:
<p class="ename">• Details</p>
<p class="edef">Include most available fields in the
response (except fields that significantly affect the call's
performance).</p>
<p class="ename">• Description</p>
<p class="edef">Include the Description field in the response. (This can affect the call's performance.)</p>
<p class="ename">• TextDescription</p>
<p class="edef">Include the text Description (no html tag) field in the response. (This can affect the call's performance.)</p>
<p class="ename">• ItemSpecifics</p>
<p class="edef">Include ItemSpecifics in the response.</p>
<p class="ename">• Variations</p>
<p class="edef">Include Variations in the response.</p>
<br>
<br>
Use a comma to specify multiple values. (In this case,
the results are cumulative.) See "GetSingleItem Samples"
for an example of how to use this field.<br>
<br>
See "Detail Controls" for a complete list of
fields that can be returned for each selector.
Yes
Detail Controls
#detailControls
GetMultipleItems Samples
#samples
GetMultipleItems
No
Response to request of GetMultipleItems.
Contains details for a listing (or multiple) listings that correspond to the item ID(s) specified in the request.
GetMultipleItems
Always
IncludeSelector: none
Gets shipping costs for an item. This is one of the ways a buyer or seller
can obtain shipping cost information for an existing item (for which the caller is
either the buyer or seller) at any point in the life of of the listing, before or
after a buyer has committed to purchasing the item(s). This call works for
both flat rate shipping and calculated shipping. Flat rate shipping costs are
established by the seller before bidding occurs. Calculated shipping costs
are calculated by eBay with its shipping partners based on postal code, but note
that insurance cost can only be determined once the final item price is known
when the listing ends. To determine whether a listing has ended, use GetSingleItem.
It is best to call GetShippingCosts only after determining via GetSingleItem
or findItemsAdvanced (<a
href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html"
>Finding API</a>) that the item actually has shipping cost information.
GetSingleItem
The item ID that uniquely identifies the item listing for which to retrieve the data.
19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
GetShippingCosts
Yes
Number of items sold to a single buyer and to be shipped together.
1
GetShippingCosts
No
Destination country postal code (or zipcode, for US). Ignored if no
country code is provided. Optional tag for some countries. More likely to
be required for large countries. Ignored for flat rate shipping.
GetShippingCosts
Conditionally
Destination country code. If DestinationCountryCode is US,
postal code is required and represents US zip code.
US
GetShippingCosts
Conditionally
Indicates whether to return the ShippingDetails container in the response.
false
GetShippingCosts
Conditionally
Response to call of GetShippingCosts.
Shipping-related details for the specified item. This container is only
returned if IncludeDetails is true on input. Any error about shipping services
(returned by a vendor of eBay's who calculates shipping costs) is returned in
ShippingRateErrorMessage. Errors from a shipping service are likely to be related to
issues with shipping specifications, such as package size and the selected shipping
method not supported by a particular shipping service.
GetShippingCosts
Conditionally
Shipping-related details for the specified item. Any error about shipping services
(returned by a vendor of eBay's who calculates shipping costs) is returned in
ShippingRateErrorMessage. Errors from a shipping service are likely to be related to
issues with shipping specifications, such as package size and the selected shipping
method not supported by a particular shipping service.
GetShippingCosts
Always
Retrieves publicly available data for a single listing.
Use this call to retrieve most of the information that is visible
on a listing's View Item page on the eBay Web site,
such as title, description, prices, basic seller and bidder information,
and other details about the listing.Also returns basic
shipping costs. For more shipping details, use GetShippingCosts.
Gets publicly visible details about one listing. This gives you most of the
data that eBay shows on the View Item page (title, description,
price, and other details).
GetItemStatus, GetShippingCosts, GetSingleItem
IncludeSelector
The item ID that uniquely identifies the item listing
for which to retrieve the data.<br>
<br>
You can determine an item's ID by calling findItemsAdvanced (<a
href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html"
>Finding API</a>) or from the eBay Web site.
19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
(FindItems) Item.ItemID
FindItems.html#Response.Item.ItemID
(findItemsAdvanced) item.itemId
http://www.developer.ebay.com/DevZone/finding/CallRef/findItemsAdvanced.html#Response.searchResult.item.itemId
GetSingleItem
Yes
Variation-level SKU that uniquely identifes a variation within
the listing identified by ItemID. Only applicable when the
seller included variation-level SKU (Variation.SKU)
values. Retrieves all the usual Item fields, but limits the
Variations content to the specified variation.
If not specified, the response includes all variations.
GetSingleItem
No
Name-value pairs that identify one or more variations within the
listing identified by ItemID. Only applicable when the seller
listed the item with variations. Retrieves all the usual Item
fields, but limits the Variations content to the specified
variation(s). If the specified pairs do not match any variation,
eBay returns all variations.<br>
<br>
To retrieve only one variation, specify the full set of
name/value pairs that match all the name-value pairs of one
variation. <br>
<br>
To retrieve multiple variations (using a wildcard),
specify one or more name/value pairs that partially match the
desired variations. For example, if the listing contains
variations for shirts in different colors and sizes, specify
Color as Red (and no other name/value pairs) to retrieve
all the red shirts in all sizes (but no other colors).
GetSingleItem
No
Defines standard subsets of fields to return within the
response.<br>
<br>
If you don't specify this field, the call returns a default
set of fields (see the "Detail Controls" link below). If you specify this field, the additional
fields you retrieve can affect the call's response time
(performance).<br>
<br>
<b>Applicable values</b>:
<p class="ename">• Details</p>
<p class="edef">Include most available fields in the
response (except fields that significantly affect the call's
performance).</p>
<p class="ename">• Description</p>
<p class="edef">Include the Description field in the response. (This can affect the call's performance.)</p>
<p class="ename">• TextDescription</p>
<p class="edef">Include the text Description(no html tag) field in the response. (This can affect the call's performance.)</p>
<p class="ename">• ShippingCosts</p>
<p class="edef">Include basic shipping costs in the
response. (Use GetShippingCosts to retrieve more
details.)</p>
<p class="ename">• ItemSpecifics</p>
<p class="edef">Include ItemSpecifics in the response.</p>
<p class="ename">• Variations</p>
<p class="edef">Include Variations in the response.</p>
<p class="ename">• Compatibility</p>
<p class="edef">Include Compatibility in the response.</p>
<br>
<br>
Use a comma to specify multiple values. (In this case,
the results are cumulative.) See "GetSingleItem Samples"
for an example of how to use this field.<br>
<br>
See "Detail Controls" for a complete list of
fields that can be returned for each selector.
Yes
Detail Controls
#detailControls
GetSingleItem Samples
#samples
GetSingleItem
No
Response to GetSingleItem request.
Contains details about the listing whose ID was specified in
the request.
GetSingleItem
Always
IncludeSelector: none
Retrieves user information based on the user ID you specify. The response contains detailed information about a user. You can specify the types of user information you want in the response.
Retrieves user information based on the user ID you specify. The response contains detailed information about a user. You can specify the types of user information you want in the response.
Specifies the user whose data will returned by the call.
GetUserProfile
Yes
Defines standard subsets of fields to return within the
response.<br>
<br>
If you don't specify this field, a default
set of fields is returned. Click "Detail Controls" below
and see "none" for the default fields.
If you specify this field, then the set of fields returned
includes the default fields.
If you specify this field, the additional
fields returned can affect the call's response time
(performance), including in the case of feedback data.<br>
<br>
<b>Applicable values</b>:
<p class="ename">• Details</p>
<p class="edef">Include most available fields (such as StoreURL) in the
response (except fields that can affect the call's response time).</p>
<p class="ename">• FeedbackDetails</p>
<p class="edef">Include a container for information about one feedback entry.
</p>
<p class="ename">• FeedbackHistory</p>
<p class="edef">Include a container for summary feedback data for a user.
</p>
<br>
Use a comma to specify multiple values. (In this case,
the results are cumulative.) See "GetUserProfile Samples"
for an example of how to use this field.<br>
<br>
See "Detail Controls" for a complete list of
fields that can be returned for each selector.
Yes
Detail Controls
#detailControls
GetUserProfile Samples
#samples
GetUserProfile
No
Response to GetUserProfile request.
Contains the returned user data for the specified eBay user.
GetUserProfile
IncludeSelector: none
Always
Summary feedback data for a user. Contains counts of positive, neutral,
and negative feedback for predefined time periods.
GetUserProfile
IncludeSelector: FeedbackHistory
Always
The FeedbackDetails container has fields (ItemID, etc.) with information
about one feedback entry. When you call GetUserProfile, the 5 (maximum) most
recent feedback records are returned in FeedbackDetails containers.
GetUserProfile
IncludeSelector: FeedbackDetails
Conditionally
Gets the official eBay system time in GMT.
The Timestamp field indicates the official eBay system time in GMT.
The value returned represents the date and time when eBay processed the request.
The value is in the ISO 8601 date-time format (YYYY-MM-DDTHH:MM:SS.SSSZ).
Information about an Half.com catalog product.
The title of the product, as specified in the catalog.
Always returned when Product is returned.
FindHalfProducts
IncludeSelector: none
Always
Fully qualified URL for optional information about the product,
such as a movie's description or film credits. This information
is hosted through the Half.com Web site and it cannot be edited.
Portions of the content are protected by copyright.
Applications can include this URL as a link in product search results
so that end users can view additional descriptive details about
the product. This is usually always returned when Product is returned,
but it may be safest to check for the existence of this field.
FindHalfProducts
IncludeSelector: none
Always
Fully qualified URL for a stock image (if any) that is associated
with the Half.com catalog product. The URL is for the image Half.com
usually displays in product search results (usually 70px tall).
It may be helpful to calculate the dimensions of the photo
programmatically before displaying it.
Only returned if a URL is available for the product.
FindHalfProducts
IncludeSelector: none
Conditionally
Contains basic shipping-related costs for the item. If Item.Quantity is greater
than 1, this is the shipping cost for one item. If the seller offers a choice of
more than one shipping service (such as USPS Ground or Expediated), this is the
cost of the "first" shipping option (usually the lowest cost option).
FindHalfProducts
IncludeSelector: Items
Conditionally
If true, your application can attempt to display stock photos that
are returned. If false, your application should not attempt to display
any stock photos that are returned. This recommendation is useful for
catalog data related to products like coins, where stock photos are not
necessarily applicable or available. An application with a graphical
user interface can use this flag to determine
when to hide customized stock photo widgets.
Always returned when Product is returned.
FindHalfProducts
IncludeSelector: none
Always
Total number of listings on the Half.com site that use stock information from
this catalog product. This value can be greater than the number of listings
returned in ItemArray.
<br />
<br />
<span class="tablenote"><strong>Note:</strong>
ItemCount is always returned, however, it's value will be zero unless
you use ProductID in the search request and you set IncludeSelector to
Items. Although ItemCount always returns 0 if you search using QueryKeyword,
check for the presence of MinPrice; if the response contains MinPrice, you
can retrieve a value for ItemCount as described.
</span>
0
FindHalfProducts
IncludeSelector: none
Always
The Half.com or external IDs associated with the product. Use the Reference
value as input to search for the same product in the future, or
use the ISBN, EAN, or UPC value (if returned).
The ISBN, EAN, and UPC values can also be useful as keys
if your application is comparing products across different sites.
Always returned when Product is returned.
FindHalfProducts
IncludeSelector: none
Always
The name of the domain in which the product was found.
If the product is mapped to multiple domains, Half.com returns
the most applicable domain (as determined by Half.com).
Always returned when Product is returned.
FindHalfProducts
IncludeSelector: none
Always
A list of name/value pairs that are included in the product's
pre-filled Item Specifics. These indicate common aspects or
characteristics of the product, such as Publisher (for a book).
Also see ProductID for ISBN, UPC, or EAN values, if applicable.
This is usually returned. (We are not aware of any cases in which this
node is not be returned. However, it may be safest to check for the
existence of this node.)
FindHalfProducts
IncludeSelector: none
Conditionally
A list of active items that were listed with the requested product.
Results are sorted by current price (lowest first),
then by recent positive feedback (highest first).
<br>
<br>
Only returned when you specify Items in IncludeSelector, and the
product has matching items that are currently active on Half.com.
FindHalfProducts
IncludeSelector: Items
Conditionally
The total number of reviews that are available for this product
on the Half.com Web site. This can be greater than the number of
reviews returned by FindProducts. In a future release, we will provide
the capability to retrieve details about reviews.
Always returned when Product is returned.
FindHalfProducts
0
IncludeSelector: none
Always
The minimum price for all active items listed under this product.
This field is only returned when QueryKeywords is specified in the request.
0
FindHalfProducts
IncludeSelector: none
Conditionally
Controls values for item condition, especially for Books catalog.
New, unread, unused and in perfect condition.
Item still in original packaging, no wear and tear, all
facets of the product are intact. (Could easily be mistaken
for brand new.)
Doesn't look brand new but has no easily noticeable damage
and very minimal wear and tear. (You would give it to a
good friend as a gift)
Very minimal damage to the item and still includes all accessories
such as dust jackets, liner notes, and cases.
(You would use it yourself, but wouldn't necessarily give it as a gift)
Some damage to the item but integrity still intact. May be missing an
accessory. (Item beaten up a bit but it works)
Some damage to the item and visibly used.
(out) Reserved for internal or future use
Information about an eBay catalog product.
A set of Half.com catalog products. This contains stock information about a
particular DVD, book, or other product.
When you use QueryKeywords in the request, FindHalfProducts returns a
maximum of 20 products per page.
When you use ProductID in the request, FindHalfProducts usually only
returns 1 product. ItemCount is only returned when ProductID is used
in the request and the IncludeSelector is set to Items or Details.
(If more than one product matches the same ProductID,
FindProducts will return all of those products. As of the time
of this writing, we expect this to be a rare case.)
FindHalfProducts
IncludeSelector: none
Always
A generic histogram entry type.
This is the domain name.<br>
<br>
A product can be mapped to more than one domain.
This means that even if a name appears in this histogram and the
Count is greater than 1, you won't necessarily see the
same name returned for each returned product (in the Product node
of the response). That is, Product.DomainName only
returns the most applicable domain name (as determined by eBay).
FindHalfProducts
FindProducts
Always
IncludeSelector: DomainHistogram
This is the number of products found in the domain.
If a product is mapped to more than one domain, it is counted separately
for each domain. (For example, if the same product name appears in both
Children's Books and Fiction Books, the count for both of these
domains will include that product.) This means you cannot sum the
product counts to determine the total number of matching products
across all domains. The histogram is only intended to show the number
of matching products in each individual domain.
FindHalfProducts
FindProducts
Always
IncludeSelector: DomainHistogram
The seller's requirements regarding whether the buyer pays
for shipping insurance.
The seller offers the buyer the choice of paying
for shipping insurance or not.
The seller requires that the buyer pay for
shipping insurance.
The seller does not offer shipping insurance to the buyer.
The seller is not charging separately for shipping
insurance costs; any insurance is already included in the
base shipping cost.
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.
Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
Shipping costs and options related to an international shipping service. When used
as input, if one is provided, at least one domestic ShippingService must be
provided. This type does not exist before compatibility level 383.
The insurance cost associated with shipping a single item with this shipping
service. If the buyer bought more than one of this item, this proportional to
QuantitySold. If the item has not yet been sold, insurance information cannot
be calculated and the value is 0.00. For calculated shipping only.
GetShippingCosts
Conditionally
An international shipping service offered for shipping the item (for
example, UPS Ground). For flat and calculated shipping.
GetShippingCosts
Conditionally
The cost of shipping each additional item beyond the first item.
For single-item listings, if this is not provided, it is defaulted
to zero. For multi-quantity listings, if this is not provided, it
is set to the value of (in)ShippingServiceCost (unless the request
version is lower than 665, in which case ShippingServiceAdditionalCost
is required and is not defaulted).
For flat shipping only.
GetShippingCosts
Conditionally
The basic shipping cost of the item.
<br>
<br>
<i>Flat shipping:</i> single-item listing: this matches (in)ShippingServiceCost;
multi-quantity listing: with a request version of 665 or greater,
this is the total of (in)ShippingServiceCost plus
((in)ShippingServiceAdditionalCost times the number of items beyond the first
item), and with a request version lower than 665, this is (in)ShippingServiceCost.
<br>
<i>Promotional shipping:</i> For a request version lower than 665, promotional
shipping has no effect on shipping costs. Otherwise: if the promotional
shipping option is lower than other shipping services being offered, the
savings is reflected in the returned shipping cost;
the shipping service named Promotional Shipping Service (or whatever is
the localized name for it) is included among the shipping services;
if the promotional shipping cost is lower than the cost of other shipping
services being offered, it is presented first in the list (the lowest shipping
service cost is always presented first, regardless of whether there is
promotional shipping).
GetShippingCosts
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.
GetShippingCosts
Conditionally
An international location or region to which the item may be shipped via this
particular shipping service. Associated with the shipping service by the
seller. This is basically the same as SimpleItemType.ShipToLocations except
that this is spelled out and the other is abbreviated.
Returned with request version 665 or greater, if set via Trading API.
GetShippingCosts
Conditionally
The minimum guaranteed date in which the item could reach the
buyer's location.
Not applicable to Half.com.
GetShippingCosts
Conditionally
The maximum guaranteed date in which the item could reach the
buyer's location.
Not applicable to Half.com.
GetShippingCosts
Conditionally
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
0
GetShippingCosts
Conditionally
A list of compatible applications specified as name and value pairs. Describes assemblies with which a part is compatible (i.e., compatibility by application). For example, to specify a part's compatibility with a vehicle, the name would map to standard vehicle characteristics (e.g., Year, Make, Model, Trim, and Engine). The values describe the specific vehicle, such as a 2006 Honda Accord.
<br><br>
Parts Compatibility is supported in limited Parts & Accessories categories, on the eBay Motors (US) site (site ID 100) only.
Contains details for an individual compatible application, consisting of a list of name-value pairs and related compatibility notes.
<br><br>
Parts Compatibility is supported in limited Parts & Accessories categories, on the eBay Motors (US) site (site ID 100) only.
GetSingleItem
Conditionally
IncludeSelector: Compatibility
All information corresponding to an individual compatibility by application.
<br><br>
Parts Compatibility is supported in limited Parts & Accessories categories, on the eBay Motors (US) site (site ID 100) only. If a
Contains a list of name-value pairs which together describe a single compatible application. The allowed names and values are specific to the primary category in which the item is listed. For example, when listing in a Parts & Accessories category, where the applications are vehicles, the allowed names might include Year, Make, and Model, and the values correspond to specific vehicles in eBay's catalog.
GetSingleItem
Conditionally
IncludeSelector: Compatibility
The seller may optionally enter any notes pertaining to the compatibility being specified. Use this field to specify the placement of the part on a vehicle or the type of vehicle that a part fits.
GetSingleItem
Conditionally
IncludeSelector: Compatibility
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, use this
listing status information to determine whether eBay has finished
processing the listing.
(out) The listing is still live, or it has recently ended
but eBay has not completed processing
the listing (e.g., we're still determining the high bidder).
A multi-item listing is considered active until all items
have winning bids or purchases or the listing's end time
has passed. (That is, if the listing has a Quantity of 10,
the sale of 1 of those items doesn't end the listing.)
If the listing has ended but this Active
status is returned, please allow several minutes for eBay to
finish processing the listing.
(out) The listing has ended and eBay has completed processing
of the sale (if any), such as determining the high bidder.
(out) The listing has ended and eBay has completed processing
of the sale (if any), such as determining the high bidder.
You can think of Completed and Ended as essentially equivalent.
(The difference is only meaningful to the seller of the item,
as Completed indicates whether eBay has finished calculating
certain selling fees.)
(out) Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
Specifies the selling format used for a listing.
StoresFixedPrice, Dutch, Express
Unknown auction type. (This is not normally used.)
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.
Live auction, on-site auction that can include non-eBay bidders. Live auctions
are listed on the eBay Live Auctions site, in live auction categories. They can
also appear on eBay if the seller lists the lot in a secondary, eBay category.
Reserved for future use.
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.
813
NotReturned
FixedPriceItem
Second chance offer made to a non-winning bidder on an ended listing. A seller
can make an offer to a non-winning bidder when either the winning bidder has
failed to pay for an item or the seller has a duplicate of the item. Second-
chance offer items are on eBay, but they do not appear when browsing or
searching listings. You need to already know the item ID in order to retrieve a
second-chance offer.
A basic fixed-price listing with a Quantity of 1. Allows no auction-style
bidding. Also known as Buy It Now Only on some sites, this should not to be
confused with the BuyItNow option that is available for competitive-bid
auctions. Fixed-price listings appear on eBay.com. They are also listed in a
seller's eBay Store if the seller is a Store owner.
Half.com listing (item is listed on Half.com, not on eBay).
Reserved for future use.
Lead Generation format (advertisement-style listing to solicit
inquiries or offers, no bidding or fixed price, listed on eBay).
Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
Defines how the buyer is to view the discounted price for MAP items. If a seller offers an item
for less than the item's agreed upon Minimum Advertised Price (MAP), the discounted price of the
item cannot be displayed on the page containing the item.
PreCheckout specifies that the buyer must click a link (or a button) to navigate to a separate
page (or window) that displays the discount price.
DuringCheckout specifies that the discounted price must be shown on the eBay checkout
flow page.
None means the discount price is not shown via either PreCheckout nor DuringCheckout.
Reserved for future use.
A list of one or more valid names and corresponding values.
This list is an array of Item Specifics, which are category-specific
fields that the seller added to describe the listing. The names of
these fields are different for items in different categories, so
they're returned in a generic name/value structure.
<br><br>
For example, Item Specifics for a car might include a field like
Make=Toyota (where Make is returned in Name, and Toyota is returned
in Value) and Model=Prius (where Model is returned in Name, and
Prius is returned in Value).<br>
<br>
In multi-variation listings, the same name cannot appear in both
the VariationSpecifics node and in the ItemSpecifics node.
<br><br>
For FindProducts, this can also be an Item Specific that is defined
for a product. That is, Item Specifics can be returned both for
items and products in FindProducts.
GetSingleItem
No
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: ItemSpecifics
Item.ItemSpecifics
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
Item.Variations
FindHalfProducts
Conditionally
IncludeSelector: none
FindProducts
Always
IncludeSelector: none
A name and corresponding value (a name/value pair).
The name of the item specific.
<br>
<br>
This field is returned only in responses if the seller included an item specific
Name in the listing. However, if the seller didn't also include a corresponding
value for the item specific, it is best to not display the name to name to avoid
confusing users.
<br>
<br>
For the item condition, this usually includes the word "Condition" for eBay US,
UK, Australia, and India listings; and "Artikelzustand" for eBay Germany, Austria,
and Switzerland listings.
<br>
<br>
<span class="tablenote"><b>Note:</b>
Ignore item specifics with SIFFTAS in the name. These are for internal use by
eBay and aren't meaningful to users.
</span>
GetSingleItem
No
FindProducts
Always
IncludeSelector: none
FindHalfProducts
Conditionally
IncludeSelector: none
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: ItemSpecifics
Item.ItemSpecifics
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
Item.Variations
GetSingleItem
Conditionally
IncludeSelector: Compatibility
Item.ItemCompatibilityList
A value for the item specific.
<br>
<br>
This field is only returned in responses if the seller included a value
for an item specific. In the GetSingleItem response, this field is always
returned for each item specific that is returned (if any). However,
if the seller didn't select a value for the item specific,
this field may return empty, or it may return a value like "-",
"Not Selected", or "Unspecified" (or the equivalent in the language
of the site).
<br>
<br>
For the item condition, this usually includes the
word "New" or "Used" for eBay US, UK, Australia, and India listings;
and "Neu" or "Gebraucht" for eBay Germany, Austria, and Switzerland
listings.
GetSingleItem
No
FindProducts
Always
IncludeSelector: none
FindHalfProducts
Conditionally
IncludeSelector: none
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: ItemSpecifics
Item.ItemSpecifics
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
Item.Variations
GetSingleItem
Conditionally
IncludeSelector: Compatibility
Item.ItemCompatibilityList
Defines variation-specific pictures associated with one
VariationSpecificName (e.g., Color) whose values differ across variations.
One aspect of the variations that will be illustrated in the
pictures for all variations. For example, if each variation
is visually distinguished by color and the pictures show
the different colors available, then specify "Color" as the name.
The name must match one of the names specified in the
variation specifics.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
One or more pictures that help buyers distinguish the Variations.
Multiple picture sets can be specified. For example, suppose a
listing contains blue and black color variations, and
VariationSpecificName=Color. In this case, one picture set could
contain pictures of the blue shirts (e.g., front view, back view,
and close-up of a trim detail), and another picture set could
contain pictures of the black shirts.<br>
<br>
Sellers do not necessarily provide pictures for all values that
correspond to the variation specific name.
For example, a listing could have pictures depicting the blue and
black color variations, but not the pink variations.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
Contains search word information, as it is related to a category.
Numeric ID of a category on eBay.
FindPopularSearches
Conditionally
Category ID identifying a category that is the parent category
of the category indicated in the request.
FindPopularSearches
Conditionally
Specifies which QueryKeywords corresponds to this PopularSearchResult.
Query Keywords are returned in the output to clarify which result set corresponds to
which QueryKeyword inputs (as there can be more than one set of keywords in the input).
FindPopularSearches
Conditionally
Alternative search keywords for the query keywords, separated by semicolons.
You can use this to find other search terms buyers and sellers may be interested in.
For example, if a seller lists an item with "wedding" in the title, they may also be
interested in adding "bridal" to the title because bridal is an alternative search
keyword which buyers have used.
FindPopularSearches
Conditionally
Keywords related to the query keywords, separated by semicolons.
You can use this to find more detailed related keywords. For example,
the query keyword "wedding" is related to searches for
"wedding decorations;wedding favors;wedding supplies;wedding dresses..." which helps
the seller and buyer specify their query with more detail and precision.
FindPopularSearches
Conditionally
Category Name identifying the name of current CategoryID.
FindPopularSearches
Conditionally
The name of category which is a parent category to the CategoryID
specified in the request.
FindPopularSearches
Conditionally
Defines the type of treatment applied to a discounted item,
either Strikethrough Pricing or Minimum Advertised Price.
STP stands for Strikethrough Pricing.
MAP stands for Minimum Advertised Price.
None means the item does not qualify for either STP or MAP pricing.
Reserved for future use.
ProductID type for product searches.
ISBN-10 or ISBN-13 value for books. (The string length of ProductID
indicates whether the ID is 10 or 13 characters.)
If you know a book's ISBN, you can use this instead of the
eBay CatalogItem or Reference ID to search for that book.
Max length of corresponding value: 13
EAN value for books. (This is used more commonly in
European countries.)
If you know a book's EAN, you can use this instead of the
eBay CatalogItem or Reference ID to search for that book.
Max length of corresponding value: 13
UPC value for products in Music (e.g., CDs), DVDs & Movies,
and Video Games categories (or domains).
If you know a product's UPC, you can use this instead of the
eBay CatalogItem or Reference ID to search for that product.
Max length of corresponding value: 12
Reserved for future use.
Reserved for future use.
Reserved for future use.
The global reference ID for an eBay catalog product.
A reference ID is a fixed reference to a product
(regardless of version).
One reference ID can be associated with multiple CatalogItem IDs.
To determine valid reference IDs for products to use as input to FindProducts, first call
FindProducts with QueryKeywords (or ProductID).
Each product in the response includes a reference ID.<br>
<br>
As of mid-2008, some sites (such as eBay US, Germany, Austria, and Switzerland) are
updating, replacing, deleting, or merging some products (as a result of migrating from one
catalog data provider to another).
If you specify one of these products in a request, the call may return the product with a warning,
or it may return an error if the product has been deleted.
(out) Reserved for internal or future use.
Product ID has an attribute of ProductIDCodeType and a string value.
The nature of identifier being used. For FindHalfProducts, FindProducts,
and FindReviewsAndGuides, only Reference, ISBN, UPC,
and EAN are supported.
Required when ProductID is specified.
FindReviewsAndGuides
FindHalfProducts
FindProducts
CatalogItem,MPN, Keywords
Conditionally
Always
FindReviewsAndGuides
Conditionally
Controls the order of product (not item) searches.
Sort by product popularity (as determined by eBay).
(This is the default sort order.)
Sort by average rating.
Sort by the number of reviews on eBay.
Sort by the number of active items listed with this product.
Sort by the product title.
Reserved for values that are not available in the version of the schema
you are using. If eBay adds a new value to this code type as of a
newer version, we return CustomCode instead when you specify a
lower request version.
State of a catalog product that may have been updated, replaced, marked for deletion,
or merged with another product.
The product details have been updated.
If your application currently uses the product for listing or searching,
we recommend that you check to make sure the product data still meets your needs.
This product has changed. This product has been mapped to a newer
product in the catalog that eBay (or Half.com) is currently using,
and its details have been updated based on the new catalog data.
The product reference ID remains the same
(but the longer product ID string may have changed).
If your application currently uses the product for searching,
we recommend that you check to make sure the product data still meets your needs.
This product was previously available in an earlier catalog,
but it has not been mapped to a product in the catalog that eBay
is currently using. It can still be used for searching, but
it may contain fewer details than other products.
If your application currently uses the product for searching,
we recommend that you check to make sure the product data still meets your needs.
Not applicable to Half.com.
Some information in this product is scheduled to be merged into another product
in the catalog that eBay (or Half.com) is currently using. This product may
be removed from the system at any time.
If your application currently uses the product for searching,
we recommend that you update your application to use a product that is not
scheduled to be merged or deleted.
This product is marked for deletion, and it will not be mapped to another product.
If your application currently uses the product for searching,
we recommend that you update your application to use a product that is not
scheduled to be merged or deleted.
Reserved for internal or future use.
Indicates the text message type of the item's quantity availability.
(out) The message "Limited quantity available" is shown in the web
flow (e.g., for a flash sale or a Daily Deal).
(out) The message "More than 10 available" is shown in the web flow.
10 is the value of QuantityThreshold tag based on the seller's
preference.
Reserved for internal or future use.
Type defining the <b>QuantityInfo</b> container, which consists of the
<b>MinimumRemnantSet</b> field, which sets the minimum amount of event tickets that can
remain in the fixed-price listing's inventory after a buyer purchases one or more tickets (but
not all) from the listing.
This field enables the seller to avoid being left with 1 item in a multi-quanity, fixed-
priced event ticket listing. A typical use case is event tickets in reserved,
adjacent seats, or items that typically only sell if more than
1 can be purchased at once.
<br> <br>
At listing time, sellers specify the minimum number of items that
should remain if a buyer doesn't purchase all the items.
Based on the value of <b>MinimumRemnantSet</b> and the listing's
available quantity (Quantity-QuantitySold), eBay calculates the quantity of tickets
a buyer can purchase.
For example, suppose a seller lists 5 tickets, and wants at least
2 tickets remaining for the final buyer to purchase.
In this case, the seller would set <b>MinimumRemnantSet</b> to '2'.
This means a buyer can purchase 1, 2, 3, or 5 tickets, but not 4
(because 4 would leave the seller with 1 ticket).<br>
<br>
To remove this restriction when revising or relisting item, the seller would
set the <b>MinimumRemnantSet</b> value to '1'.<br>
<br>
This field is currently only applicable for event ticket listings in US and CA, but
may apply to other categories in the future. It is only returned if set by the seller
in the listing.
GetSingleItem
GetMultipleItems
Conditionally
Type for the return policy details of an item.
Specifies how a refund will be made, e.g. as an exchange.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Specifies the length of time in which the item must be returned
under the return policy.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Information about returns accepted.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
A description of the return policy for the item.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Information about the warranty offered.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
The type of warranty offered.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
The length of the warranty offered.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Contains the EAN.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
The party who pays the cost of shipping for a returned item.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Display string that indicates the restocking fee charged by the
seller for returned items. This value is directly related to the
<b>RestockingFeeValueOption</b> value, with the difference
being that applications can use <b>RestockingFeeValue</b>
to present the <b>RestockingFeeValueOption</b> value
buttons or drop-down lists.
GetSingleItem
GetMultipleItems
Conditionally
This enumeration value indicates the restocking fee charged by the
seller for returned items. In order to charge the buyer a restocking
fee when an item is returned, a US seller must input a restocking
fee value as part of the return policy.
GetSingleItem
GetMultipleItems
Conditionally
Contains product reviews written by eBay members.
The product's average rating (out of 5) based on all reviews.
For example, a value like 4.5 would mean the average rating
is 4.5 out of 5. (See ReviewCount for the total number of reviews.)
0
5
FindReviewsAndGuides
Conditionally
An eBay member's review of the product.
20
FindReviewsAndGuides
Conditionally
Sorts reviews by creation time, in ascending or descending order.
Reserved for values that are not available in the version of the schema
you are using. If eBay adds a new value to this code type as of a
newer version, we return CustomCode instead when you specify a
lower request version.
A product review written by an eBay member.
A link to the full review on the eBay Web site.
This URL optimized for natural search: "_W0QQ" is like "?"
(question mark), "QQ" is like "&" (ampersand),
and "Z" is like "=" (equals sign).<br>
<br>
<span class="tablenote"><b>Note:</b>
For a link to all reviews for the product, remove the upvr parameter
from this URL. See the eBay Web Services guide for an example.
</span>
FindReviewsAndGuides
Conditionally
The title of the review.
55
FindReviewsAndGuides
Conditionally
The eBay member's rating of the product.
0
5
FindReviewsAndGuides
Conditionally
The text of the review. If the review is longer than
2000 characters, the text is cut off and it ends with "...".
See Review.URL for a link to the full text of the review.
2000
FindReviewsAndGuides
Conditionally
The reviewer's eBay user ID.
FindReviewsAndGuides
Conditionally
The time and date when the reviewer posted the review.
FindReviewsAndGuides
Conditionally
Type for expressing sales tax data.
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 (##.###).
GetShippingCosts
Conditionally
State or jurisdiction for which the sales tax is being collected.
Only returned if the seller specified a value.
GetShippingCosts
Conditionally
(US only) Whether shipping costs were part of the base amount
that was taxed. Flat or calculated shipping.
GetShippingCosts
Conditionally
(US only) The amount of sales tax, calculated for a
transaction based on the SalesTaxPercent and pricing information.
GetShippingCosts
Conditionally
Contains various details about the current status of a listing. These
values are computed by eBay and cannot be specified at listing time.
Not used. See Item.ConvertedCurrentPrice.
Not used. See Item.CurrentPrice and Variation.StartPrice.
The number of items sold from this variation. Subtract from
Quantity to determine the number of items available.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
Type for the shipping-related details for an item or transaction.
The name of a shipping service.
GetShippingCosts
Always
The basic shipping cost of the item.
This reflects the domestic shipping cost or the international shipping costs,
depending on which applies (that is, whether the bidder/buyer is in the same
country as the listing site of the item).
<br>
<br>
In GetSingleItem, this is always returned when ShippingCostSummary is
returned, except for when the ShippingType is Freight.
<br>
<br>
GetShippingCosts:
<i>Flat shipping:</i> single-item listing: this matches (in)ShippingServiceCost;
multi-quantity listing: with a request version of 665 or greater,
this is the total of (in)ShippingServiceCost plus
((in)ShippingServiceAdditionalCost times the number of items beyond the first
item), and with a request version lower than 665, this is (in)ShippingServiceCost.
<br>
<i>Promotional shipping:</i> For a request version lower than 665, promotional
shipping has no effect on shipping costs. Otherwise: if the promotional
shipping option is lower than other shipping services being offered, the
savings is reflected in the returned shipping cost;
the shipping service named Promotional Shipping Service (or whatever is
the localized name for it) is included among the shipping services;
if the promotional shipping cost is lower than the cost of other shipping
services being offered, it is presented first in the list (the lowest shipping
service cost is always presented first, regardless of whether there is
promotional shipping).
<br>
<i>Shipping surcharge:</i> With a request version of
665 or greater, shipping cost includes any surcharge, and surcharge is not
returned as an individual tag. With a request version lower than 665,
surcharge is not part of the total cost and is returned as its own tag.
GetShippingCosts
Always
GetMultipleItems
GetSingleItem
Freight, Free
Conditionally
IncludeSelector: ShippingCosts
FindHalfProducts
Conditionally
IncludeSelector: Items
FindProducts
Conditionally
IncludeSelector: Items, Details
The cost of insurance. For flat rate shipping, this is the value set by the
seller, if any. For calculated shipping, this is the value calculated by eBay
with the shipping carrier for the particular item and can only be determined
once the final item price is known when the listing ends. To determine whether
a listing has ended, see EndTime or ListingStatus in GetSingleItem.
GetShippingCosts
Conditionally
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: ShippingCosts
How the seller stated that cost of shipping is to be determined, such as flat rate or
calculated.
FindPopularItems
Always
GetShippingCosts
Freight, Free
Always
GetMultipleItems
GetSingleItem
Always
IncludeSelector: ShippingCosts
FindHalfProducts
Conditionally
IncludeSelector: Items
FindProducts
Conditionally
IncludeSelector: Items, Details
If ShippingCosts is specified for the IncludeSelector, and if the seller has specified local
pickup for this item; the LocalPickup boolean is returned as true. This indicates that the
seller does not ship this item. If local pickup
was not specified for this item by the seller, the LocalPickup boolean is not returned.
GetSingleItem
Conditionally
IncludeSelector: ShippingCosts
GetMultipleItems
Conditionally
IncludeSelector: ShippingCosts
Whether the seller offers shipping insurance and, if
so, whether the insurance is optional or required. Flat and
calculated shipping.
GetShippingCosts
Conditionally
The listed shipping cost of the item. If multiple items were purchased, this
includes the listed ShippingServiceAdditionalCost.
<br>
<br>
In GetSingleItem, this is always returned when ShippingCostSummary is
returned, except when the ShippingType is Freight.
GetShippingCosts
Always
GetMultipleItems
GetSingleItem
Freight, Free
Conditionally
IncludeSelector: ShippingCosts
FindHalfProducts
Conditionally
IncludeSelector: Items
FindProducts
Conditionally
IncludeSelector: Items, Details
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
0
GetShippingCosts
Conditionally
Type for the shipping-related details for an item or transaction.
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.
GetShippingCosts
Conditionally
Listing an Item
http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetItFast
The cost of insurance. For flat rate shipping, this is the value set by the
seller, if any. For calculated shipping, this is the value calculated by eBay
with the shipping carrier for the particular item and can only be determined
once the final item price is known when the listing ends. To determine whether
a listing has ended, use GetSingleItem.
<br> <br>
Not applicable to eBay Motors vehicle listings.
0.00
GetShippingCosts
Conditionally
Whether the seller offers shipping insurance and, if so, whether the insurance
is optional or required. Flat and calculated shipping.
GetShippingCosts
Conditionally
Shipping costs and options related to an international shipping service. For
calculated shipping, postal code must be known to determine final shipping
cost (and this can only be known if a transaction has been created). For
GetShippingCosts, if the postal code or bidder is in the same country as the
listing site for the item, it is "domestic shipping" and this container is not
returned (and ShippingServiceOption is returned instead). Otherwise, it is
"international shipping" and this container is returned.
<br> <br>
For GetShippingCosts, results are filtered: if any service is not available
in the buyer's region, it is removed. If no services remain after this
filtering, a warning is returned.
<br><br>
Not applicable to Half.com or eBay Motors vehicle listings.
GetShippingCosts
Conditionally
DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Sales tax details. US site only. Flat and calculated shipping.
<br> <br>
Not applicable to eBay Motors vehicle listings.
GetShippingCosts
Conditionally
For most applicable calls, returns the words No Error or returns an error
message related to an attempt to calculate shipping rates. For calculated
shipping only.
<br> <br>
Not applicable to Half.com or eBay Motors vehicle listings.
GetShippingCosts
Conditionally
Shipping costs and options related to a domestic shipping service.
For GetShippingCosts, if the postal code or bidder is
in the same country as the listing site for the item, it is "domestic
shipping" and this container is returned. Otherwise, it is "international
shipping" and this container is not returned (and InternationalShippingServiceOption
is returned instead, if it exists).
For calculated shipping, postal code must be known to determine final shipping
cost (and this can only be known if a transaction has been created).
For flat shipping: if the listing has not yet ended, any domestic
shipping details are returned; if the listing has ended, domestic
shipping details are only returned if the buyer's location is
"domestic" (that is, it is the same country as the listing site).
<br>
Not applicable to Half.com or eBay Motors vehicle listings.
GetShippingCosts
Conditionally
Tax details for a jurisdiction such as a state or province.
Returned empty in if no tax table was used.
<br> <br>
Not applicable to Half.com.
GetShippingCosts
Conditionally
The cost of insurance for items shipped internationally. For flat rate
shipping, this is the value set by the seller, if any. For calculated
shipping, this is the value calculated by eBay with the shipping carrier for
the particular item and can only be determined once the final item price is
known when the listing ends. To determine whether a listing has ended, use
GetSingleItem.
<br> <br>
Not applicable to eBay Motors vehicle listings.
0.00
GetShippingCosts
Conditionally
Whether the seller offers shipping insurance for items shipped internationally
and, if so, whether the insurance is optional or required. Flat and calculated
shipping.
GetShippingCosts
Conditionally
Italy site (site ID 101) only. Contains the cost of cash-on-delivery shipping.
GetShippingCosts
Conditionally
A location to which the seller will not ship.
Returned only if set via Trading API.
Returned only with a request version of 665 or greater.
GetShippingCosts
Conditionally
Shipping costs and options related to a domestic shipping service.
The insurance cost associated with shipping a single item with this shipping
service. If the buyer bought more than one of this item, this proportional to
QuantitySold. If the item has not yet been sold, insurance information cannot
be calculated and the value is 0.00. For calculated shipping only.
GetShippingCosts
Conditionally
A domestic shipping service offered for shipping the item (for example, UPS
Ground). For flat and calculated shipping.
GetShippingCosts
Conditionally
The basic shipping cost of the item.
<br>
<br>
<i>Flat shipping:</i> single-item listing: this matches (in)ShippingServiceCost;
multi-quantity listing: with a request version of 665 or greater,
this is the total of (in)ShippingServiceCost plus
((in)ShippingServiceAdditionalCost times the number of items beyond the first
item), and with a request version lower than 665, this is (in)ShippingServiceCost.
<br>
<i>Promotional shipping:</i> For a request version lower than 665, promotional
shipping has no effect on shipping costs. Otherwise: if the promotional
shipping option is lower than other shipping services being offered, the
savings is reflected in the returned shipping cost;
the shipping service named Promotional Shipping Service (or whatever is
the localized name for it) is included among the shipping services;
if the promotional shipping cost is lower than the cost of other shipping
services being offered, it is presented first in the list (the lowest shipping
service cost is always presented first, regardless of whether there is
promotional shipping).
GetShippingCosts
Conditionally
The cost of shipping each additional item beyond the first item (flat shipping).
For single-item listings, if this is not provided, it is defaulted
to zero. For multi-quantity listings, if this is not provided, it
is set to the value of (in)ShippingServiceCost (unless the request
version is lower than 665, in which case ShippingServiceAdditionalCost
is required and is not defaulted).
Not applicable to Half.com.
GetShippingCosts
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.
GetShippingCosts
Conditionally
Indicates whether the service is an expedited shipping service. See Enabling Get It Fast.
Not applicable to Half.com.
GetShippingCosts
Conditionally
The minimum guaranteed number of business 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.
GetShippingCosts
Conditionally
The maximum guaranteed number of business 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.
GetShippingCosts
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 Parts and Accessories
items on the eBay US and Motors sites. Only returned if set.
If some transactions in an order have a surcharge, surcharge is added
only for those transactions.
Flat rate shipping only.
<br>
<br>
With a request version of 665 or greater, total shipping cost includes any
surcharge, and ShippingSurcharge is no longer returned as an individual tag.
GetShippingCosts
Conditionally
An international location or region to which the item may be shipped via this
particular shipping service. Associated with the shipping service by the
seller. Use GeteBayDetails to determine which locations are valid per site.
These values are string equivalents of values found in ShippingRegionCodeType
and CountryCodeType.
Returned with request version 665 or greater, if set via Trading API.
GetShippingCosts
Conditionally
The minimum guaranteed date in which the item could reach the
buyer's location.
Not applicable to Half.com.
GetShippingCosts
Conditionally
The maximum guaranteed date in which the item could reach the
buyer's location.
Not applicable to Half.com.
GetShippingCosts
Conditionally
Indicates whether the service is fast in delivery to the end user (less than 4 days) and free for buyer.
GetShippingCosts
Conditionally
The shipping cost model offered by the seller.
The flat rate shipping model: the seller establishes the cost of shipping and cost of
shipping insurance, regardless of what any buyer-selected shipping service
might charge the seller.
The calculated shipping model: the posted cost of shipping is based on the
seller-offered and buyer-selected shipping service, where the shipping costs
are calculated by eBay and the shipping carrier based on the buyer's address,
and any packaging/handling costs established by the seller are automatically
rolled into the total.
The freight shipping model: the cost of shipping is determined by a third
party, FreightQuote.com, based on the item location (zip code). Currently,
Freight can only be specified on input via eBay Web site, not via API.
Free is used when the seller is declaring that shipping is free for the buyer.
Since Free cannot be selected via API, the seller has two options for
signifying that shipping is free when listing an item:
<br>
- omit shipping details, mention in the item description that shipping is
free, and set ShippingTermsInDescription to true
<br>
- select an arbitrary shipping service and set its shipping cost to 0, mention
in the item description that shipping is free, and set
ShippingTermsInDescription to true
<br>
The latter is a better way to communicate "free shipping" because eBay picks
up the "0" cost and can more accurately identify shipping costs in search
results.
The seller did not specify the shipping type.
The seller specified one or more flat domestic shipping services
and one or more calculated international shipping services.
The seller specified one or more calculated domestic shipping services
and one or more flat international shipping services.
Placeholder value. See
<a href="types/simpleTypes.html#token">token</a>.
Container for a list of items. Can contain zero, one, or multiple
SimpleItemType objects, each of which conveys the data for one item listing.
Contains data for an item listing.
FindPopularItems
Always
IncludeSelector: Details
FindHalfProducts
Conditionally
IncludeSelector: Items
FindProducts
Conditionally
IncludeSelector: Items, Details
Contains information for an item.
Whether the seller will accept a best offer for this item.
This feature enables a buyer to make a lower-priced binding offer on a
fixed price item. Buyers can't see how many offers have been made
(only the seller can see this information). To make a best offer on a
listing, use the eBay Web site.
(eBay Help) Making a Best Offer (for Buyers)
http://pages.ebay.com/help/buy/best-offer.html
(eBay DE Hilfe) Preis vorschlagen
http://pages.ebay.de/help/buy/best-offer.html
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
FindProducts
Conditionally
IncludeSelector: Details
The Buy It Now price of the item, returned in the currency of the site
on which the item was listed.
<br />
<br />
For Chinese auctions (competitive bidding online auctions),
Buy It Now lets a user purchase the item at a fixed price and
end the auction immediately. On most sites, after a Chinese
auction has bids, the listing is no longer eligible for Buy It Now.
However, calls can return BuyItNowPrice if
the seller originally listed the item with a Buy It Now option.
Use the Item.BidCount field to determine whether an auction with
Buy It Now has bids or not, and use Item.BuyItNowAvailable to see
if the Buy It Now option is still available.
<br />
<br />
Price fields are returned as doubles, not necessarily in the traditional
monetary format of the site's country. For example, a US Dollar value might be
returned as 3.880001 instead of 3.88.
<br>
<br />
For fixed-price (FixedPriceItem) listings, see CurrentPrice or ConvertedCurrentPrice instead.
<br />
<br />
Returned only if an item was listed with a Buy It Now option.
(GetSingleItem) Item.ListingType
GetSingleItem.html#Response.Item.ListingType
Item.BuyItNowAvailable
#Response.Item.BuyItNowAvailable
Item.ConvertedBuyItNowPrice
#Response.Item.ConvertedBuyItNowPrice
Item.ConvertedCurrentPrice
#Response.Item.ConvertedCurrentPrice
(eBay Help) Buying with Buy It Now
http://pages.ebay.com/help/buy/how-buy-bin.html
(eBay DE Hilfe) Kaufen mit Sofort-Kaufen
http://pages.ebay.de/help/buy/how-buy-bin.html
FindProducts
GetSingleItem
Conditionally
IncludeSelector: Details
The seller's description of the item, if any. This can include
HTML markup and JavaScript. See <a
href="types/simpleTypes.html#string">string</a>
in Simple Schema Types.
<br>
<br>
Some sellers don't specify their own listing description.
Instead, they use a stock description from a catalog available
through eBay. (GetSingleItem doesn't return this stock information.)
500000 (some sites may allow more, but the exact number may vary)
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Description, TextDescription
The ID that uniquely identifies the item listing. eBay generates this ID
when an item is listed. This ID is unique across all eBay sites.
19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
(GetSingleItem) Item.Variations
GetSingleItem.html#Response.Item.Variations
FindPopularItems
GetItemStatus
Always
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
FindHalfProducts
Conditionally
IncludeSelector: Items
FindProducts
Conditionally
IncludeSelector: Items, Details
Indicates whether the item has an active Buy It Now option. On most sites, the
Buy It Now option is disabled once a valid bid for the item has been accepted.
To see if the item was listed with a Buy It Now option, see if the response
includes Item.BuyItNowPrice.
<br />
<br />
This field is returned only if the value is true.
GetItemStatus
Conditionally
GetSingleItem
Conditionally
IncludeSelector: none
FindProducts
Conditionally
IncludeSelector: Items, Details
The listing's Buy It Now Price (if any), converted into the currency
of the site to which you sent this request.
<br />
<br />
Price fields are returned as doubles, not necessarily in the traditional
monetary format of the site's country. For example, a US Dollar value might be
returned as 3.880001 instead of 3.88.
<br />
<br />
Some eBay sites also support multi-item Buy It Now auctions, where you can buy
multiple items from the same listing at a fixed price. See Item.BuyItNowAvailable.
<br>
<br>
For fixed-price (FixedPriceItem) listings, see
CurrentPrice or ConvertedCurrentPrice instead.
<br>
<br>
Returned only if an item was listed with a Buy It Now option.
<br>
<br>
For active items, refresh this value every 24 hours to pick up the current
conversion rates (if this value has been converted).
(GetSingleItem) Item.ListingType
GetSingleItem.html#Response.Item.ListingType
Item.BuyItNowAvailable
#Response.Item.BuyItNowAvailable
Item.BuyItNowPrice
#Response.Item.BuyItNowPrice
Item.ConvertedCurrentPrice
#Response.Item.ConvertedCurrentPrice
(eBay Help) Buying with Buy It Now
http://pages.ebay.com/help/buy/how-buy-bin.html
(eBay DE Hilfe) Kaufen mit Sofort-Kaufen
http://pages.ebay.de/help/buy/how-buy-bin.html
GetSingleItem
Conditionally
IncludeSelector: none
FindProducts
Conditionally
IncludeSelector: Items, Details
Time stamp (in <a href="types/simpleTypes.html#dateTime">GMT</a>)
of when the listing is scheduled to end, or time stamp of the actual end time
(if the item ended).
(GetSingleItem) Item.Variations
GetSingleItem.html#Response.Item.Variations
GetItemStatus
Always
FindPopularItems
Conditionally
GetSingleItem
GetMultipleItems
Always
IncludeSelector: none
FindProducts
Conditionally
IncludeSelector: Items, Details
Time stamp (in <a href="types/simpleTypes.html#dateTime">GMT</a>) that
eBay recorded as the moment that the listing was made available.
The start time returned by a search call may vary
from the value returned by GetSingleItem.
FindProducts
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
The URL to view this listing on eBay. 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. For example, this URL specifies the item title, and
it is optimized for natural search: "_W0QQ" is like "?" (question mark), "QQ" is like
"&" (ampersand), and "Z" is like "=" (equals sign). You shouldn't modify the
query syntax in your application. For example, eBay won't recognize the URL if you
change QQ to ?.
(GetSingleItem) Item.Variations
GetSingleItem.html#Response.Item.Variations
FindPopularItems
Always
GetSingleItem
GetMultipleItems
Always
IncludeSelector: none
FindHalfProducts
Conditionally
IncludeSelector: Items
FindProducts
Conditionally
IncludeSelector: Items, Details
The format of the listing, such as online auction, fixed price,
or advertisement format.
FindPopularItems
Always
StoresFixedPrice, Auction, Half
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
StoresFixedPrice, Auction, Half
FindProducts
Conditionally
IncludeSelector: Items, Details
StoresFixedPrice, Auction, Half
Physical location of the item, as specified by the seller.
(This gives a general indication of where the item will be
shipped or delivered from.)
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
Identifies the payment method (such as PayPal) the seller
will accept when the buyer pays for the item. <br>
<br>
<span class="tablenote"><b>Note:</b>
If the seller only accepts PayPal, the buyer can still pay
with a credit card. PayPal supports major credit cards.
</span>
<br>
Payment methods are not applicable to eBay Real Estate advertisement
listings, or other Classified Ad format listings.
GetSingleItem
Conditionally
Escrow, PrePayDelivery, CODPrePayDelivery, PostalTransfer
IncludeSelector: Details
GetMultipleItems
Conditionally
IncludeSelector: Details
GetSingleItem
FindProducts
Conditionally
Escrow, PrePayDelivery, CODPrePayDelivery, PostalTransfer
IncludeSelector: Details
URL for a picture used as the Gallery thumbnail, if any. The image uses
one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only
returned if the seller chose to show a gallery image.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: none
FindPopularItems
Conditionally
FindProducts
Conditionally
IncludeSelector: Items, Details
Contains the URL for an image associated with the item, if any.
Returned only if the seller included at least one picture
in their listing. Note that this element does not return the URLs of
pictures that the seller included in the Description via HTML IMG tags.
<br>
<br>
Items listed the main eBay site can have a maximum of 12 picture URLs
hosted by eBay Picture Services, or a maximum of 6 picture URLs hosted by a
third party (such as the a photo site). Note that a listing can have up to
24 picture URLs on the US eBay Motors site (for all vehicle listings),
and on the eBay Canada Motors site.
<br>
<br>
eBay uses the seller's first picture at the top of the listing's
View Item page.
150
24
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: none
Postal code indicating the physical location of the item,
as specified by the seller. (This gives a general indication of where
the item will be shipped or delivered from.)
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
FindProducts
Conditionally
IncludeSelector: Details
Numeric ID of the first (or only) category in which the item is listed.
(Listings can appear in more than one category.)
FindPopularItems
Always
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
FindProducts
Conditionally
IncludeSelector: Items, Details
Display name of the first (or only) category in which the item is
listed. This is a fully qualified category breadcrumb
(e.g., Computers & Networking:Laptops, Notebooks).
GetSingleItem
GetMultipleItems
Always
IncludeSelector: none
FindPopularItems
Always
FindProducts
Conditionally
IncludeSelector: Items, Details
The number of items the seller is offering in the listing. (Subtract
Item.QuantitySold from this value to calculate the number of items
currently available for sale.)
<br>
<br>
An online, comptetitive-bidding auction with a Quantity of 1 is referred to as a <
i>Chinese</i> auction. Basic fixed-price and Store Inventory listings can
have a Quantity of 1 or more.
<br />
<br />
The listing's current or Buy It Now price is the price of the item in the
listing.
<br />
<br />
<span class="tablenote"><strong>Note:</strong>
A seller can also offer multiple items for sale with a single
price for all the items. For example, instead of listing 10 lightbulbs
for US 2.00 each, they might list 10 lightbulbs for USD 20.00 (where
you have to buy all 10). This is called a "lot."
<br />
<br />
If the listing includes a lot, Quantity does not specify the lot size; it
reflects how many lots are being sold. For example, if the original listing
included 5 lots of 10 lightbulbs each, Quantity would be 5.
</span>
<br />
Item.ListingType
#Response.Item.ListingType
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
FindHalfProducts
Conditionally
IncludeSelector: Items
Container for information about this listing's seller.
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
FindHalfProducts
Conditionally
IncludeSelector: Items
The number of bids that have been placed on the item.
<br>
<br>
On most sites, the Buy It Now Option becomes unavailable once an auction
has a valid bid. Note that the bid must be above any reserve price.
<br>
<br>
<b>FindPopularItems: </b>For fixed-price listings, the BidCount
value is the total number of items purchased so far (in the listing's
lifetime).
FindPopularItems
GetItemStatus
Always
GetSingleItem
GetMultipleItems
Always
IncludeSelector: none
FindProducts
Conditionally
IncludeSelector: Items, Details
The listing's Buy It Now Price (if any), converted into the currency
of the site to which you sent this request.
<br />
<br />
Price fields are returned as doubles, not necessarily in the traditional
monetary format of the site's country. For example, a US Dollar value might be
returned as 3.880001 instead of 3.88.
<br>
<br />
Some eBay sites also support multi-item Buy It Now auctions, where you can buy
multiple items from the same listing at a fixed price. See Item.BuyItNowAvailable.
<br>
<br>
For fixed-price (FixedPriceItem) listings, see
CurrentPrice or ConvertedCurrentPrice instead.
<br>
<br>
Returned only if an item was listed with a Buy It Now option.
<br>
<br>
For active items, refresh this value every 24 hours to pick up the current
conversion rates (if this value has been converted).
(GetSingleItem) Item.ListingType
GetSingleItem.html#Response.Item.ListingType
Item.BuyItNowAvailable
#Response.Item.BuyItNowAvailable
Item.BuyItNowPrice
#Response.Item.BuyItNowPrice
Item.ConvertedCurrentPrice
#Response.Item.ConvertedCurrentPrice
(eBay Help) Buying with Buy It Now
http://pages.ebay.com/help/buy/how-buy-bin.html
(eBay DE Hilfe) Kaufen mit Sofort-Kaufen
http://pages.ebay.de/help/buy/how-buy-bin.html
FindPopularItems
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
GetItemStatus
Always
FindProducts
Conditionally
IncludeSelector: Items, Details
GetItemStatus
Always
The current price of the item in the original listing currency.
<br><br>
For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price.
<br><br>
For fixed-price and ad format listings, this is the current listing price.
GetSingleItem
GetMultipleItems
Always
IncludeSelector: Details
FindProducts
Conditionally
IncludeSelector: Details
FindHalfProducts
Conditionally
IncludeSelector: Items
The high bidder for comptetitive-bidding auctions that have ended and have a winning
bidder. This indicates the user who purchased the item.
<br>
<br>
Not returned for auctions that have received no bids, or for fixed price and
Store Inventory listings that are still active.
Item.Quantity
#Response.Item.Quantity
GetItemStatus
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Specifies a listing's status in eBay's processing workflow.
If an item's EndTime is in the past, but no details about the
buyer or high bidder are shown (and the user is not anonymous),
use this listing status information to determine whether eBay has
finished processing the listing.
FindPopularItems
GetItemStatus
Always
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
FindProducts
Conditionally
IncludeSelector: Items, Details
Number of items purchased so far from this listing. (Subtract this value from
Item.Quantity to calculate the number of items currently available for sale.)
GetSingleItem
GetMultipleItems
Always
IncludeSelector: Details
Indicates whether any bids on this item are greater than the seller's
reserve price for the listing (if any).
<br>
<br>
A reserve is the lowest price at which the seller is willing to sell
the item. The reserve price is higher than the listing's opening bid
(minimum bid) and lower than the Buy It Now price, if any.
(The reserve price is only known to the seller.)
Some sellers don't set a reserve at all. If a listing does have
a reserve price, the highest bidder will only win
the item if their bid is also above that price.
<br>
<br>
Only returned for online auctions that have a reserve price. (Fixed price, Store
Inventory, and classified ad listings don't have reserve prices.)
GetItemStatus
Always
GetSingleItem
GetMultipleItems
Always
IncludeSelector: Details
An international location or region to which the seller is willing
to ship this item. Returned only for items that have ShipToLocations
specified.
<br>
<br>
<strong>Applicable values</strong>:
<p class="ename">• Americas</p>
<p class="edef">(North, South, or Latin America)</p>
<p class="ename">• Asia</p>
<p class="ename">• Caribbean</p>
<p class="ename">• Europe</p>
<p class="ename">• EuropeanUnion</p>
<p class="ename">• LatinAmerica</p>
<p class="ename">• MiddleEast</p>
<p class="ename">• NorthAmerica</p>
<p class="ename">• Oceania</p>
<p class="edef">(Pacific region other than Asia)</p>
<p class="ename">• SouthAmerica</p>
<p class="ename">• WillNotShip</p>
<p class="edef">(No shipping, buyer must pick up the item)</p>
<p class="ename">• Worldwide</p>
<p class="edef">(Seller will ship worldwide)</p>
<p class="ename">• 2-letter country identifier</p>
<p class="edef">(See CountryCodeType for values)</p>
CountryCodeType
types/CountryCodeType.html
FindProducts
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
The name of the eBay site on which the item was originally listed.
For example, if the item is listed on the eBay US site,
the value would be US. If it's listed on the eBay Germany site,
the value would be Germany.
<br>
<br>
The listing's original site can affect the values of converted
(localized) prices (when your request specifies a site
that is different from the listing's site).
GetSingleItem
GetMultipleItems
FindProducts
Always
IncludeSelector: Details
Time left before the listing ends.
The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
For ended listings, the time left is PT0S (zero seconds).
(GetSingleItem) Item.Variations
GetSingleItem.html#Response.Item.Variations
FindPopularItems
GetItemStatus
Always
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
FindProducts
Conditionally
IncludeSelector: Items, Details
Name of the item as it appears in the listing or in search and
browse results.
<br>
<br>
<b>For US eBay Motors vehicles only:</b> In item-retrieval
calls (like GetSingleItem and GetMultipleItems), this value shows the
vehicle Make and Model (e.g., "Buick : Skylark").
<br>
<br>
<span class="tablenote"><b>Note:</b>
GetSingleItem does not return the same Item.Title
value for US eBay Motors listings. Here's why:
<br>
<br>
In general, GetSingleItem maps to eBay's View Item page. The eBay Motors
Web site's View Item page shows two vehicle titles in the title bar: One
title is a label based on the Year, Make, Model, and Submodel (e.g.,
"1996 Buick Skylark Limited"). The model is included unless it's "Other"
or unspecified. The submodel is included if the seller specified a
submodel. The other title is a path based on the Make and Model (e.g.,
"Buick : Skylark"). The Item.Title value in GetSingleItem maps to this
path.
</span>
<br />
FindPopularItems
Always
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
FindProducts
Conditionally
IncludeSelector: Items, Details
Contains basic shipping-related costs for the item. If Item.Quantity
is greater than 1, this is the shipping cost for one item.
If the seller offers a choice of more than one shipping service
(such as UPS Ground and USPS Media mail), this is the cost of the
"first" shipping option (usually the lowest cost option).
<br>
<br>
If a listing has shipping costs, use GetShippingCosts if you want to get
more details about the services and costs that the seller is offering.
GetShippingCosts
GetShippingCosts.html
FindPopularItems
Always
GetSingleItem
GetMultipleItems
Always
IncludeSelector: ShippingCosts
FindProducts
Conditionally
IncludeSelector: Items, Details
Category-specific fields that the seller added to describe
the listing. The names of these fields are different for items
in different categories, so they're returned in a generic
Name/Value structure. The field names are usually very well known
within the category.
<br>
<br>
For example, a book's item specifics might include a field like
Publication Year=2007 (where Publication Year is returned in Name, and
2007 is returned in Value), and a field like Format=Hardcover. But a car's
item specifics would be different from a book's, with fields like Make=
Toyota and Model=Prius. And a ticket's item specifics would be different
from those of books and cars, with fields like EventType=Concerts and
Venue=The Fillmore.
<br>
<br>
One of the most common uses for item specifics is the item condition.
<br>
<br>
Only returned if the seller included Item Specifics in the listing.<br>
<br>
<span class="tablenote"><b>Note:</b>
Starting in May 2010, many categories in Production and Sandbox
will start returning the item condition in ConditionID and
ConditionDisplayName instead, if the seller used ConditionID
instead of ItemSpecifics.
Monitor the eBay Developers Program
newsletter for details and timing.</span>
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: ItemSpecifics
The number of times the listing's View Item page has been viewed (as determined by
eBay). Only returned if the seller has chosen to include a hit counter in the
listing, and if the seller has also chosen to make the listing's hit count publicly
visible. This field is retrieved asynchronously. If you believe the item has a
publicly visible hit count, but this field is not returned, retry the call.
<br>
<br>
Not applicable to Half.com
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Subtitle of the item. Only returned if the seller included a
subtitle for the listing.
<br>
<br>
For US eBay Motors passenger vehicle, motorcycle, and "other vehicle"
categories or listings in CA eBay Motors passenger vehicle and
motorcycle categories, the seller's subtitle is only available
in the Item.ItemSpecifics node. Call GetSingleItem with
IncludeSelector=ItemSpecifics to retrieve a listing's Item Specifics.
FindProducts
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
The fully qualified ID breadcrumb (path) of the first category.
For example, if the primary category ID is 45678, and its parent
category's ID is 123, the breadcrumb (path) would be 123:45678.
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
ID of the second category in which the item is listed. Returned only if
the seller listed a second category.
FindProducts
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
Name of the second category in which the item is listed. Returned only if
the seller listed a second category.
FindProducts
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
The fully qualified ID breadcrumb (path) of the second category. For example, if the
secondary category ID is 45678, and its parent category's ID is 123, the breadcrumb
(path) would be 123:45678. Returned only if the seller listed a second category.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
Identifier for a Giving Works listing and the benefiting nonprofit charity
organization.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
The item is featured in eBay search results on the mobile.de partner site.
Applicable to eBay Germany.
A Get It Fast listing.
If true, a generic gift icon displays next the listing's title in search and
browse pages.
Returns true if the item has an associated picture. Not returned
if value is false.
Returns true if the item listing is no more than one day old. Not returned
if value is false.
Returns the seller's store information if the seller has an eBay store.
Returns a blank store if the seller does not have an eBay storefront.
FindHalfProducts
Conditionally
IncludeSelector: Items
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
The distance of the item from the buyer. The DistanceFromBuyer unit (miles
or kilometers) varies by site. If the country whose site you are
searching, e.g. India, uses kilometers, then the DistanceFromBuyer unit is
kilometers. Otherwise, e.g. if the country is US or UK, then the
DistanceFromBuyer unit is miles. DistanceFromBuyer is returned if a
value for PostalCode is supplied in the request.
Two-letter ISO 3166 country code to indicate the country where the item is located.
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
FindProducts
Conditionally
IncludeSelector: Details
FindHalfProducts
Conditionally
IncludeSelector: Items
Number of users who have placed the item on their Watch list.
FindPopularItems
Always
Returns the Half.com condition code for the item. For example, "brand new,"
"used," etc.
FindHalfProducts
Conditionally
IncludeSelector: Items
Notes that the Seller made when they listed the item. Not returned if the Seller
did not make any comments.
FindHalfProducts
Conditionally
IncludeSelector: Items
If a seller specified return policy details, then this container has fields with
those details. The fields that can be returned in this container vary by site.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
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 auction listings. Returns null for basic Fixed Price
(FixedPriceItem) and Ad type listings.
4000
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
A prototype description of a well-known type of item, such as a popular book.
<br>
<br>
When returned for GetSingleItem, is always of type Reference, and serves as a global
reference ID for an eBay catalog product.
<br>
<br>
When used as input, retrieves product details for one specific product. Specify the
ID as a string, and use the type attribute to indicate the nature of the ID you are
specifying.
<br>
<br>
The request requires either QueryKeywords or
ProductID, but these fields cannot be used together.
4000
FindProducts
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
FindProducts
Conditionally
IncludeSelector: Items
If true, the seller requires immediate payment for the item. If false (or
not specified), immediate payment is not requested. Buyers must have a
PayPal account to purchase items that require immediate payment.
<br><br>
A seller can choose to require immediate payment for Fixed Price and Buy
It Now listings, including eBay Stores Inventory listings. If a Buy It
Now item ends as an auction (that is, if the Buy It Now option is removed
due to bids being placed on the listing), the immediate payment
requirement does not apply.
<br><br>
<span class="tablenote"><strong>Note:</strong>
The value of the AutoPay flag indicates the seller's stated preference
only. It does not indicate whether the listing is still a candidate for
purchase via immediate payment. For example, if a listing receives bids
and no longer qualifies for immediate payment, the value of the AutoPay
flag does not change.
</span>
<br>
Only applicable to items listed on PayPal-enabled sites and in categories
that support immediate payment. Not applicable to Half.com.
GetMultipleItems
GetSingleItem
Always
IncludeSelector: none
Returns the seller's business information. Set the SellerBusinessCodeType
to 'Commercial' in the request to return the related information. This is only
applicable for sites where Business Seller options are supported.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
Enables you to view the sites on which an item can be purchased,
based on the payment methods offered for the item.
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
Indicates whether the item can be paid for through a payment gateway account. If
IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card 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.
GetSingleItem
Conditionally
Escrow, PrePayDelivery, CODPrePayDelivery, PostalTransfer
IncludeSelector: Details
GetMultipleItems
Always
IncludeSelector: Details
FindProducts
Conditionally
IncludeSelector: Details
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. Only returned
if the listing contains multiple variations.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. When listing the item the seller sets this to a positive integer value (1, 2, 3, 4, 5, 10, 15, or 20) corresponding to the number of days. This time does not include the shipping time (the carrier's transit time). <strong>GetSingleItem</strong> or <strong>GetMultipleItems</strong> returns <strong>HandlingTime</strong> only when shipping service options are specified for the item and the seller specified a handling time.
<br>
<br>
Valid for flat and calculated shipping. Does not apply when there is no shipping, or when using local pickup only or freight shipping.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
A lot is a set of two or more similar items that must be purchased together in
a single transaction. A listing can have multiple lots (instead of multiple
items). When LotSize is specified, the listing price reflects the price of
each lot (not each item within the lot). In this case, Quantity indicates the
number of lots being listed, and LotSize indicates the number of items in each
lot. (If a listing has no lots, Quantity indicates the number of separate
items being listed.) Important: Lot items can be listed only in lot-enabled
categories. GetCategories returns lot size disabled with a value of true
for categories that do not support lots.
<br /><br />
Not applicable to Half.com.
100000
GetSingleItem
Conditionally
IncludeSelector: Details
GetMultipleItems
Conditionally
IncludeSelector: Details
<span class="tablenote"><b>Note:</b>
Starting in early March 2010, this will be supported for a
few test categories in the Sandbox.
In May 2010, ConditionID will be supported for many categories in
Production and Sandbox. Monitor the eBay Developers Program
newsletter for details and timing.</span>
<br>
<br>
The numeric ID (e.g., 1000) for the item condition.
Only returned when the seller specified ConditionID in their listing. Also see ItemSpecifics in case the seller used that
field for the condition instead.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: none, Details
<span class="tablenote"><b>Note:</b>
Starting in early March 2010, this will be supported for a
few test categories in the Sandbox.
In May 2010, ConditionDisplayName will be supported for
many categories in Production and Sandbox.
Monitor the eBay Developers Program
newsletter for details and timing.</span>
<br>
<br>
The human-readable label for the item condition.
Display names are localized for the site on
which they're listed (not necessarily the site on which
they're viewed).<br>
<br>
Most categories use the same display name for the
same condition ID. Some categories may override the display name
based on buyer expectations for items in the category.
For example, condition ID 1000 could be called
"New" in one category and "New with tags" in another.<br>
<br>
Behind the scenes, eBay's search engine uses the ID
(not the display name) to determine whether items are
new, used, or refurbished.<br>
<br>
Only returned when ConditionID is returned. Also see ItemSpecifics
in case the seller used that field for the condition instead.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: none, Details
Indicates the type of message that will be returned describing the quantity
available for the item.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
The quantity threshold above which the seller prefers not to show the actual
quantity available. Returned when the quantity available is greater than the
value of quantity threshold. Currently, 10 is the only available value for
this threshold.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: Details
This container provides information for an item that has a Strikethrough Price
(STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP
applies to only fixed price, BIN items. STP is available on the US, UK, and German
(DE) sites, while MAP is available only on the US site.
<br > <br >
Discount pricing is available to qualified sellers (and their associated developers) who
participate in the Discount Pricing Program. Once qualified, sellers receive a
"sepcial account flag" (SAF) that allows them to apply Discount Pricing to both MSKU
and Non-MSKU items.
Displaying Discount Pricing Information to Buyers
http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DiscountPricing
GetSingleItem
GetMultipleItems
FindPopularItems
Conditionally
Use this field to specify an international country or region, or a special domestic
location (for sites supporting this feature, currently US, UK, DE) 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 your item.
<br><br>
Set ShipToRegistrationCountry to true to have your ExcludeShipToLocation
settings applied to your listing. The locations you have excluded display in
the Shipping and Handling section of your item listing.
<br><br>
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.
<br><br>
The exclude ship-to location values are eBay regions and countries. To see
the valid exclude ship-to locations for a specified site, call GeteBayDetails
with DetailName set to ExcludeShippingLocationDetails. Repeat GeteBayDetails
for each site on which you list.
<br><br>
This field works in conjunction with Item.ShipToLocations to create a set of
international countries and regions to where you will, and will not, ship.
You can list a region in the ShipToLocations field, then exclude specific
countries within that region with this field (for example, you can specify
Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation
setting). In addition, if your ShipToLocations is Worldwide, you can use
this field to specify both regions and countries that you want to exclude
from your shipping destinations.
<br><br>
You can specify a default set of locations to where you will not ship in My
eBay. If you create an Exclude Ship-To List, it is, by default, in effect
when you list items. However, if you specify any value in this field on
input, it nullifies the default settings in your Exclude Ship-To List. (If
you use ExcludeShipToLocation when you list an item, you will need to list
all the locations to where you will not ship the associated item, regardless
of the default settings in your Exclude Ship-To List.)
<br><br>
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.
<br><br>
<span class="tablenote"><strong>Note:</strong>
To enable your default Exclude Ship-To List, you must enable Exclude
Shipping Locations and Buyer Requirements in your My eBay Site Preferences.
For details, see the KnowledgeBase Article <a href=
"https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1495"
>HowTo: ExcludeShipToLocation</a>.
</span>
GetSingleItem
DetailLevel: Details
Conditionally
GetMultipleItems
Conditionally
DetailLevel: Details
This field is only applicable to the US site, and will only be returned if the US
seller qualifies as a Top-Rated Seller. The current requirements for US sellers to
qualify as Top-Rated Sellers are:
<ul>
<li>100 or more selling transactions per year</li>
<li>Shipment tracking information provided to buyer within handling time
for at least 90 percent of their listings</li>
</ul>
<br/><br/>
If this flag is returned for a listing, it indicates that the listing meets the new
requirements for a Top-Rated Listing. A Top-Rated Listing must meet the following
requirements:
<ul>
<li>14-day (or longer) return policy with Money Back option</li>
<li>1-day Handling Time or better</li>
</ul>
<br/><br/>
A new <b>Top-Rated Plus</b> seal will start appearing on the View Item
page for all Top-Rated Listings beginning in November 2012. This seal will
replace the <b>Top-Rated Seller</b> badge. US Top-Rated Sellers get a
20 percent discount on their FVF for all listings that qualify as Top-Rated Listings.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: none
The URL to the eBay Motors item's full Vehicle History Report.
Only returned when the item has a Vehicle History Report.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: none
If true, the eBay Motors item has a Vehicle History Report
associated with it.
GetMultipleItems
GetSingleItem
Conditionally
IncludeSelector: none
This container consists of the <b>MinimumRemnantSet</b>
field, which sets the minimum amount of event tickets that can
remain in the fixed-price listing's inventory after a buyer
purchases one or more tickets (but not all) from the listing.
<br/><br/>
This field is currently only applicable for event ticket listings in
US and CA, but may apply to other categories in the future. It is
only returned if set by the seller in the listing.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: none
Contains information about the weight, volume or other quantity measurement of a listed item so buyers can compare per-unit prices. The European Union requires listings for certain types of products to include the price per unit. eBay uses this information and the item's listed price to calculate and display the unit price on eBay EU sites.
<br/><br/>
<span class="tablenote">
<strong>Note:</strong> This information is currently required only for business sellers, and only for listings with a Buy It Now option.
</span>
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: none
Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of <strong>GlobalShipping</strong> is <code>true</code>, the Global Shipping Program is the default international shipping option for the listing, and eBay designates an appropriate international shipping service. If the value of <strong>GlobalShipping</strong> is <code>false</code>, the seller is responsible for specifying an international shipping service for the listing if desired.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: none
This string field is used by the seller to more clearly describe the condition of
items that are not brand new. This field becomes available to sellers starting in
November 2012.
<br><br>
The <b>ConditionDescription</b> field will be available for all
categories, including categories where the condition type is not applicable
(e.g., Antiques). This field will be applicable for all item conditions except
"New", "Brand New", "New with tags", and "New in box". If
<b>ConditionDescription</b> is used with these conditions (Condition
IDs 1000-1499), eBay will simply ignore this field if included, and eBay will
return a warning message to the user.
<br><br>
This field should only be used to further clarify the condition of the used item.
For example, "The right leg of the chair has a small scratch, and on the seat
back there is a light blue stain about the shape and size of a coin." It should
not be used for branding, promotions, shipping, returns, payment or other
information unrelated to the condition of the item. Make sure that the condition
type (<b>Item.ConditionID</b>), condition description, item description
(<b>Item.Description</b>), and the listing's pictures do not contradict
one another.
<br><br>
The <b>ConditionDescription</b> field is only returned if a condition
description is specified in the listing.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: none
Indicates the number of compatible applications specified for the given item. Applies to items listed with fitment by application only (either manually or with a catalog product that supports compatibility).
<br><br>
Not returned if the item has no specified compatible applications.
<br><br>
To retrieve the list of compatibility count and compatibility information, pass <strong>IncludeSelector</strong> in the request with a value of <code>Compatibility</code>.
<br><br>
Parts Compatibility is supported in limited Parts & Accessories categories, on the eBay Motors (US) site (site ID 100) only.
GetSingleItem
Conditionally
IncludeSelector: Compatibility
A list of parts compatibility information specified as name and value pairs, describing an assembly with which a part is compatible (i.e., compatibility by application). For example, to specify a part's compatibility with a vehicle, the name (search name) would map to standard vehicle characteristics (e.g., Year, Make, Model, Trim, and Engine). The values describe the specific vehicle, such as a 2006 Honda Accord. Use the Product Metadata API to retrieve valid search names and corresponding values.
<br><br>
Not returned if the item has no specified compatible applications.
<br><br>
To retrieve the list of compatibility count and compatibility information, pass <strong>IncludeSelector</strong> in the request with a value of <code>Compatibility</code>.
<br><br>
Parts Compatibility is supported in limited Parts & Accessories categories, on the eBay Motors (US) site (site ID 100) only.
GetSingleItem
Conditionally
IncludeSelector: Compatibility
Contains information related to the item in the context of
a seller's eBay Store. Applicable for auction format, Basic Fixed Price,
and Store Inventory format items listed by eBay Stores sellers.
The URL of the seller's eBay Store page. Not returned if the seller does not
have an eBay store.
<br><br>
FindProducts only returned a default URL at the time of this writing.
FindHalfProducts returns the URL of the seller's Half.com Shop page.
FindHalfProducts
Conditionally
IncludeSelector: Items
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
The name of the seller's eBay Store. Not returned if the seller does not
have an eBay store.
<br><br>
FindProducts returns an empty value for all items at the time of this writing.
FindHalfProducts returns the name of seller's Half.com Shop, which is the
SellerID.
200
FindHalfProducts
Conditionally
IncludeSelector: Items
GetMultipleItems
GetSingleItem
Always
IncludeSelector: Details
Tax-related details for a region or jurisdiction.
Representative identifier for the jurisdiction. Typically an
abbreviation (e.g. CA for California).
GetShippingCosts
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 (##.###).
GetTaxTable: this tag has no value if the user's tax table has not been set.
GetShippingCosts
Conditionally
Whether shipping costs are to be part of the base amount that is taxed.
GetTaxTable: This tag is empty if the user did not previously provide information.
GetShippingCosts
Conditionally
Sales tax details for zero or more jurisdictions (states,
provinces, etc).
Sales tax details for zero or more jurisdictions (states, provinces, etc).
Information is only returned for the jurisdictions for which the user provided
tax information. ShippingIncludedInTax and SalesTaxPercent are returned but
are empty.
GetShippingCosts
Conditionally
This type provides information about the weight, volume or other quantity measurement of a listed item so buyers can compare per-unit prices. The European Union requires listings for certain types of products to include the price per unit. eBay uses this information and the item's listed price to calculate and display the unit price on eBay EU sites.
Designation of size, weight, volume or count to be used to specify the unit quantity of the item. The value can be one of the following:
<br/><br/>
<code>Kg 100g 10g L 100ml 10ml M M2 M3 Unit</code>
GetSingleItem
GetMultipleItems
Conditionally
Number of units of size, weight, volume or count of the item in the specified unit type. eBay will divide the item price by this number to get the price per unit that will be displayed in the item listing for comparison purposes.
GetSingleItem
GetMultipleItems
Conditionally
An eBay ID that uniquely identifies a user. <br><br>For GetAllBidders,
some bidder information is anonymous, to protect bidders from fraud. If the seller makes this API call, the actual ids of all bidders on the seller's item will be returned. If a bidder makes this API call, the bidder's actual id will be returned, but information for all competing bidders or outside watchers will be returned as anonymized userIDs.
Container for eBay's Business User features. A business seller can choose
to offer an item exclusively to bidders and buyers that also represent businesses.
Only applicable when the item is listed in a B2B-enabled category.
Currently, the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites support
B2B business features.
If true, this indicates that the seller is a business user
and intends to use listing features that are offered to
business users only. Applicable only to business sellers
residing in Germany, Austria, or Switzerland who are listing in
a B2B VAT- enabled category on the eBay Germany (DE), Austria
(AT), or Switzerland (CH) sites. The seller must have a valid
VAT ID registered with eBay. This must be set to true if
RestrictedToBusiness is true. It has no effect (and it's not returned)
if RestrictedToBusiness is false. If an item was not qualified as a
business item when originally listed, but meets the conditions for
business items when the item is revised or relisted, the seller can
convert the item to a business item by specifying the appropriate
VAT details. See the eBay Web Services guide for more information and additional rules.
AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
Conditionally
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
If true, this indicates that the seller elects to offer the
item exclusively to business users. If false (or not returned),
this indicates that the seller elects to offer the item to all users.
Applicable only to business sellers residing in Germany,
Austria, or Switzerland who are listing in a B2B VAT-enabled
category on the eBay Germany (DE), Austria (AT), or Switzerland
(CH) sites. If this argument is true, the seller must have a
valid VAT-ID registered with eBay, and BusinessSeller must also
be true.
AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
No
GetBidderList
Conditionally
GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
VAT rate for the item, if any. When the VATPercent is specified, the
item's VAT information appears on the item's listing page. In
addition, the seller can choose to print an invoice that
includes the item's net price, VAT percent, VAT amount, and
total price. Since VAT rates vary
depending on the item and on the user's country of residence, a
seller is responsible for entering the correct VAT rate; it is
not calculated by eBay. To specify a VATPercent, a seller must
have a VAT-ID registered with eBay and must be listing the item on a
VAT-enabled site. Max applicable length is 6 characters,
including the decimal (e.g., 12.345). The scale is 3 decimal places.
(If you pass in 12.3456, eBay may round up the value to 12.346.)
Note: The View Item page may display the precision to 2 decimal places
with no trailing zeros. However, the full value you send in is stored.
6
0
30
AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
Conditionally
GetBidderList
Conditionally
GetItem
GetMultipleItems
GetSingleItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally
Displays the VatSite Id of the seller (in a business
card format) as part of the data returned in GetSingleItem
call if the seller's SellerBusinessCodeType is set to
'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
Displays the VatSite Id of the seller (in a business
card format) as part of the data returned in the GetSingleItem
call if the seller's SellerBusinessCodeType is set to
'Commercial'.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Details
At least one container is required (minOccurs="1") if Pictures container is present in the request.
A value that is associated with VariationSpecificName. For example,
suppose this set of pictures is showing blue shirts, and some of
the variations include Color=Blue in their variation specifics.
If VariationSpecificName is "Color", then VariationSpecificValue would be "Blue".
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
The URL of a picture that is associated with VariationSpecificValue.
The first PictureURL is also used as the gallery picture for
applicable variations.
For example, if the picture set contains pictures of red shirts
(i.e., VariationSpecificName=Color and VariationSpecificValue=Red),
the first picture is used as the gallery picture for
all the red shirt variations.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
Not applicable.
This element hold the values that define the SKU, StartPrice, Quantity, VariationDetails, and VariationSpecifics.
An SKU (stock keeping unit) is an identifier defined by a seller.
If you need to contact the seller to ask a question about a
particular variation, you can mention the SKU (if present) to help
the seller identify the variation you're interested in.
Only returned if the seller chose to specify a SKU for the
variation.
70
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
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.
<br>
<br>
Each variation has 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. Always returned) for multi-variation listings.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
The number of items available for sale that are associated
with this variation.
GetSingleItem
GetMultipleItems
1
Conditionally
IncludeSelector: Variations
A list of name/value pairs that uniquely identify the variation
within the listing. All variations specify the same set of
names, and each variation provides a unique combination of
values for those names. For example, if the items vary by color and
size, then every variation specifies Color and Size as names,
and no two variations can specify the same combination of
color and size values. Use this information to identify a
variation of interest when you communicate with
the seller.
<br>
<br>
If your application supports PlaceOffer (in the Trading API),
you use this information to uniquely identify the variation
that you want to purchase.
2
5
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
Not used. See SellingStatus.QuantitySold instead.
Contains the variation's current price and quantity sold.
Always returned when variations are present.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
This container provides information for an item that has a Strikethrough Price
(STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP
applies to only fixed price, BIN items. STP is available on the US, UK, and German
(DE) sites, while MAP is available only on the US site.
<br><br>
Discount pricing is available to qualified sellers (and their associated developers) who
participate in the Discount Pricing Program. Once qualified, sellers receive a
"sepcial account flag" (SAF) that allows them to apply Discount Pricing to both MSKU
and Non-MSKU items.
Displaying Discount Pricing Information to Buyers
http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DiscountPricing
GetSingleItem
GetMultipleItems
FindPopularItems
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 example, a listing could include 10 "Blue, Large"
variations and 20 "Black, Medium" variations.
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.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
Contains a set of pictures that correspond to one of the
variation specifics, such as Color. For example, if a listing
has blue and black color variations, a listing could specify the
name Color as an organizing mechanism for all the pictures,
and then include a set of pictures for the blue variations and
another set of pictures for the black variations.<br>
<br>
<span class="tablenote"><b>Note:</b>
Only one Pictures node is currently returned for a listing.
However, the node has been defined as unbounded (repeatable) in
the schema to allow for different use cases for some calls or sites
in the future.</span>
1
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations
A list of all variation names and values that are defined on
the item. This could include values that were previously
defined (but no longer for sale).<br>
<br>
eBay uses this list to configure variation selection widgets
that appear on eBay's View Item page.
For example, if Color and Size are names in the list, then
eBay's View Item page displays Color and Size drop-down lists
to help a buyer choose a variation of interest.<br>
<br>
The order in which the names and values are returned
matches the order in which the selection widgets appear on
the View Item page.
For example, if the names "Color", then "Size", and then
"Sleeve Style" are returned, the View Item page shows drop-down
lists with those labels in that order. For "Size", if the values
returned are "S", "M", and then "L", the View Item page
shows the values in that order in the Size drop-down list.
GetSingleItem
GetMultipleItems
Conditionally
IncludeSelector: Variations