eBay Trading API
|
Retrieves the best offers associated with an ItemID, according to the BestOfferStatus filter, where Active is the default value. You can specify a best offer ID to retrieve the details for a specific best offer. A buyer can use GetBestOffers to see the buyer's best offer (BestOfferID, etc.) and the current state of the best offer (e.g., whether the seller has made a counter offer).
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History Top Errors for GetBestOffers |
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?> <GetBestOffersRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Standard Input Fields --> <DetailLevel> DetailLevelCodeType </DetailLevel> <!-- ... more DetailLevel nodes here ... --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <OutputSelector> string </OutputSelector> <!-- ... more OutputSelector nodes here ... --> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> <!-- Call-specific Input Fields --> <BestOfferID> BestOfferIDType (string) </BestOfferID> <BestOfferStatus> BestOfferStatusCodeType </BestOfferStatus> <ItemID> ItemIDType (string) </ItemID> <Pagination> PaginationType <PageNumber> int </PageNumber> </Pagination> </GetBestOffersRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Standard Input Fields [Jump to call-specific fields] |
| DetailLevel | DetailLevelCodeType | Optional,
repeatable: [0..*] |
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.) |
| ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong |
| MessageID | string | Optional |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
| OutputSelector | string | Optional,
repeatable: [0..*] |
You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. |
| Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
| WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level. |
| Call-specific Input Fields | |||
| BestOfferID | BestOfferIDType (string) | Optional | Need not be specified by a buyer or a seller. The BestOfferID is the specific Best Offer you want information about. If you are the seller, you can get a list of all best offers (according to BestOfferStatus) by omitting this field. |
| BestOfferStatus | BestOfferStatusCodeType | Optional |
A filter that specifies which Best Offers to return for an item (such as countered, expired, or accepted). Active is the default.
Applicable values: • Active (in/out) Retrieve active best offers only. • All (in/out) Retrieve all best offers (including declined offers, etc.). (Not all values in BestOfferStatusCodeType apply to this field.) |
| ItemID | ItemIDType (string) | Optional |
The item for which Best Offer information is to be returned. If you are a buyer and you have a valid best offer, then your best-offer information will be returned for the item you specify. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). |
| Pagination | PaginationType | Optional | Specifies how to create virtual pages in the returned list (such as total number of entries and total number of pages to return). Default for EntriesPerPage with GetBestOffers is 20. |
| Pagination.PageNumber | int | Optional |
Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Min: 1. Default: 1. |
| Input Detail Controls Samples Change History Top Errors for GetBestOffers |
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?>
<GetBestOffersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Standard Output Fields -->
<Ack> AckCodeType </Ack>
<Build> string </Build>
<CorrelationID> string </CorrelationID>
<Errors> ErrorType
<ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
<ErrorCode> token </ErrorCode>
<ErrorParameters ParamID="string"> ErrorParameterType
<Value> string </Value>
</ErrorParameters>
<!-- ... more ErrorParameters nodes here ... -->
<LongMessage> string </LongMessage>
<SeverityCode> SeverityCodeType </SeverityCode>
<ShortMessage> string </ShortMessage>
</Errors>
<!-- ... more Errors nodes here ... -->
<HardExpirationWarning> string </HardExpirationWarning>
<Timestamp> dateTime </Timestamp>
<Version> string </Version>
<!-- Call-specific Output Fields -->
<BestOfferArray> BestOfferArrayType
<BestOffer> BestOfferType
<BestOfferCodeType> BestOfferTypeCodeType </BestOfferCodeType>
<BestOfferID> BestOfferIDType (string) </BestOfferID>
<Buyer> UserType
<Email> string </Email>
<FeedbackScore> int </FeedbackScore>
<RegistrationDate> dateTime </RegistrationDate>
<UserID> UserIDType (string) </UserID>
</Buyer>
<BuyerMessage> string </BuyerMessage>
<ExpirationTime> dateTime </ExpirationTime>
<Price currencyID="CurrencyCodeType"> AmountType (double) </Price>
<Quantity> int </Quantity>
<SellerMessage> string </SellerMessage>
<Status> BestOfferStatusCodeType </Status>
</BestOffer>
<!-- ... more BestOffer nodes here ... -->
</BestOfferArray>
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<Currency> CurrencyCodeType </Currency>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<EndTime> dateTime </EndTime>
</ListingDetails>
</Item>
<ItemBestOffersArray> ItemBestOffersArrayType
<ItemBestOffers> ItemBestOffersType
<BestOfferArray> BestOfferArrayType
<BestOffer> BestOfferType
<BestOfferCodeType> BestOfferTypeCodeType </BestOfferCodeType>
<BestOfferID> BestOfferIDType (string) </BestOfferID>
<Buyer> UserType
<Email> string </Email>
<FeedbackScore> int </FeedbackScore>
<RegistrationDate> dateTime </RegistrationDate>
<UserID> UserIDType (string) </UserID>
</Buyer>
<BuyerMessage> string </BuyerMessage>
<ExpirationTime> dateTime </ExpirationTime>
<Price currencyID="CurrencyCodeType"> AmountType (double) </Price>
<Quantity> int </Quantity>
<SellerMessage> string </SellerMessage>
<Status> BestOfferStatusCodeType </Status>
</BestOffer>
<!-- ... more BestOffer nodes here ... -->
</BestOfferArray>
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<Currency> CurrencyCodeType </Currency>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<EndTime> dateTime </EndTime>
</ListingDetails>
</Item>
<Role> TradingRoleCodeType </Role>
</ItemBestOffers>
<!-- ... more ItemBestOffers nodes here ... -->
</ItemBestOffersArray>
<PageNumber> int </PageNumber>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
</GetBestOffersResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Standard Output Fields [Jump to call-specific fields] |
| Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.
Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.) |
| Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
| CorrelationID | string | Conditionally |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
| Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request.
See Error Handling. |
| Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. |
| Errors.ErrorCode | token | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. |
| Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
| Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | The index of the parameter in the list of parameter types returned within the error type. |
| Errors.ErrorParameters.Value | string | Conditionally | The value of the variable (e.g., the attribute set ID) |
| Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
| Errors.SeverityCode | SeverityCodeType | Conditionally |
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error |
| Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
| HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
| Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
| Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response. |
| Call-specific Output Fields | |||
| BestOfferArray | BestOfferArrayType | Conditionally |
All best offers for the item according to the filter or best offer id (or both) used in the input. The buyer and seller messages are returned only if the detail level is defined. Includes the buyer and seller message only if the ReturnAll detail level is used. Only returned if best offers have been made.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BestOfferArray.BestOffer | BestOfferType | Always,
repeatable: [1..*] |
A container of details about a best offer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BestOfferArray.BestOffer .BestOfferCodeType |
BestOfferTypeCodeType | Always |
The best offer type.
Applicable values: • BuyerBestOffer (out) The buyer has placed best offer on the item. • BuyerCounterOffer (out) The buyer has made a counter offer. • CustomCode (out) Reserved for internal or future use. • SellerCounterOffer (out) The seller has made a counter offer. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BestOfferArray.BestOffer .BestOfferID |
BestOfferIDType (string) | Always |
An ID to distinguish this best offer from other best offers made on the item.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BestOfferArray.BestOffer.Buyer | UserType | Always |
Information about the buyer who made the best offer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BestOfferArray.BestOffer.Buyer |
string | Conditionally |
Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Based on Trust and Safety policies, the time is unspecified and can vary by site. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BestOfferArray.BestOffer.Buyer .FeedbackScore |
int | Always |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BestOfferArray.BestOffer.Buyer .RegistrationDate |
dateTime | Always |
Indicates the date the specified user originally registered with eBay. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BestOfferArray.BestOffer.Buyer .UserID |
UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized. For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BestOfferArray.BestOffer .BuyerMessage |
string | Conditionally |
Text message that was provided by a buyer when placing a best offer. Max length: 500 (in bytes). DetailLevel: ReturnAll. |
|
BestOfferArray.BestOffer .ExpirationTime |
dateTime | Always |
Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BestOfferArray.BestOffer.Price | AmountType (double) | Always |
The amount of the best offer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BestOfferArray.BestOffer.Price [ attribute currencyID ] |
CurrencyCodeType | Always |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
BestOfferArray.BestOffer .Quantity |
int | Always |
The number of items for which the buyer is making an offer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BestOfferArray.BestOffer .SellerMessage |
string | Conditionally |
Text response to buyer from seller. Max length: 500 (in bytes). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BestOfferArray.BestOffer .Status |
BestOfferStatusCodeType | Always |
The state of the offer. In the case of a PlaceOffer response that specified a best offer, Status may be "Accepted" if the best offer was at or above an auto-accept price.
Applicable values: • Accepted (out) The best offer was accepted by the seller. • Active (in/out) Retrieve active best offers only. • AdminEnded (out) The best offer was ended by an administrator. • All (in/out) Retrieve all best offers (including declined offers, etc.). • Countered (out) Retrieve all counter best offers. • CustomCode (out) Reserved for internal or future use. • Declined (out) The best offer was rejected by the seller. • Expired (out) The best offer expired after 48 hours due to no action by the seller. • Pending (out) The best offer is awaiting seller response or will naturally expire after 48 hours. • Retracted (out) The best offer was retracted by the buyer. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Item | ItemType | Conditionally |
The item for which Best Offers are being returned. Only returned if best offers have been made.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Item.BuyItNowPrice | AmountType (double) | Conditionally |
For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. Once a Chinese auction has bids (and the high bid exceeds the reserve price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| Item.Currency | CurrencyCodeType | Conditionally |
Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the item-listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item.
Applicable values: See Currency. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Item.ItemID | ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Item.ListingDetails | ListingDetailsType | Always |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Item.ListingDetails.EndTime | dateTime | Conditionally |
Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended. In GetSearchResults, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times. In GetSearchResults, the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ItemBestOffersArray | ItemBestOffersArrayType | Conditionally |
A collection of details about the best offers received for a specific item. Empty if there are no best offers.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers |
ItemBestOffersType | Conditionally,
repeatable: [0..*] |
A collection of details about the best offers received for a specific item. Empty if there are no best offers. Includes the buyer and seller messages only if the ReturnAll detail level is used.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray |
BestOfferArrayType | Conditionally |
All best offers for the item according to the filter or best offer id (or both) used in the input. The buyer and seller messages are returned only if the detail level is defined. Includes the buyer and seller message only if detail level ReturnAll is used. Only returned if best offers have been made.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer |
BestOfferType | Always,
repeatable: [1..*] |
A container of details about a best offer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.BestOfferCodeType |
BestOfferTypeCodeType | Always |
The best offer type.
Applicable values: • BuyerBestOffer (out) The buyer has placed best offer on the item. • BuyerCounterOffer (out) The buyer has made a counter offer. • CustomCode (out) Reserved for internal or future use. • SellerCounterOffer (out) The seller has made a counter offer. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.BestOfferID |
BestOfferIDType (string) | Always |
An ID to distinguish this best offer from other best offers made on the item.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.Buyer |
UserType | Always |
Information about the buyer who made the best offer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.Buyer.Email |
string | Conditionally |
Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Based on Trust and Safety policies, the time is unspecified and can vary by site. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.Buyer.FeedbackScore |
int | Always |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.Buyer .RegistrationDate |
dateTime | Always |
Indicates the date the specified user originally registered with eBay. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.Buyer.UserID |
UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized. For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.BuyerMessage |
string | Conditionally |
Text message that was provided by a buyer when placing a best offer. Max length: 500 (in bytes). DetailLevel: ReturnAll. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.ExpirationTime |
dateTime | Always |
Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.Price |
AmountType (double) | Always |
The amount of the best offer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.Price [ attribute currencyID ] |
CurrencyCodeType | Always |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.Quantity |
int | Always |
The number of items for which the buyer is making an offer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.SellerMessage |
string | Conditionally |
Text response to buyer from seller. Max length: 500 (in bytes). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.BestOfferArray .BestOffer.Status |
BestOfferStatusCodeType | Always |
The state of the offer. In the case of a PlaceOffer response that specified a best offer, Status may be "Accepted" if the best offer was at or above an auto-accept price.
Applicable values: • Accepted (out) The best offer was accepted by the seller. • Active (in/out) Retrieve active best offers only. • AdminEnded (out) The best offer was ended by an administrator. • All (in/out) Retrieve all best offers (including declined offers, etc.). • Countered (out) Retrieve all counter best offers. • CustomCode (out) Reserved for internal or future use. • Declined (out) The best offer was rejected by the seller. • Expired (out) The best offer expired after 48 hours due to no action by the seller. • Pending (out) The best offer is awaiting seller response or will naturally expire after 48 hours. • Retracted (out) The best offer was retracted by the buyer. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.Item |
ItemType | Conditionally |
The item for which Best Offers are being returned. Only returned if best offers have been made.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.Item .BuyItNowPrice |
AmountType (double) | Conditionally |
For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. Once a Chinese auction has bids (and the high bid exceeds the reserve price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| ItemBestOffersArray .ItemBestOffers.Item .BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ItemBestOffersArray .ItemBestOffers.Item.Currency |
CurrencyCodeType | Conditionally |
Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the item-listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item.
Applicable values: See Currency. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.Item.ItemID |
ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.Item .ListingDetails |
ListingDetailsType | Always |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.Item .ListingDetails.EndTime |
dateTime | Conditionally |
Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended. In GetSearchResults, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times. In GetSearchResults, the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ItemBestOffersArray .ItemBestOffers.Role |
TradingRoleCodeType | Conditionally |
Indicates whether the user who was the feedback recipient was a Buyer or the Seller for that transaction.
Applicable values: • Buyer (in/out) Acting as buyer. • CustomCode (in/out) Reserved for future use. • Seller (in/out) Acting as seller. For GetOrders, you can use this value to limit orders to those where the calling user is the seller. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| PageNumber | int | Conditionally |
Specifies the number of the page of data to return in the response. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. For GetOrders, PageNumber is only applicable to Half.com (is not applicable to eBay.com). Min: 1. Default: 1. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| PaginationResult | PaginationResultType | Conditionally |
Provides information about the data returned, including the number of pages and the number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
PaginationResult .TotalNumberOfEntries |
int | Conditionally |
Indicates the total number of entries that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no entries are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
PaginationResult .TotalNumberOfPages |
int | Conditionally |
Indicates the total number of pages of data that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no pages are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Input Output Samples Change History Top Errors for GetBestOffers |
The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)
The none column indicates the fields that are returned when you do not specify a DetailLevel.
| Y | The field is always returned. |
| (Y) | The field is conditionally returned. See the field description for clarification of conditions. |
| - | The field is not returned. |
| Input Output Detail Controls Change History Top Errors for GetBestOffers |
An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetBestOffers.
| Input Output Detail Controls Samples Top Errors for GetBestOffers |
| Version | Description |
|---|---|
| 637 2009-09-30 |
|
| 539 2007-11-14 |
|
| 517 2007-06-13 |
|
| 499 2007-02-07 |
|
This document was generated with a customized version of the apireferencedocs tool.
© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.