Use this call to return information from the All Selling section of the authenticated user's My eBay account. You can review items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items. You can also return a items that the user has deleted from their sold and unsold lists, and items that have been scheduled but are not yet active.
GetMyeBaySelling returns information for only the user authenticated with the call. Responses are based on the information in their My eBay account.
Depending on the selling information you want to inspect, GetMyeBaySelling can return any combination of selling information contained in the user's My eBay account. For each response container you want returned, specify a value of true in the respective container's Include field in your request. For example, the following code returns the list of items currently for sale:
<ActiveList>
<Include>true</Include>
</ActiveList>
Each response container returns with a default set of fields. If you need, use the controls provided in each container to filter or alter the presentation of the default response set. For example, some containers can be sorted and some support pagination.
To return all the selling containers, set DetailLevel to ReturnAll. In this case, you only have to specify a container if you want to override the default return set with a custom setting. If you want to exclude a specific container from the response, set Include to false in the appropriate container.
Note, however, that SellingSummary is not automatically returned when DetailLevel is set to ReturnAll; if you want a selling summary returned, you must specify the container in the request.
You can test GetMyeBaySelling in the Sandbox. Because the call returns information for only the user making the call, you will need to use several test users to fully test the call. Create tokens for the different users and use the appropriate tokens when making calls for the different users. If needed, you can use automated test users in the Sandbox; see Using the Sandbox for more information.
Create several sample listings with a registered Sandbox user. Have one or more different users place bids on the listings, then end the listings with sold and unsold items.
Make sure that items returned in ScheduledList or ActiveList are for scheduled or active listings, respectively. Also, ensure that items returned in SoldList and UnsoldList containers are for listings that have ended. Check the user's My eBay accounts in the Sandbox user interface and make sure the lists returned by the call match those in the UI.
Request a SoldList or UnsoldList using a DurationInDays value. Check the user's My eBay in the Sandbox user interface to make sure the correct number of items is returned.
See:
My eBay
Managing Selling and Reminders with My eBay
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History Top Errors for GetMyeBaySelling User Notes |
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"?> <GetMyeBaySellingRequest 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 --> <ActiveList> ItemListCustomizationType <Include> boolean </Include> <IncludeNotes> boolean </IncludeNotes> <ListingType> ListingTypeCodeType </ListingType> <Pagination> PaginationType <EntriesPerPage> int </EntriesPerPage> <PageNumber> int </PageNumber> </Pagination> <Sort> ItemSortTypeCodeType </Sort> </ActiveList> <BidList> ItemListCustomizationType <Include> boolean </Include> <IncludeNotes> boolean </IncludeNotes> <Pagination> PaginationType <EntriesPerPage> int </EntriesPerPage> <PageNumber> int </PageNumber> </Pagination> <Sort> ItemSortTypeCodeType </Sort> </BidList> <DeletedFromSoldList> ItemListCustomizationType <DurationInDays> int </DurationInDays> <Include> boolean </Include> <IncludeNotes> boolean </IncludeNotes> <Sort> ItemSortTypeCodeType </Sort> </DeletedFromSoldList> <DeletedFromUnsoldList> ItemListCustomizationType <DurationInDays> int </DurationInDays> <Include> boolean </Include> <IncludeNotes> boolean </IncludeNotes> <Sort> ItemSortTypeCodeType </Sort> </DeletedFromUnsoldList> <ScheduledList> ItemListCustomizationType <Include> boolean </Include> <IncludeNotes> boolean </IncludeNotes> <Pagination> PaginationType <EntriesPerPage> int </EntriesPerPage> <PageNumber> int </PageNumber> </Pagination> <Sort> ItemSortTypeCodeType </Sort> </ScheduledList> <SellingSummary> ItemListCustomizationType <Include> boolean </Include> </SellingSummary> <SoldList> ItemListCustomizationType <DurationInDays> int </DurationInDays> <Include> boolean </Include> <IncludeNotes> boolean </IncludeNotes> <OrderStatusFilter> OrderStatusFilterCodeType </OrderStatusFilter> <Pagination> PaginationType <EntriesPerPage> int </EntriesPerPage> <PageNumber> int </PageNumber> </Pagination> <Sort> ItemSortTypeCodeType </Sort> </SoldList> <UnsoldList> ItemListCustomizationType <DurationInDays> int </DurationInDays> <Include> boolean </Include> <IncludeNotes> boolean </IncludeNotes> <Pagination> PaginationType <EntriesPerPage> int </EntriesPerPage> <PageNumber> int </PageNumber> </Pagination> <Sort> ItemSortTypeCodeType </Sort> </UnsoldList> </GetMyeBaySellingRequest>
| 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. • ReturnSummary (in) Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See "GetMyMessages" in the eBay Web Services Guide for a code sample that demonstrates this. (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 |
| ActiveList | ItemListCustomizationType | Optional |
Returns the list of items the user is actively selling (the currently active listings). Set Include to true to return the default response set. |
| ActiveList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
| ActiveList.IncludeNotes | boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| ActiveList.ListingType | ListingTypeCodeType | Optional |
Specifies the listing type of items in the returned list.
Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Auction (in/out) An optional input parameter used with GetMyeBaySelling. When used in the request, returns items of competitive-bid auctions (Chinese). • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) |
| ActiveList.Pagination | PaginationType | Optional |
Specifies how to create virtual pages in the returned list. Default for EntriesPerPage with GetMyeBayBuying is 200. |
|
ActiveList.Pagination .EntriesPerPage |
int | Optional | Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders). |
|
ActiveList.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. |
| ActiveList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| BidList | ItemListCustomizationType | Optional |
Return the list of active items on which there are bids. Set Include to true to return the default response set. |
| BidList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
| BidList.IncludeNotes | boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| BidList.Pagination | PaginationType | Optional |
Specifies how to create virtual pages in the returned list. Default for EntriesPerPage with GetMyeBayBuying is 200. |
|
BidList.Pagination .EntriesPerPage |
int | Optional | Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders). |
| BidList.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. |
| BidList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| DeletedFromSoldList | ItemListCustomizationType | Optional |
Returns the list of items the user sold, and then deleted from their My eBay page. Allowed values for DurationInDays are 0-90. Set Include to true to return the default response set. |
|
DeletedFromSoldList .DurationInDays |
int | Optional |
Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. Min: 0. Max: 60. |
| DeletedFromSoldList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
|
DeletedFromSoldList .IncludeNotes |
boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| DeletedFromSoldList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| DeletedFromUnsoldList | ItemListCustomizationType | Optional |
Returns the list of items the user either ended or did not sell, and subsequently were deleted them from their My eBay page. Allowed values for DurationInDays are 0-90. Set Include to true to return the default response set. |
|
DeletedFromUnsoldList .DurationInDays |
int | Optional |
Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. Min: 0. Max: 60. |
| DeletedFromUnsoldList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
|
DeletedFromUnsoldList .IncludeNotes |
boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| DeletedFromUnsoldList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| ScheduledList | ItemListCustomizationType | Optional |
Returns the list of items the user has scheduled to sell but whose listings have not yet opened. Set Include to true to return the default response set. |
| ScheduledList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
| ScheduledList.IncludeNotes | boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| ScheduledList.Pagination | PaginationType | Optional |
Specifies how to create virtual pages in the returned list. Default for EntriesPerPage with GetMyeBayBuying is 200. |
|
ScheduledList.Pagination .EntriesPerPage |
int | Optional | Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders). |
|
ScheduledList.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. |
| ScheduledList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| SellingSummary | ItemListCustomizationType | Optional |
Returns a summary of the user's buying activity. With a request version of 605 or higher, the selling summary container is not included in the response by default. Add a SellingSummary element in the request with an Include field set to true to receive a SellingSummary container in your response. With a request version lower than 605, the SellingSummary is always returned by default. Add a SellingSummary element with an Include field set to false to exclude the SellingSummary from your response. |
| SellingSummary.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
| SoldList | ItemListCustomizationType | Optional |
Returns the list of items the user has sold. Set Include to true to return the default response set. |
| SoldList.DurationInDays | int | Optional |
Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. Min: 0. Max: 60. |
| SoldList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
| SoldList.IncludeNotes | boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| SoldList.OrderStatusFilter | OrderStatusFilterCodeType | Optional |
Filter to reduce the SoldList response based on whether the seller (or eBay) marked the applicable transaction as Paid and/or Shipped in My eBay. (Sellers can use CompleteSale or the eBay Web site UI to mark a transaction as Paid or Shipped in My eBay. Sellers can also specify PaymentStatus in ReviseCheckoutStatus to mark a transaction as Paid or awaiting payment in My eBay.) Default: All. Applicable values: • All (in) All applicable sold listings, regardless of their Paid or Shipped status. • AwaitingPayment (in) Sold listings that have not yet been marked as Paid in My eBay. • AwaitingShipment (in) Sold listings that have not yet been marked as Shipped in My eBay. • CustomCode (in) Reserved for future or internal use. • PaidAndShipped (in) Sold listings that have been marked as Paid and Shipped in My eBay. |
| SoldList.Pagination | PaginationType | Optional |
Specifies how to create virtual pages in the returned list. Default for EntriesPerPage with GetMyeBayBuying is 200. |
|
SoldList.Pagination .EntriesPerPage |
int | Optional | Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders). |
| SoldList.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. |
| SoldList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| UnsoldList | ItemListCustomizationType | Optional |
Returns the list of items the user has listed, but whose listings have ended without being sold. Set Include to true to return the default response set. |
| UnsoldList.DurationInDays | int | Optional |
Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. Min: 0. Max: 60. |
| UnsoldList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
| UnsoldList.IncludeNotes | boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| UnsoldList.Pagination | PaginationType | Optional |
Specifies how to create virtual pages in the returned list. Default for EntriesPerPage with GetMyeBayBuying is 200. |
|
UnsoldList.Pagination .EntriesPerPage |
int | Optional | Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders). |
|
UnsoldList.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. |
| UnsoldList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| Input Detail Controls Samples Change History Top Errors for GetMyeBaySelling User Notes |
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"?>
<GetMyeBaySellingResponse 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 -->
<ActiveList> PaginatedItemArrayType
<ItemArray> ItemArrayType
<Item> ItemType
<BestOfferDetails> BestOfferDetailsType
<BestOfferCount> int </BestOfferCount>
</BestOfferDetails>
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
<eBayNotes> string </eBayNotes>
<ItemID> ItemIDType (string) </ItemID>
<LeadCount> int </LeadCount>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingDuration> token </ListingDuration>
<ListingType> ListingTypeCodeType </ListingType>
<NewLeadCount> int </NewLeadCount>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellingStatus> SellingStatusType
<BidCount> int </BidCount>
<BidderCount> long </BidderCount>
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<HighBidder> UserType
<FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
<FeedbackScore> int </FeedbackScore>
<UserID> UserIDType (string) </UserID>
</HighBidder>
<PromotionalSaleDetails> PromotionalSaleDetailsType
<EndTime> dateTime </EndTime>
<OriginalPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalPrice>
<StartTime> dateTime </StartTime>
</PromotionalSaleDetails>
<QuantitySold> int </QuantitySold>
<ReserveMet> boolean </ReserveMet>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<ShippingServiceOptions> ShippingServiceOptionsType
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
</ShippingDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
<VariationTitle> string </VariationTitle>
<WatchCount> long </WatchCount>
</Variation>
<!-- ... more Variation nodes here ... -->
</Variations>
<WatchCount> long </WatchCount>
</Item>
<!-- ... more Item nodes here ... -->
</ItemArray>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
</ActiveList>
<BidList> PaginatedItemArrayType
<ItemArray> ItemArrayType
<Item> ItemType
<BiddingDetails> BiddingDetailsType
<BidAssistant> boolean </BidAssistant>
<ConvertedMaxBid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedMaxBid>
<MaxBid currencyID="CurrencyCodeType"> AmountType (double) </MaxBid>
<QuantityBid> int </QuantityBid>
<QuantityWon> int </QuantityWon>
</BiddingDetails>
<ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<Seller> UserType
<FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
<FeedbackScore> int </FeedbackScore>
<UserID> UserIDType (string) </UserID>
</Seller>
<SellingStatus> SellingStatusType
<BidCount> int </BidCount>
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<HighBidder> UserType
<FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
<FeedbackScore> int </FeedbackScore>
<UserID> UserIDType (string) </UserID>
</HighBidder>
<ReserveMet> boolean </ReserveMet>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<ShippingServiceOptions> ShippingServiceOptionsType
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
<ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
</ShippingDetails>
<Site> SiteCodeType </Site>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<WatchCount> long </WatchCount>
</Item>
<!-- ... more Item nodes here ... -->
</ItemArray>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
</BidList>
<DeletedFromSoldList> PaginatedOrderTransactionArrayType
<OrderTransactionArray> OrderTransactionArrayType
<OrderTransaction> OrderTransactionType
<Order> OrderType
<OrderID> OrderIDType (string) </OrderID>
<Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal>
<TransactionArray> TransactionArrayType
<Transaction> TransactionType
<Buyer> UserType
<BuyerInfo> BuyerType
<ShippingAddress> AddressType
<PostalCode> string </PostalCode>
</ShippingAddress>
</BuyerInfo>
<Email> string </Email>
<UserID> UserIDType (string) </UserID>
</Buyer>
<CreatedDate> dateTime </CreatedDate>
<FeedbackLeft> FeedbackInfoType
<CommentType> CommentTypeCodeType </CommentType>
</FeedbackLeft>
<FeedbackReceived> FeedbackInfoType
<CommentType> CommentTypeCodeType </CommentType>
</FeedbackReceived>
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellingStatus> SellingStatusType
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<QuantitySold> int </QuantitySold>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<ShippingServiceOptions> ShippingServiceOptionsType
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
</ShippingDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
<VariationTitle> string </VariationTitle>
<WatchCount> long </WatchCount>
</Variation>
<!-- ... more Variation nodes here ... -->
</Variations>
<WatchCount> long </WatchCount>
</Item>
<PaidTime> dateTime </PaidTime>
<PaisaPayID> string </PaisaPayID>
<Platform> TransactionPlatformCodeType </Platform>
<QuantityPurchased> int </QuantityPurchased>
<SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
<ShippedTime> dateTime </ShippedTime>
<Status> TransactionStatusType
<PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
</Status>
<TransactionID> string </TransactionID>
</Transaction>
<!-- ... more Transaction nodes here ... -->
</TransactionArray>
</Order>
<Transaction> TransactionType
<Buyer> UserType
<BuyerInfo> BuyerType
<ShippingAddress> AddressType
<PostalCode> string </PostalCode>
</ShippingAddress>
</BuyerInfo>
<Email> string </Email>
<UserID> UserIDType (string) </UserID>
</Buyer>
<CreatedDate> dateTime </CreatedDate>
<FeedbackLeft> FeedbackInfoType
<CommentType> CommentTypeCodeType </CommentType>
</FeedbackLeft>
<FeedbackReceived> FeedbackInfoType
<CommentType> CommentTypeCodeType </CommentType>
</FeedbackReceived>
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellingStatus> SellingStatusType
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<QuantitySold> int </QuantitySold>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<ShippingServiceOptions> ShippingServiceOptionsType
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
</ShippingDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
<VariationTitle> string </VariationTitle>
<WatchCount> long </WatchCount>
</Variation>
<!-- ... more Variation nodes here ... -->
</Variations>
<WatchCount> long </WatchCount>
</Item>
<PaidTime> dateTime </PaidTime>
<PaisaPayID> string </PaisaPayID>
<Platform> TransactionPlatformCodeType </Platform>
<QuantityPurchased> int </QuantityPurchased>
<SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
<ShippedTime> dateTime </ShippedTime>
<Status> TransactionStatusType
<PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
</Status>
<TransactionID> string </TransactionID>
</Transaction>
</OrderTransaction>
<!-- ... more OrderTransaction nodes here ... -->
</OrderTransactionArray>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
</DeletedFromSoldList>
<DeletedFromUnsoldList> PaginatedItemArrayType
<ItemArray> ItemArrayType
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellingStatus> SellingStatusType
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<QuantitySold> int </QuantitySold>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<ShippingServiceOptions> ShippingServiceOptionsType
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
</ShippingDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
<VariationTitle> string </VariationTitle>
<WatchCount> long </WatchCount>
</Variation>
<!-- ... more Variation nodes here ... -->
</Variations>
<WatchCount> long </WatchCount>
</Item>
<!-- ... more Item nodes here ... -->
</ItemArray>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
</DeletedFromUnsoldList>
<ScheduledList> PaginatedItemArrayType
<ItemArray> ItemArrayType
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
<eBayNotes> string </eBayNotes>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingDuration> token </ListingDuration>
<ListingType> ListingTypeCodeType </ListingType>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellingStatus> SellingStatusType
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<QuantitySold> int </QuantitySold>
<ReserveMet> boolean </ReserveMet>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<ShippingServiceOptions> ShippingServiceOptionsType
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
<ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
</ShippingDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
<VariationTitle> string </VariationTitle>
<WatchCount> long </WatchCount>
</Variation>
<!-- ... more Variation nodes here ... -->
</Variations>
<WatchCount> long </WatchCount>
</Item>
<!-- ... more Item nodes here ... -->
</ItemArray>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
</ScheduledList>
<SellingSummary> SellingSummaryType
<ActiveAuctionCount> int </ActiveAuctionCount>
<AuctionBidCount> int </AuctionBidCount>
<AuctionSellingCount> int </AuctionSellingCount>
<SoldDurationInDays> int </SoldDurationInDays>
<TotalAuctionSellingValue currencyID="CurrencyCodeType"> AmountType (double) </TotalAuctionSellingValue>
<TotalSoldCount> int </TotalSoldCount>
<TotalSoldValue currencyID="CurrencyCodeType"> AmountType (double) </TotalSoldValue>
</SellingSummary>
<SoldList> PaginatedOrderTransactionArrayType
<OrderTransactionArray> OrderTransactionArrayType
<OrderTransaction> OrderTransactionType
<Order> OrderType
<OrderID> OrderIDType (string) </OrderID>
<Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal>
<TransactionArray> TransactionArrayType
<Transaction> TransactionType
<Buyer> UserType
<BuyerInfo> BuyerType
<ShippingAddress> AddressType
<PostalCode> string </PostalCode>
</ShippingAddress>
</BuyerInfo>
<Email> string </Email>
<UserID> UserIDType (string) </UserID>
</Buyer>
<CreatedDate> dateTime </CreatedDate>
<FeedbackLeft> FeedbackInfoType
<CommentType> CommentTypeCodeType </CommentType>
</FeedbackLeft>
<FeedbackReceived> FeedbackInfoType
<CommentType> CommentTypeCodeType </CommentType>
</FeedbackReceived>
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellingStatus> SellingStatusType
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<QuantitySold> int </QuantitySold>
<ReserveMet> boolean </ReserveMet>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<ShippingServiceOptions> ShippingServiceOptionsType
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
</ShippingDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
<VariationTitle> string </VariationTitle>
<WatchCount> long </WatchCount>
</Variation>
<!-- ... more Variation nodes here ... -->
</Variations>
<WatchCount> long </WatchCount>
</Item>
<PaidTime> dateTime </PaidTime>
<PaisaPayID> string </PaisaPayID>
<Platform> TransactionPlatformCodeType </Platform>
<QuantityPurchased> int </QuantityPurchased>
<SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
<ShippedTime> dateTime </ShippedTime>
<Status> TransactionStatusType
<PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
</Status>
<TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
<TransactionID> string </TransactionID>
</Transaction>
<!-- ... more Transaction nodes here ... -->
</TransactionArray>
</Order>
<Transaction> TransactionType
<Buyer> UserType
<BuyerInfo> BuyerType
<ShippingAddress> AddressType
<PostalCode> string </PostalCode>
</ShippingAddress>
</BuyerInfo>
<Email> string </Email>
<UserID> UserIDType (string) </UserID>
</Buyer>
<CreatedDate> dateTime </CreatedDate>
<FeedbackLeft> FeedbackInfoType
<CommentType> CommentTypeCodeType </CommentType>
</FeedbackLeft>
<FeedbackReceived> FeedbackInfoType
<CommentType> CommentTypeCodeType </CommentType>
</FeedbackReceived>
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellingStatus> SellingStatusType
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<QuantitySold> int </QuantitySold>
<ReserveMet> boolean </ReserveMet>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<ShippingServiceOptions> ShippingServiceOptionsType
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
</ShippingDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
<VariationTitle> string </VariationTitle>
<WatchCount> long </WatchCount>
</Variation>
<!-- ... more Variation nodes here ... -->
</Variations>
<WatchCount> long </WatchCount>
</Item>
<PaidTime> dateTime </PaidTime>
<PaisaPayID> string </PaisaPayID>
<Platform> TransactionPlatformCodeType </Platform>
<QuantityPurchased> int </QuantityPurchased>
<SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
<ShippedTime> dateTime </ShippedTime>
<Status> TransactionStatusType
<PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
</Status>
<TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice>
<TransactionID> string </TransactionID>
</Transaction>
</OrderTransaction>
<!-- ... more OrderTransaction nodes here ... -->
</OrderTransactionArray>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
</SoldList>
<Summary> MyeBaySellingSummaryType
<ActiveAuctionCount> int </ActiveAuctionCount>
<AuctionBidCount> int </AuctionBidCount>
<AuctionSellingCount> int </AuctionSellingCount>
<ClassifiedAdCount> int </ClassifiedAdCount>
<ClassifiedAdOfferCount> int </ClassifiedAdOfferCount>
<SoldDurationInDays> int </SoldDurationInDays>
<TotalAuctionSellingValue currencyID="CurrencyCodeType"> AmountType (double) </TotalAuctionSellingValue>
<TotalLeadCount> int </TotalLeadCount>
<TotalListingsWithLeads> int </TotalListingsWithLeads>
<TotalSoldCount> int </TotalSoldCount>
<TotalSoldValue currencyID="CurrencyCodeType"> AmountType (double) </TotalSoldValue>
</Summary>
<UnsoldList> PaginatedItemArrayType
<ItemArray> ItemArrayType
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee>
<eBayNotes> string </eBayNotes>
<ItemID> ItemIDType (string) </ItemID>
<LeadCount> int </LeadCount>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingDuration> token </ListingDuration>
<ListingType> ListingTypeCodeType </ListingType>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<Relisted> boolean </Relisted>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellingStatus> SellingStatusType
<BidCount> int </BidCount>
<BidderCount> long </BidderCount>
<ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice>
<CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice>
<QuantitySold> int </QuantitySold>
<ReserveMet> boolean </ReserveMet>
</SellingStatus>
<ShippingDetails> ShippingDetailsType
<ShippingServiceOptions> ShippingServiceOptionsType
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes here ... -->
</ShippingDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value nodes here ... -->
</NameValueList>
<!-- ... more NameValueList nodes here ... -->
</VariationSpecifics>
<VariationTitle> string </VariationTitle>
<WatchCount> long </WatchCount>
</Variation>
<!-- ... more Variation nodes here ... -->
</Variations>
<WatchCount> long </WatchCount>
</Item>
<!-- ... more Item nodes here ... -->
</ItemArray>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
</UnsoldList>
</GetMyeBaySellingResponse>
| 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 |
| ActiveList | PaginatedItemArrayType | Conditionally |
Contains the items the user is selling that have active listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray | ItemArrayType | Conditionally |
Contains a list of Item types.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item | ItemType | Conditionally,
repeatable: [0..*] |
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has a transactional relationship with that buyer. For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .BestOfferDetails |
BestOfferDetailsType | Conditionally |
Container for BestOffer properties associated with the item. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .BestOfferDetails .BestOfferCount |
int | Conditionally |
The number of best offers made for this item, if any. In other words, if there are no offers made, this container will not appear in the response.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .BuyItNowPrice |
AmountType (double) | Conditionally |
For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. Once a Chinese auction has bids (and the high bid exceeds the reserve price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| ActiveList.ItemArray.Item .BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .ClassifiedAdPayPerLeadFee |
AmountType (double) | Conditionally |
The email and phone lead fee for a pay-per-lead item.
DetailLevel: ReturnAll. |
| ActiveList.ItemArray.Item .ClassifiedAdPayPerLeadFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .eBayNotes |
string | Conditionally |
Returns a note from eBay displayed below items in the user's My eBay account. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .ItemID |
ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .LeadCount |
int | Conditionally |
Specifies the number of leads (emails) buyers have posted about the item. You must be the seller of the item to retrieve the lead count.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .ListingDuration |
token | Conditionally |
Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time. The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable). The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information. When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours. Required for Half.com (but only specify GTC). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
Applicable values: See ListingDurationCodeType |
|
ActiveList.ItemArray.Item .ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese auction) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611.
• Express Deprecated as of version 561.
• FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601.
• PersonalOffer (out) 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. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .NewLeadCount |
int | Conditionally |
Specifies the number of new leads (unanswered emails) buyers have posted about the item.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .PictureDetails.GalleryURL |
anyURI | Conditionally |
URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
ActiveList.ItemArray.Item .Quantity |
int | Conditionally |
This meaning of this value depends on the context. For AddItem and related calls: Specify the number of identical items the seller has available for sale in this listing. For auctions (with competitive bidding), Quantity must be 1. For certain other formats (e.g., fixed-price) the Quantity can be 1 or more. See the eBay Web site online help to learn which selling formats support multi-quantity sales. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.Quantity for each variation instead. For ReviseItem and ReviseFixedPriceItem: When you revise a listing (with no variations), you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, on sites that support multi-quantity auctions (Dutch auctions), if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. In multi-variation listings, this value is the sum of all the variation quantities in the listing. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. For transaction calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
ActiveList.ItemArray.Item .ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support reserve prices. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the eBay Web Services guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the eBay Web Services guide for validation rules when revising US Motors listings. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| ActiveList.ItemArray.Item .ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.BidCount |
int | Conditionally |
Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.BidderCount |
long | Conditionally |
Number of bidders for an item. Only applicable to competitive-bid item listings (Chinese auctions). Only returned for the seller of the item.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .SellingStatus.CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .SellingStatus.HighBidder |
UserType | Conditionally |
For ended Chinese auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, basic fixed price (FixedPriceItem) and ended Store Inventory (StoresFixedPrice) listings, this field is a container for the user ID of the purchaser. This field isn't returned for auctions with no bids, or for active fixed price listings, or for active Store Inventory listings. In the case of PlaceOffer, for chinese auctions, this field is a container for the high bidder's user ID. In the PlaceOffer response, the following applies: For multiple-quantity, fixed-price listings, the high bidder is only returned if there is just one transaction (or only for the first transaction that is created).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.HighBidder .FeedbackRatingStar |
FeedbackRatingStarCodeType | Conditionally |
Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.
Applicable values: • Blue (out) Blue Star, feedback score 50-99. • CustomCode (out) Reserved for internal or future use. • Green (out) Green Star, feedback score 5,000-9,999. • GreenShooting (out) Green Shooting Star, feedback score 500,000-999,999. • None (out) No graphic displayed, feedback score 0-9. • Purple (out) Purple Star, feedback score 500-999. • PurpleShooting (out) Purple Shooting Star, feedback score 50,000-99,999. • Red (out) Red Star, feedback score 1,000-4,999 • RedShooting (out) Red Shooting Star, feedback score 100,000-499,999. • SilverShooting (out) Silver Shooting Star, feedback score 1,000,000 and above. • Turquoise (out) Turquoise Star, feedback score 100-499. • TurquoiseShooting (out) Turquoise Shooting Star, feedback score 25,000-49,999. • Yellow (out) Yellow Star, feedback score 10-49. • YellowShooting (out) Yellow Shooting Star, feedback score 10,000-24,999. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.HighBidder .FeedbackScore |
int | Conditionally |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.HighBidder .UserID |
UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized. For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus .PromotionalSaleDetails |
PromotionalSaleDetailsType | Conditionally |
If a seller has reduced the price of a listed item with the Promotional Price Display feature, this field contains the original price of the discounted item, along with the start-time and end-time of the discount.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus .PromotionalSaleDetails .EndTime |
dateTime | Conditionally |
End time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus .PromotionalSaleDetails .OriginalPrice |
AmountType (double) | Conditionally |
Original price of an item whose price a seller has reduced with the Promotional Price Display feature.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .SellingStatus .PromotionalSaleDetails .OriginalPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .SellingStatus .PromotionalSaleDetails .StartTime |
dateTime | Conditionally |
Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.ReserveMet |
boolean | Conditionally |
Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| ActiveList.ItemArray.Item.SKU | SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after a transaction is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
ActiveList.ItemArray.Item .StartPrice |
AmountType (double) | Conditionally |
The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction-type listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings: This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items--it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one transaction can contain multiple items from a single variation.) For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no transactions, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0. As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing. For GetItem and related calls Only returned when a listing has variations. For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified. For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .PrivateNotes |
string | Conditionally |
A note a user makes on an item with variations in My eBay. For eBay.com, only GetMyeBaySelling (not GetItem) returns this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseFixedPriceItem. Use SetUserNotes instead. In SoldList, notes for variations are only returned at the Item level, not the variation level. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation.Quantity |
int | Conditionally |
For AddFixedPriceItem and related calls: On input, this should be the number of items available for sale that are associated with this variation. If you set Quantity to zero when you create a new listing (or relist), the variation is dropped from the listing. For GetItem and related calls: On output, this is the total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract QuantitySold from this value. For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding transactions. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. Only returned if the seller specified a SKU for the variation. Max length: 70. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditionally |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can't add or change names or values in variation specifics (because the set of variation specifics serves as a unique identifier). However, you can delete or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (transactions). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify variations in transactions (for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
| ActiveList.PaginationResult | PaginationResultType | Conditionally |
Provides information about the list, including number of pages and number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.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. |
|
ActiveList.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. |
| BidList | PaginatedItemArrayType | Conditionally |
Contains the seller's active listings with bids. Only returned if items exist that meet the request criteria.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray | ItemArrayType | Conditionally |
Contains a list of Item types.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray.Item | ItemType | Conditionally,
repeatable: [0..*] |
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has a transactional relationship with that buyer. For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .BiddingDetails |
BiddingDetailsType | Conditionally |
Detailed information about a bid. For GetMyeBayBuying, returned as a self-closed element if no bids meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .BiddingDetails.BidAssistant |
boolean | Conditionally |
Indicates whether the current bid was placed by BidAssistant. Only returns if true.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .BiddingDetails .ConvertedMaxBid |
AmountType (double) | Conditionally |
Converted value of the amount in MaxBidAmount, in the currency indicated by SiteCurrency. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Under conditions where this value would be N/A on the eBay site, this element is not returned at all.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray.Item .BiddingDetails .ConvertedMaxBid [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
BidList.ItemArray.Item .BiddingDetails.MaxBid |
AmountType (double) | Conditionally |
Indicates the maximum amount the user has agreed to pay for the item when the user last submitted a bid. Under conditions where this value would be N/A on the eBay site, this element is not returned at all.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray.Item .BiddingDetails.MaxBid [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
BidList.ItemArray.Item .BiddingDetails.QuantityBid |
int | Conditionally |
Number of items from the listing the user agreed to purchase with a bid. For single-item listings, always 1. For multi-item (Dutch) listings, the value will be between 1 and the number of items offered in the auction, indicating the number of items purchased so far. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .BiddingDetails.QuantityWon |
int | Conditionally |
Used mainly for multi-item auctions (Dutch). For an active listing, indicates the number of items the user stands to win if their bid wins. For a listing that has ended, indicates the number of items the user actually won. In both cases, the number may be less than that returned in QuantityBid, the user with the lowest winning bid in a Dutch auction might not win all the items on which they bid. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .ClassifiedAdPayPerLeadFee |
AmountType (double) | Conditionally |
The email and phone lead fee for a pay-per-lead item.
DetailLevel: ReturnAll. |
| BidList.ItemArray.Item .ClassifiedAdPayPerLeadFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| BidList.ItemArray.Item.ItemID | ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray.Item .ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
BidList.ItemArray.Item .ListingDetails.EndTime |
dateTime | Conditionally |
Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended. In GetSearchResults, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times. In GetSearchResults, the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese auction) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611.
• Express Deprecated as of version 561.
• FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601.
• PersonalOffer (out) 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. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
BidList.ItemArray.Item .PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .PictureDetails.GalleryURL |
anyURI | Conditionally |
URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
BidList.ItemArray.Item .PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
BidList.ItemArray.Item .QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
| BidList.ItemArray.Item.Seller | UserType | Conditionally |
Container for information about this listing's seller. Not applicable to Half.com. Returned by GetItemsAwaitingFeedback if Buyer is making the request. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item.Seller .FeedbackRatingStar |
FeedbackRatingStarCodeType | Conditionally |
Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.
Applicable values: • Blue (out) Blue Star, feedback score 50-99. • CustomCode (out) Reserved for internal or future use. • Green (out) Green Star, feedback score 5,000-9,999. • GreenShooting (out) Green Shooting Star, feedback score 500,000-999,999. • None (out) No graphic displayed, feedback score 0-9. • Purple (out) Purple Star, feedback score 500-999. • PurpleShooting (out) Purple Shooting Star, feedback score 50,000-99,999. • Red (out) Red Star, feedback score 1,000-4,999 • RedShooting (out) Red Shooting Star, feedback score 100,000-499,999. • SilverShooting (out) Silver Shooting Star, feedback score 1,000,000 and above. • Turquoise (out) Turquoise Star, feedback score 100-499. • TurquoiseShooting (out) Turquoise Shooting Star, feedback score 25,000-49,999. • Yellow (out) Yellow Star, feedback score 10-49. • YellowShooting (out) Yellow Shooting Star, feedback score 10,000-24,999. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item.Seller .FeedbackScore |
int | Conditionally |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item.Seller .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. |
|
BidList.ItemArray.Item .SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .SellingStatus.BidCount |
int | Conditionally |
Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray.Item .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
BidList.ItemArray.Item .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray.Item .SellingStatus.CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
BidList.ItemArray.Item .SellingStatus.HighBidder |
UserType | Conditionally |
For ended Chinese auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, basic fixed price (FixedPriceItem) and ended Store Inventory (StoresFixedPrice) listings, this field is a container for the user ID of the purchaser. This field isn't returned for auctions with no bids, or for active fixed price listings, or for active Store Inventory listings. In the case of PlaceOffer, for chinese auctions, this field is a container for the high bidder's user ID. In the PlaceOffer response, the following applies: For multiple-quantity, fixed-price listings, the high bidder is only returned if there is just one transaction (or only for the first transaction that is created).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .SellingStatus.HighBidder .FeedbackRatingStar |
FeedbackRatingStarCodeType | Conditionally |
Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.
Applicable values: • Blue (out) Blue Star, feedback score 50-99. • CustomCode (out) Reserved for internal or future use. • Green (out) Green Star, feedback score 5,000-9,999. • GreenShooting (out) Green Shooting Star, feedback score 500,000-999,999. • None (out) No graphic displayed, feedback score 0-9. • Purple (out) Purple Star, feedback score 500-999. • PurpleShooting (out) Purple Shooting Star, feedback score 50,000-99,999. • Red (out) Red Star, feedback score 1,000-4,999 • RedShooting (out) Red Shooting Star, feedback score 100,000-499,999. • SilverShooting (out) Silver Shooting Star, feedback score 1,000,000 and above. • Turquoise (out) Turquoise Star, feedback score 100-499. • TurquoiseShooting (out) Turquoise Shooting Star, feedback score 25,000-49,999. • Yellow (out) Yellow Star, feedback score 10-49. • YellowShooting (out) Yellow Shooting Star, feedback score 10,000-24,999. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .SellingStatus.HighBidder .FeedbackScore |
int | Conditionally |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .SellingStatus.HighBidder .UserID |
UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID stays the same for every auction. For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized. For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .SellingStatus.ReserveMet |
boolean | Conditionally |
Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
BidList.ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
BidList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
BidList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingSurcharge |
AmountType (double) | Conditionally | An additional fee to charge US buyers who ship via UPS to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some transactions in an order have a surcharge, surcharge is added only for those transactions. Flat rate shipping only. |
| BidList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingSurcharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| BidList.ItemArray.Item.Site | SiteCodeType | Conditionally |
The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing. When you specify Item.Site in AddItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API). Not applicable to Half.com. Applicable values: See Site. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| BidList.ItemArray.Item.SKU | SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after a transaction is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
BidList.ItemArray.Item .StartPrice |
AmountType (double) | Conditionally |
The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction-type listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings: This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items--it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray.Item .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
BidList.ItemArray.Item .TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| BidList.ItemArray.Item.Title | string | Conditionally |
Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.ItemArray.Item .WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
| BidList.PaginationResult | PaginationResultType | Conditionally |
Provides information about the list, including number of pages and number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
BidList.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. |
|
BidList.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. |
| DeletedFromSoldList | PaginatedOrderTransactionArrayType | Conditionally |
Contains the items the seller has sold and deleted from My eBay.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray |
OrderTransactionArrayType | Conditionally |
Contains the list of orders, transactions, or both.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction |
OrderTransactionType | Conditionally,
repeatable: [0..*] |
The individual order or transaction.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order |
OrderType | Conditionally |
Contains the information describing an order.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .OrderID |
OrderIDType (string) | Conditionally |
Unique identifier that eBay generates for the order. For calls like GetItemTransactions (and the Checkout notification), no OrderID will appear when only 1 item is purchased in a single end-to-end checkout flow (because the transaction would not be part of an order in this case). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .Subtotal |
AmountType (double) | Conditionally |
The sum of the sale prices of all of the transactions in the order, where a transaction sale price is the item sale price times the quantity sold. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .Subtotal [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray |
TransactionArrayType | Conditionally |
The set of two or more transactions that make up the order. We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.) Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction |
TransactionType | Conditionally,
repeatable: [0..*] |
Information about one transaction. Also applicable to Half.com (for GetOrders).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer |
UserType | Conditionally |
Contains the data for the transaction's buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if Seller is making the request. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.BuyerInfo |
BuyerType | Conditionally |
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.BuyerInfo .ShippingAddress |
AddressType | Conditionally |
Contains the address of the buyer in the transaction, to which the seller would ship the item(s). See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.BuyerInfo .ShippingAddress.PostalCode |
string | Conditionally |
User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Max length: 12. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .CreatedDate |
dateTime | Conditionally |
Indicates when the transaction was created. For fixed-price, Stores, and BIN items this indicates when the purchase (or BIN) occurred. For competitive-bid item listing types this indicates when listing ended, the winning bidder(s) determined, and the transaction created. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackLeft |
FeedbackInfoType | Conditionally |
A container for feedback information left FOR the user's transaction partner. Only returned if feedback was left for a transaction. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackLeft.CommentType |
CommentTypeCodeType | Conditionally |
Rating of the feedback being left (e.g., Positive). Sellers cannot leave neutral or negative feedback for buyers.
Applicable values: • CustomCode (in/out) Reserved for internal or future use. • IndependentlyWithdrawn (in/out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. • Negative (in/out) Negative feedback. Decreases total feedback score. • Neutral (in/out) Neutral feedback. No effect on total feedback score. • Positive (in/out) Positive feedback. Increases total feedback score. • Withdrawn (in/out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackReceived |
FeedbackInfoType | Conditionally |
A container for feedback information left BY the user's transaction partner. Only returned if feedback was left for a transaction. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackReceived.CommentType |
CommentTypeCodeType | Conditionally |
Rating of the feedback being left (e.g., Positive). Sellers cannot leave neutral or negative feedback for buyers.
Applicable values: • CustomCode (in/out) Reserved for internal or future use. • IndependentlyWithdrawn (in/out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. • Negative (in/out) Negative feedback. Decreases total feedback score. • Neutral (in/out) Neutral feedback. No effect on total feedback score. • Positive (in/out) Positive feedback. Increases total feedback score. • Withdrawn (in/out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item |
ItemType | Conditionally |
Information about the item that spawned the transaction. It is a purchase from this item's listing that the transaction represents. To remove a property from an item, specify it in ModifyType as a changed property, but do not give it a value in Item. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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:
|
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item .ClassifiedAdPayPerLeadFee |
AmountType (double) | Conditionally |
The email and phone lead fee for a pay-per-lead item.
DetailLevel: ReturnAll. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item .ClassifiedAdPayPerLeadFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese auction) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611.
• Express Deprecated as of version 561.
• FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601.
• PersonalOffer (out) 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. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PictureDetails .GalleryURL |
anyURI | Conditionally |
URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Quantity |
int | Conditionally |
This meaning of this value depends on the context. For AddItem and related calls: Specify the number of identical items the seller has available for sale in this listing. For auctions (with competitive bidding), Quantity must be 1. For certain other formats (e.g., fixed-price) the Quantity can be 1 or more. See the eBay Web site online help to learn which selling formats support multi-quantity sales. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.Quantity for each variation instead. For ReviseItem and ReviseFixedPriceItem: When you revise a listing (with no variations), you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, on sites that support multi-quantity auctions (Dutch auctions), if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. In multi-variation listings, this value is the sum of all the variation quantities in the listing. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. For transaction calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support reserve prices. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the eBay Web Services guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the eBay Web Services guide for validation rules when revising US Motors listings. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .CurrentPrice |
AmountType (double) | Conditionally |
For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after a transaction is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.StartPrice |
AmountType (double) | Conditionally |
The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction-type listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings: This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items--it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one transaction can contain multiple items from a single variation.) For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no transactions, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0. As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing. For GetItem and related calls Only returned when a listing has variations. For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified. For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .Quantity |
int | Conditionally |
For AddFixedPriceItem and related calls: On input, this should be the number of items available for sale that are associated with this variation. If you set Quantity to zero when you create a new listing (or relist), the variation is dropped from the listing. For GetItem and related calls: On output, this is the total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract QuantitySold from this value. For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding transactions. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. Only returned if the seller specified a SKU for the variation. Max length: 70. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditionally |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can't add or change names or values in variation specifics (because the set of variation specifics serves as a unique identifier). However, you can delete or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (transactions). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify variations in transactions (for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .PaidTime |
dateTime | Conditionally |
Indicates the time when the transaction was marked paid. There are many ways to mark a transaction as paid. eBay sets it when payment is made via PayPal. A seller can mark an item as paid in My eBay or Selling Manager Pro. An application can use ReviseCheckoutStatus or CompleteSale on behalf of the seller. Note: This value is only visible to the user if the request user is the buyer or seller associated with the transaction. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .PaisaPayID |
string | Conditionally | Specifies the PaisaPayID using which the Item was paid for. Applicable for India site(203) only. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Platform |
TransactionPlatformCodeType | Conditionally |
Name of the eBay co-branded site upon which the transaction was made.
Applicable values: • CustomCode (in/out) Reserved for future use. • eBay (in/out) The transaction was created (i.e., the purchase was made) on the main eBay site. • Express (in/out) The transaction was created on the eBay Express site. • Half (in/out) The transaction was created on Half.com site. • Shopping (in/out) The transaction was created on the Shopping.com site. • WorldOfGood (in/out) The transaction was created on the WorldOfGood site. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .QuantityPurchased |
int | Conditionally |
Indicates the number of items the buyer purchased from the listing identified in ItemID. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .SellerPaidStatus |
PaidStatusCodeType | Conditionally |
Specifies the transaction's payment status, as seen by the seller. Returned in lists of sold items. Not applicable to Half.com. Applicable values: • BuyerHasNotCompletedCheckout (out) The buyer has not completed the checkout process and so has not made payment. • CustomCode (out) Reserved for future use. • EscrowPaymentCancelled (out) The buyer has made an escrow payment, but has cancelled the payment. • MarkedAsPaid (out) The transaction is marked as paid by either buyer or seller. • NotPaid (out) The buyer has not completed checkout, but has not paid through PayPal or PaisaPay (but please also see the documentation for PaymentHoldStatus and its applicable values). The buyer might have paid using another method, but the payment might not have been received or cleared. Important: Please see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment. • PaidCOD (out) PaidCOD • PaidWithEscrow (out) The buyer has made an escrow payment, and the seller has received payment. • PaidWithPaisaPay (out) The buyer has paid with PaisaPay, and the payment is complete. • PaidWithPaisaPayEscrow (out) Paid With PaisaPay Escrow • PaidWithPayPal (out) The buyer has made a PayPal payment, and the payment is complete. But please also see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment. • PaisaPayNotPaid (out) Paisa Pay Not Paid • PaymentPending (out) The buyer has made a payment other than PayPal, escrow, or PaisaPay, but the payment is still being processed. • PaymentPendingWithEscrow (out) The buyer has made an escrow payment, but the seller has not yet received it. • PaymentPendingWithPaisaPay (out) The buyer has paid with PaisaPay, but the payment is still being processed. The seller has not yet received payment. • PaymentPendingWithPaisaPayEscrow (out) Payment Pending With PaisaPay Escrow • PaymentPendingWithPayPal (out) The buyer has made a PayPal payment, but the seller has not yet received it. • Refunded (out) Refunded • WaitingForCODPayment (out) WaitingForCODPayment DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .ShippedTime |
dateTime | Conditionally |
Indicates the time when the item(s) associated with the transaction were marked as shipped, if known. The value is set when the seller uses shipment tracking features offered by eBay or an eBay partner. This value is also set when the seller marks the item as shipped by using CompleteSale. If the seller is a Selling Manager Pro user, they can also mark the item as shipped by using My eBay. Note that this value is only visible if the request user is the buyer or seller associated with the transaction. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Status |
TransactionStatusType | Conditionally |
Contains the status of the transaction, such as the buyer's online payment and whether the checkout process for the transaction has been completed. See TransactionStatusType for its child elements. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Status.PaymentHoldStatus |
PaymentHoldStatusCodeType | Conditionally |
Contains the current status of a hold on a PayPal payment. The payment hold that is referred to as a "payment review" hold results from a possible issue with a buyer. The payment hold referred to as a "merchant hold" results from a possible issue with a seller. For more information, please see the link below. Additionally, in the cases of the GetMyeBaySelling and GetMyeBayBuying calls, the PaymentHoldStatus value can affect the value returned in in SellerPaidStatus and BuyerPaidStatus; see the PaymentHoldStatus applicable values.
Applicable values: • CustomCode (out) Reserved for internal or future use. • MerchantHold (out) The payment hold referred to as a "merchant hold" results from a possible issue with a seller. If this value is returned, then the following values, as a result, will be returned: In GetMyeBaySelling, PaidWithPayPal is returned in TransactionArray.Transaction.SellerPaidStatus. In GetMyeBayBuying, PaidWithPayPal is returned in TransactionArray.Transaction.BuyerPaidStatus. • None (out) Indicates that there is no payment review hold and no merchant hold. • PaymentReview (out) The payment hold referred to as a "payment review" hold results from a possible issue with a buyer. If this value is returned, then the following values, as a result, will be returned: In GetMyeBaySelling, NotPaid is returned in TransactionArray.Transaction.SellerPaidStatus. In GetMyeBayBuying, PaidWithPayPal is returned in TransactionArray.Transaction.BuyerPaidStatus. • Released (out) Indicates that a payment hold has been released. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TransactionID |
string | Conditionally |
Identifier for the transaction. A value of zero is used for the Chinese auction format. Thus, a value of zero is a valid transaction ID. A transaction ID is only unique to the listing that spawned it, so a transaction is only uniquely identified on a global basis by a combination of ItemID and TransactionID. Applicable to Half.com (for GetOrders only). Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction |
TransactionType | Conditionally |
Contains the information describing a transaction.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer |
UserType | Conditionally |
Contains the data for the transaction's buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if Seller is making the request. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer.BuyerInfo |
BuyerType | Conditionally |
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer.BuyerInfo .ShippingAddress |
AddressType | Conditionally |
Contains the address of the buyer in the transaction, to which the seller would ship the item(s). See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer.BuyerInfo .ShippingAddress.PostalCode |
string | Conditionally |
User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Max length: 12. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .CreatedDate |
dateTime | Conditionally |
Indicates when the transaction was created. For fixed-price, Stores, and BIN items this indicates when the purchase (or BIN) occurred. For competitive-bid item listing types this indicates when listing ended, the winning bidder(s) determined, and the transaction created. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .FeedbackLeft |
FeedbackInfoType | Conditionally |
A container for feedback information left FOR the user's transaction partner. Only returned if feedback was left for a transaction. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .FeedbackLeft.CommentType |
CommentTypeCodeType | Conditionally |
Rating of the feedback being left (e.g., Positive). Sellers cannot leave neutral or negative feedback for buyers.
Applicable values: • CustomCode (in/out) Reserved for internal or future use. • IndependentlyWithdrawn (in/out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. • Negative (in/out) Negative feedback. Decreases total feedback score. • Neutral (in/out) Neutral feedback. No effect on total feedback score. • Positive (in/out) Positive feedback. Increases total feedback score. • Withdrawn (in/out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .FeedbackReceived |
FeedbackInfoType | Conditionally |
A container for feedback information left BY the user's transaction partner. Only returned if feedback was left for a transaction. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .FeedbackReceived.CommentType |
CommentTypeCodeType | Conditionally |
Rating of the feedback being left (e.g., Positive). Sellers cannot leave neutral or negative feedback for buyers.
Applicable values: • CustomCode (in/out) Reserved for internal or future use. • IndependentlyWithdrawn (in/out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. • Negative (in/out) Negative feedback. Decreases total feedback score. • Neutral (in/out) Neutral feedback. No effect on total feedback score. • Positive (in/out) Positive feedback. Increases total feedback score. • Withdrawn (in/out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item |
ItemType | Conditionally |
Information about the item that spawned the transaction. It is a purchase from this item's listing that the transaction represents. To remove a property from an item, specify it in ModifyType as a changed property, but do not give it a value in Item. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .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:
|
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item .ClassifiedAdPayPerLeadFee |
AmountType (double) | Conditionally |
The email and phone lead fee for a pay-per-lead item.
DetailLevel: ReturnAll. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item .ClassifiedAdPayPerLeadFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese auction) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611.
• Express Deprecated as of version 561.
• FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601.
• PersonalOffer (out) 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. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.PictureDetails .GalleryURL |
anyURI | Conditionally |
URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Quantity |
int | Conditionally |
This meaning of this value depends on the context. For AddItem and related calls: Specify the number of identical items the seller has available for sale in this listing. For auctions (with competitive bidding), Quantity must be 1. For certain other formats (e.g., fixed-price) the Quantity can be 1 or more. See the eBay Web site online help to learn which selling formats support multi-quantity sales. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.Quantity for each variation instead. For ReviseItem and ReviseFixedPriceItem: When you revise a listing (with no variations), you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, on sites that support multi-quantity auctions (Dutch auctions), if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. In multi-variation listings, this value is the sum of all the variation quantities in the listing. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. For transaction calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support reserve prices. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the eBay Web Services guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the eBay Web Services guide for validation rules when revising US Motors listings. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .CurrentPrice |
AmountType (double) | Conditionally |
For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after a transaction is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.StartPrice |
AmountType (double) | Conditionally |
The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction-type listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings: This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items--it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one transaction can contain multiple items from a single variation.) For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no transactions, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0. As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing. For GetItem and related calls Only returned when a listing has variations. For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified. For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .Quantity |
int | Conditionally |
For AddFixedPriceItem and related calls: On input, this should be the number of items available for sale that are associated with this variation. If you set Quantity to zero when you create a new listing (or relist), the variation is dropped from the listing. For GetItem and related calls: On output, this is the total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract QuantitySold from this value. For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding transactions. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. Only returned if the seller specified a SKU for the variation. Max length: 70. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditionally |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can't add or change names or values in variation specifics (because the set of variation specifics serves as a unique identifier). However, you can delete or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (transactions). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify variations in transactions (for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .PaidTime |
dateTime | Conditionally |
Indicates the time when the transaction was marked paid. There are many ways to mark a transaction as paid. eBay sets it when payment is made via PayPal. A seller can mark an item as paid in My eBay or Selling Manager Pro. An application can use ReviseCheckoutStatus or CompleteSale on behalf of the seller. Note: This value is only visible to the user if the request user is the buyer or seller associated with the transaction. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .PaisaPayID |
string | Conditionally | Specifies the PaisaPayID using which the Item was paid for. Applicable for India site(203) only. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Platform |
TransactionPlatformCodeType | Conditionally |
Name of the eBay co-branded site upon which the transaction was made.
Applicable values: • CustomCode (in/out) Reserved for future use. • eBay (in/out) The transaction was created (i.e., the purchase was made) on the main eBay site. • Express (in/out) The transaction was created on the eBay Express site. • Half (in/out) The transaction was created on Half.com site. • Shopping (in/out) The transaction was created on the Shopping.com site. • WorldOfGood (in/out) The transaction was created on the WorldOfGood site. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .QuantityPurchased |
int | Conditionally |
Indicates the number of items the buyer purchased from the listing identified in ItemID. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .SellerPaidStatus |
PaidStatusCodeType | Conditionally |
Specifies the transaction's payment status, as seen by the seller. Returned in lists of sold items. Not applicable to Half.com. Applicable values: • BuyerHasNotCompletedCheckout (out) The buyer has not completed the checkout process and so has not made payment. • CustomCode (out) Reserved for future use. • EscrowPaymentCancelled (out) The buyer has made an escrow payment, but has cancelled the payment. • MarkedAsPaid (out) The transaction is marked as paid by either buyer or seller. • NotPaid (out) The buyer has not completed checkout, but has not paid through PayPal or PaisaPay (but please also see the documentation for PaymentHoldStatus and its applicable values). The buyer might have paid using another method, but the payment might not have been received or cleared. Important: Please see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment. • PaidCOD (out) PaidCOD • PaidWithEscrow (out) The buyer has made an escrow payment, and the seller has received payment. • PaidWithPaisaPay (out) The buyer has paid with PaisaPay, and the payment is complete. • PaidWithPaisaPayEscrow (out) Paid With PaisaPay Escrow • PaidWithPayPal (out) The buyer has made a PayPal payment, and the payment is complete. But please also see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment. • PaisaPayNotPaid (out) Paisa Pay Not Paid • PaymentPending (out) The buyer has made a payment other than PayPal, escrow, or PaisaPay, but the payment is still being processed. • PaymentPendingWithEscrow (out) The buyer has made an escrow payment, but the seller has not yet received it. • PaymentPendingWithPaisaPay (out) The buyer has paid with PaisaPay, but the payment is still being processed. The seller has not yet received payment. • PaymentPendingWithPaisaPayEscrow (out) Payment Pending With PaisaPay Escrow • PaymentPendingWithPayPal (out) The buyer has made a PayPal payment, but the seller has not yet received it. • Refunded (out) Refunded • WaitingForCODPayment (out) WaitingForCODPayment DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .ShippedTime |
dateTime | Conditionally |
Indicates the time when the item(s) associated with the transaction were marked as shipped, if known. The value is set when the seller uses shipment tracking features offered by eBay or an eBay partner. This value is also set when the seller marks the item as shipped by using CompleteSale. If the seller is a Selling Manager Pro user, they can also mark the item as shipped by using My eBay. Note that this value is only visible if the request user is the buyer or seller associated with the transaction. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Status |
TransactionStatusType | Conditionally |
Contains the status of the transaction, such as the buyer's online payment and whether the checkout process for the transaction has been completed. See TransactionStatusType for its child elements. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Status.PaymentHoldStatus |
PaymentHoldStatusCodeType | Conditionally |
Contains the current status of a hold on a PayPal payment. The payment hold that is referred to as a "payment review" hold results from a possible issue with a buyer. The payment hold referred to as a "merchant hold" results from a possible issue with a seller. For more information, please see the link below. Additionally, in the cases of the GetMyeBaySelling and GetMyeBayBuying calls, the PaymentHoldStatus value can affect the value returned in in SellerPaidStatus and BuyerPaidStatus; see the PaymentHoldStatus applicable values.
Applicable values: • CustomCode (out) Reserved for internal or future use. • MerchantHold (out) The payment hold referred to as a "merchant hold" results from a possible issue with a seller. If this value is returned, then the following values, as a result, will be returned: In GetMyeBaySelling, PaidWithPayPal is returned in TransactionArray.Transaction.SellerPaidStatus. In GetMyeBayBuying, PaidWithPayPal is returned in TransactionArray.Transaction.BuyerPaidStatus. • None (out) Indicates that there is no payment review hold and no merchant hold. • PaymentReview (out) The payment hold referred to as a "payment review" hold results from a possible issue with a buyer. If this value is returned, then the following values, as a result, will be returned: In GetMyeBaySelling, NotPaid is returned in TransactionArray.Transaction.SellerPaidStatus. In GetMyeBayBuying, PaidWithPayPal is returned in TransactionArray.Transaction.BuyerPaidStatus. • Released (out) Indicates that a payment hold has been released. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .TransactionID |
string | Conditionally |
Identifier for the transaction. A value of zero is used for the Chinese auction format. Thus, a value of zero is a valid transaction ID. A transaction ID is only unique to the listing that spawned it, so a transaction is only uniquely identified on a global basis by a combination of ItemID and TransactionID. Applicable to Half.com (for GetOrders only). Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .PaginationResult |
PaginationResultType | Conditionally |
Specifies information about the list, including number of pages and number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .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. |
|
DeletedFromSoldList .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. |
| DeletedFromUnsoldList | PaginatedItemArrayType | Conditionally |
Contains the items with listings that were ended or did not sell and have been deleted from My eBay.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray |
ItemArrayType | Conditionally |
Contains a list of Item types.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item |
ItemType | Conditionally,
repeatable: [0..*] |
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has a transactional relationship with that buyer. For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.BuyItNowPrice |
AmountType (double) | Conditionally |
For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. Once a Chinese auction has bids (and the high bid exceeds the reserve price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| DeletedFromUnsoldList .ItemArray.Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item .ClassifiedAdPayPerLeadFee |
AmountType (double) | Conditionally |
The email and phone lead fee for a pay-per-lead item.
DetailLevel: ReturnAll. |
| DeletedFromUnsoldList .ItemArray.Item .ClassifiedAdPayPerLeadFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.ItemID |
ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .EndTime |
dateTime | Conditionally |
Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended. In GetSearchResults, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times. In GetSearchResults, the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese auction) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611.
• Express Deprecated as of version 561.
• FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601.
• PersonalOffer (out) 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. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromUnsoldList .ItemArray.Item.PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.PictureDetails .GalleryURL |
anyURI | Conditionally |
URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromUnsoldList .ItemArray.Item.PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
DeletedFromUnsoldList .ItemArray.Item.Quantity |
int | Conditionally |
This meaning of this value depends on the context. For AddItem and related calls: Specify the number of identical items the seller has available for sale in this listing. For auctions (with competitive bidding), Quantity must be 1. For certain other formats (e.g., fixed-price) the Quantity can be 1 or more. See the eBay Web site online help to learn which selling formats support multi-quantity sales. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.Quantity for each variation instead. For ReviseItem and ReviseFixedPriceItem: When you revise a listing (with no variations), you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, on sites that support multi-quantity auctions (Dutch auctions), if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. In multi-variation listings, this value is the sum of all the variation quantities in the listing. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. For transaction calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item .QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
DeletedFromUnsoldList .ItemArray.Item.ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support reserve prices. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the eBay Web Services guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the eBay Web Services guide for validation rules when revising US Motors listings. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| DeletedFromUnsoldList .ItemArray.Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.SellingStatus .CurrentPrice |
AmountType (double) | Conditionally |
For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.SellingStatus .QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item .ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromUnsoldList .ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
DeletedFromUnsoldList .ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after a transaction is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
DeletedFromUnsoldList .ItemArray.Item.StartPrice |
AmountType (double) | Conditionally |
The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction-type listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings: This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items--it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one transaction can contain multiple items from a single variation.) For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no transactions, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0. As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing. For GetItem and related calls Only returned when a listing has variations. For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified. For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.PrivateNotes |
string | Conditionally |
A note a user makes on an item with variations in My eBay. For eBay.com, only GetMyeBaySelling (not GetItem) returns this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseFixedPriceItem. Use SetUserNotes instead. In SoldList, notes for variations are only returned at the Item level, not the variation level. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.Quantity |
int | Conditionally |
For AddFixedPriceItem and related calls: On input, this should be the number of items available for sale that are associated with this variation. If you set Quantity to zero when you create a new listing (or relist), the variation is dropped from the listing. For GetItem and related calls: On output, this is the total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract QuantitySold from this value. For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.SellingStatus .QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding transactions. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. Only returned if the seller specified a SKU for the variation. Max length: 70. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.VariationSpecifics |
NameValueListArrayType | Conditionally |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can't add or change names or values in variation specifics (because the set of variation specifics serves as a unique identifier). However, you can delete or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (transactions). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify variations in transactions (for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
|
DeletedFromUnsoldList .PaginationResult |
PaginationResultType | Conditionally |
Provides information about the list, including number of pages and number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .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. |
|
DeletedFromUnsoldList .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. |
| ScheduledList | PaginatedItemArrayType | Conditionally |
Contains the items the user has scheduled for sale, but whose listings have not yet started.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray | ItemArrayType | Conditionally |
Contains a list of Item types.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item | ItemType | Conditionally,
repeatable: [0..*] |
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has a transactional relationship with that buyer. For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .BuyItNowPrice |
AmountType (double) | Conditionally |
For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. Once a Chinese auction has bids (and the high bid exceeds the reserve price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| ScheduledList.ItemArray.Item .BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ClassifiedAdPayPerLeadFee |
AmountType (double) | Conditionally |
The email and phone lead fee for a pay-per-lead item.
DetailLevel: ReturnAll. |
| ScheduledList.ItemArray.Item .ClassifiedAdPayPerLeadFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .eBayNotes |
string | Conditionally |
Returns a note from eBay displayed below items in the user's My eBay account. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .ItemID |
ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .ListingDuration |
token | Conditionally |
Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time. The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable). The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information. When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours. Required for Half.com (but only specify GTC). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
Applicable values: See ListingDurationCodeType |
|
ScheduledList.ItemArray.Item .ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese auction) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611.
• Express Deprecated as of version 561.
• FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601.
• PersonalOffer (out) 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. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .PictureDetails.GalleryURL |
anyURI | Conditionally |
URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
ScheduledList.ItemArray.Item .Quantity |
int | Conditionally |
This meaning of this value depends on the context. For AddItem and related calls: Specify the number of identical items the seller has available for sale in this listing. For auctions (with competitive bidding), Quantity must be 1. For certain other formats (e.g., fixed-price) the Quantity can be 1 or more. See the eBay Web site online help to learn which selling formats support multi-quantity sales. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.Quantity for each variation instead. For ReviseItem and ReviseFixedPriceItem: When you revise a listing (with no variations), you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, on sites that support multi-quantity auctions (Dutch auctions), if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. In multi-variation listings, this value is the sum of all the variation quantities in the listing. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. For transaction calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
ScheduledList.ItemArray.Item .ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support reserve prices. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the eBay Web Services guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the eBay Web Services guide for validation rules when revising US Motors listings. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| ScheduledList.ItemArray.Item .ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .SellingStatus.CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .SellingStatus.ReserveMet |
boolean | Conditionally |
Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingSurcharge |
AmountType (double) | Conditionally | An additional fee to charge US buyers who ship via UPS to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some transactions in an order have a surcharge, surcharge is added only for those transactions. Flat rate shipping only. |
| ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingSurcharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after a transaction is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
ScheduledList.ItemArray.Item .StartPrice |
AmountType (double) | Conditionally |
The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction-type listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings: This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items--it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one transaction can contain multiple items from a single variation.) For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no transactions, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0. As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing. For GetItem and related calls Only returned when a listing has variations. For GetSellerList: Only returned when a listing has variations, IncludeVariations was set to true in the request, the DetailLevel was set to ReturnAll, and an applicable pagination value and time range were specified. For GetItemTransactions Only returned in Item when a listing has variations and IncludeVariations was set to true in the request. (Also see Variation returned in Transaction for information about which variation was actually purchased.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .PrivateNotes |
string | Conditionally |
A note a user makes on an item with variations in My eBay. For eBay.com, only GetMyeBaySelling (not GetItem) returns this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseFixedPriceItem. Use SetUserNotes instead. In SoldList, notes for variations are only returned at the Item level, not the variation level. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation.Quantity |
int | Conditionally |
For AddFixedPriceItem and related calls: On input, this should be the number of items available for sale that are associated with this variation. If you set Quantity to zero when you create a new listing (or relist), the variation is dropped from the listing. For GetItem and related calls: On output, this is the total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract QuantitySold from this value. For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding transactions. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. Only returned if the seller specified a SKU for the variation. Max length: 70. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditionally |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can't add or change names or values in variation specifics (because the set of variation specifics serves as a unique identifier). However, you can delete or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (transactions). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify variations in transactions (for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
| ScheduledList.PaginationResult | PaginationResultType | Conditionally |
Provides information about the list, including number of pages and number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.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. |
|
ScheduledList.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. |
| SellingSummary | SellingSummaryType | Always |
Contains summary information about the items the user is selling.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .ActiveAuctionCount |
int | Always |
The number of currently active auctions that will sell. That is, there is at least one bidder, and any reserve price has been met. Equivalent to the "Will Sell" value in My eBay.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SellingSummary.AuctionBidCount | int | Always |
The total number of bids made on the seller's active listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .AuctionSellingCount |
int | Always |
The total number of currently active auctions for a given seller. Note that this does not include listings that are FixedPriceItem or StoresFixedPrice. Equivalent to the "Auction Quantity" value in My eBay.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .SoldDurationInDays |
int | Always |
The average duration, in days, of all items sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .TotalAuctionSellingValue |
AmountType (double) | Always |
The total value of all items the seller has for sale in all listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SellingSummary .TotalAuctionSellingValue [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| SellingSummary.TotalSoldCount | int | Always |
The total number of items the seller has sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Discrepancies Between Results of GetMyeBaySelling and GetSellerTransactions. |
| SellingSummary.TotalSoldValue | AmountType (double) | Always |
The total monetary value of the items the seller has sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Discrepancies Between Results of GetMyeBaySelling and GetSellerTransactions. |
| SellingSummary.TotalSoldValue [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
| SoldList | PaginatedOrderTransactionArrayType | Conditionally |
Contains the items the user has sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray | OrderTransactionArrayType | Conditionally |
Contains the list of orders, transactions, or both.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction |
OrderTransactionType | Conditionally,
repeatable: [0..*] |
The individual order or transaction.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order |
OrderType | Conditionally |
Contains the information describing an order.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .OrderID |
OrderIDType (string) | Conditionally |
Unique identifier that eBay generates for the order. For calls like GetItemTransactions (and the Checkout notification), no OrderID will appear when only 1 item is purchased in a single end-to-end checkout flow (because the transaction would not be part of an order in this case). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .Subtotal |
AmountType (double) | Conditionally |
The sum of the sale prices of all of the transactions in the order, where a transaction sale price is the item sale price times the quantity sold. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .Subtotal [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray |
TransactionArrayType | Conditionally |
The set of two or more transactions that make up the order. We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.) Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction |
TransactionType | Conditionally,
repeatable: [0..*] |
Information about one transaction. Also applicable to Half.com (for GetOrders).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer |
UserType | Conditionally |
Contains the data for the transaction's buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if Seller is making the request. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.BuyerInfo |
BuyerType | Conditionally |
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.BuyerInfo .ShippingAddress |
AddressType | Conditionally |
Contains the address of the buyer in the transaction, to which the seller would ship the item(s). See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.BuyerInfo .ShippingAddress.PostalCode |
string | Conditionally |
User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Max length: 12. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .CreatedDate |
dateTime | Conditionally |
Indicates when the transaction was created. For fixed-price, Stores, and BIN items this indicates when the purchase (or BIN) occurred. For competitive-bid item listing types this indicates when listing ended, the winning bidder(s) determined, and the transaction created. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackLeft |
FeedbackInfoType | Conditionally |
A container for feedback information left FOR the user's transaction partner. Only returned if feedback was left for a transaction. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackLeft.CommentType |
CommentTypeCodeType | Conditionally |
Rating of the feedback being left (e.g., Positive). Sellers cannot leave neutral or negative feedback for buyers.
Applicable values: • CustomCode (in/out) Reserved for internal or future use. • IndependentlyWithdrawn (in/out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. • Negative (in/out) Negative feedback. Decreases total feedback score. • Neutral (in/out) Neutral feedback. No effect on total feedback score. • Positive (in/out) Positive feedback. Increases total feedback score. • Withdrawn (in/out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackReceived |
FeedbackInfoType | Conditionally |
A container for feedback information left BY the user's transaction partner. Only returned if feedback was left for a transaction. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackReceived.CommentType |
CommentTypeCodeType | Conditionally |
Rating of the feedback being left (e.g., Positive). Sellers cannot leave neutral or negative feedback for buyers.
Applicable values: • CustomCode (in/out) Reserved for internal or future use. • IndependentlyWithdrawn (in/out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. • Negative (in/out) Negative feedback. Decreases total feedback score. • Neutral (in/out) Neutral feedback. No effect on total feedback score. • Positive (in/out) Positive feedback. Increases total feedback score. • Withdrawn (in/out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item |
ItemType | Conditionally |
Information about the item that spawned the transaction. It is a purchase from this item's listing that the transaction represents. To remove a property from an item, specify it in ModifyType as a changed property, but do not give it a value in Item. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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:
|
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item .ClassifiedAdPayPerLeadFee |
AmountType (double) | Conditionally |
The email and phone lead fee for a pay-per-lead item.
DetailLevel: ReturnAll. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item .ClassifiedAdPayPerLeadFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .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. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese auction) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611.
• Express Deprecated as of version 561.
• FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601.
• PersonalOffer (out) 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. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PictureDetails .GalleryURL |
anyURI | Conditionally |
URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Quantity |
int | Conditionally |
This meaning of this value depends on the context. For AddItem and related calls: Specify the number of identical items the seller has available for sale in this listing. For auctions (with competitive bidding), Quantity must be 1. For certain other formats (e.g., fixed-price) the Quantity can be 1 or more. See the eBay Web site online help to learn which selling formats support multi-quantity sales. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.Quantity for each variation instead. For ReviseItem and ReviseFixedPriceItem: When you revise a listing (with no variations), you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. For auction items, a change in the auction's quantity could result in a change in the auction type. For example, on sites that support multi-quantity auctions (Dutch auctions), if the quantity is changed from 1 (a Chinese auction) to 2, the auction is now a Dutch auction. This may impose new requirements and fees on the seller. For GetSellerEvents calls, Quantity is returned only for listings where item quantity is greater than 1. In multi-variation listings, this value is the sum of all the variation quantities in the listing. For GetItem and related calls: This is the total of the number of items available for sale plus the quantity already sold. To determine the number of items available, subtract SellingStatus.QuantitySold from this value. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. For transaction calls with variations: In GetItemTransactions, Item.Quantity is the same as GetItem (the total quantity across all variations). In GetSellerTransactions, Transaction.Item.Quantity is the total quantity of the applicable variation (quantity available plus quantity sold). For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support reserve prices. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the eBay Web Services guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the eBay Web Services guide for validation rules when revising US Motors listings. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .CurrentPrice |
AmountType (double) | Conditionally |
For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that transaction. For transaction calls, also see Transaction.QuantityPurchased for the number of items purchased in the transaction. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus.ReserveMet |
boolean | Conditionally |
Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after a transaction is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique. A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If the SKU is unique across a seller's active listings, and if the seller listed the item by using AddFixedPriceItem or RelistFixedPriceItem, the seller can also set Item.InventoryTrackingMethod to SKU in those calls. This allows the seller to use SKU instead of ItemID as a unique identifier in subsequent calls, such as GetItem and ReviseInventoryStatus. If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.StartPrice |
AmountType (double) | Conditionally |
The original price of the item at listing or re-listing time. If this value changes when the item is revised, the new value becomes the original price. For auction-type listings: Competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is incremented to the amount of each succeeding bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For input on fixed-price listings (FixedPriceItem) and Store Inventory (StoresFixedPrice) listings: This is the constant price at which a buyer may purchase the item. GetMyeBaySelling does not return Item.StartPrice for fixed price items--it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the eBay Web Services guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one transaction can contain multiple items from a single variation.) For ReviseFixedPriceItem and RelistFixedPriceItem: Once a listing has been submitted with variations, you can't delete all the variations when you revise or relist the listing (because it would be considered a different listing). You also can't add or change variation specifics (because they are unique identifiers). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has no transactions, use the Variation.Delete field to delete the variation. If it has inventory, set the Quantity to 0. As a best practice, if you want to revise multiple variations in the same listing at the same time (i.e, within a very short period), use a single ReviseFixedPriceItem request and include all the variation revisions in the same request. If your application design requires you to revise each variation individually, then avoid using multiple parallel threads. Instead, use a serial, synchronous process. That is, wait until each revision has been processed by eBay before submitting the next revision request for another variation in the same listing. For GetItem and related calls Only returned when a listing has variations. For GetSellerList: |