GetMyeBaySelling
Use this call to retrieve 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 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.
Short-duration call rate limit: To protect eBay's infrastructure and servers from being overloaded and/or destabilized, the GetMyeBaySelling call has a short-duration call rate limit to restrict bursts of very high traffic.Per (seller) user ID, no more than 300 GetMyeBaySelling calls can be executed within any 15-second interval. If this call rate limit is exceeded at any time, the application making the called is blocked. Each time an application is blocked, the user/application must wait until the block is reset after 15 seconds. This short-duration call rate limit applies to all seller accounts, and sellers/developers cannot appeal or request for a higher limit.
Usage Details
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.
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.
Note: GetMyeBaySelling has a limit of 25,000 items. If the seller has more than 25,000 listings, the response always returns the following fields.
<TotalNumberOfPages>125</TotalNumberOfPages> <TotalNumberOfEntries>25000</TotalNumberOfEntries>
Any value larger than 125 in the PageNumber field, returns page 125.
Testing GetMyeBaySelling
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 Testing in 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.
Related Information
See:
GetMyeBaySelling
eBay Selling Page (US)
| Output Detail Controls Samples Change History |
Input
See also Samples.
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 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"> <!-- 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> <HideVariations> boolean </HideVariations> <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> <!-- Standard Input Fields --> <DetailLevel> DetailLevelCodeType </DetailLevel> <!-- ... more DetailLevel values allowed here ... --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <OutputSelector> string </OutputSelector> <!-- ... more OutputSelector values allowed here ... --> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </GetMyeBaySellingRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Call-specific Input Fields [Jump to standard fields] |
| ActiveList | ItemListCustomizationType | Optional |
Include this container and set the ActiveList.Include field to true to return the list of active listings on eBay.com. The user also has the option of using pagination and sorting for the list of active listings that will be returned. |
| 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: Although listing durations may vary by eBay marketplace and category, typical listing durations for real estate ads are 30 and 90 days. It is recommended that the seller uses the GetCategoryFeatures call to retrieve the actual listing durations that are supported for real estate ads on a particular marketplace and category. Traditionally, listing durations for fixed-prices listings have varied by eBay marketplace and category. Typical listing durations for fixed-price listings ranged from three to 30 days, or GTC (Good 'Til Cancelled). As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
With the 'GTC' listing duration, the listing will remain active as long as the listing shows that inventory is available for purchase (available quantity is '1' or more). For sellers listing motor vehicles on the eBay US Motors, eBay UK, or eBay Italy sites, it is recommended that the seller uses the GetCategoryFeatures call to retrieve the supported listing durations for their particular marketplace and category. Note: As long as a fixed-price listing has inventory available, or if the out-of-stock control feature is being used, GTC listings are automatically renewed each month according to the calendar day. (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 |
This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. |
|
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 the individual calls to determine the correct default value. Min: 1. Default: 1. |
| ActiveList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| HideVariations | boolean | Optional |
If this field is included and set to true, the Variations node (and all variation data) is omitted for all multiple-variation listings in the response. If this field is omitted or set to false, the Variations node is returned for all multiple-variation listings in the response. Default: false. |
| ScheduledList | ItemListCustomizationType | Optional |
Include this container and set the ScheduledList.Include field to true to return the list of items that are scheduled to become active listings on eBay.com at a future date/time. The user also has the option of using pagination and sorting for the list of Scheduled listings that will be returned. |
| 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 |
This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. |
|
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 the individual calls to determine the correct default value. 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 |
Include this container and set the SellingSummary.Include field to true to return the SellingSummary container in the response. The SellingSummary container consists of selling activity counts and values.
|
| 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 |
Include this container and set the SoldList.Include field to true to return the list of sold order line items. The user also has the option of using pagination and sorting for the list of sold items that will be returned. |
| 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. For example, to return the items won or lost in the last week, specify a DurationInDays of 7. 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 order as Paid and/or Shipped in My eBay. Sellers can use CompleteSale or My eBay to mark an order as Paid or Shipped. Default: All. Applicable values: |
| 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 |
This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. |
| 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 the individual calls to determine the correct default value. 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 |
Include this container and set the UnsoldList.Include field to true to return the listings that have ended without a purchase. The user also has the option of using pagination and sorting for the list of unsold items that will be returned. |
| 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. For example, to return the items won or lost in the last week, specify a DurationInDays of 7. 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 |
This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. |
|
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 the individual calls to determine the correct default value. Min: 1. Default: 1. |
| UnsoldList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| Standard Input 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 and 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. 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 GranularityLevel instead, or use GetSellerEvents. If you do use 'ReturnAll' with GetSellerList, use a small Pagination.EntriesPerPage value and a narrow EndTimeFrom/EndTimeTo date range for better performance. Applicable values: (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. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
| MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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 a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload. For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as ViewItemURL and BuyItNowPrice as in the following example: If the following output selectors are used: See OutputSelector. |
||||||||||||||||||||||||||||||||||||||||
| Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
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 performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
| Input Detail Controls Samples Change History |
Output
See also Samples.
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 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).
<?xml version="1.0" encoding="utf-8"?> <GetMyeBaySellingResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- 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> <HideFromSearch> boolean </HideFromSearch> <ItemID> ItemIDType (string) </ItemID> <LeadCount> int </LeadCount> <ListingDetails> ListingDetailsType <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> <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch> <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice> <SellerProfiles> SellerProfilesType <SellerPaymentProfile> SellerPaymentProfileType <PaymentProfileID> long </PaymentProfileID> <PaymentProfileName> string </PaymentProfileName> </SellerPaymentProfile> <SellerReturnProfile> SellerReturnProfileType <ReturnProfileID> long </ReturnProfileID> <ReturnProfileName> string </ReturnProfileName> </SellerReturnProfile> <SellerShippingProfile> SellerShippingProfileType <ShippingProfileID> long </ShippingProfileID> <ShippingProfileName> string </ShippingProfileName> </SellerShippingProfile> </SellerProfiles> <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 <GlobalShipping> boolean </GlobalShipping> <ShippingServiceOptions> ShippingServiceOptionsType <LocalPickup> boolean </LocalPickup> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> </ShippingServiceOptions> <!-- ... more ShippingServiceOptions nodes allowed here ... --> <ShippingType> ShippingTypeCodeType </ShippingType> </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 <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> <SKU> SKUType (string) </SKU> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> <VariationSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </VariationSpecifics> <!-- ... more VariationSpecifics nodes allowed here ... --> <VariationTitle> string </VariationTitle> <WatchCount> long </WatchCount> </Variation> <!-- ... more Variation nodes allowed here ... --> </Variations> <WatchCount> long </WatchCount> </Item> <!-- ... more Item nodes allowed here ... --> </ItemArray> <PaginationResult> PaginationResultType <TotalNumberOfEntries> int </TotalNumberOfEntries> <TotalNumberOfPages> int </TotalNumberOfPages> </PaginationResult> </ActiveList> <ScheduledList> PaginatedItemArrayType <ItemArray> ItemArrayType <Item> ItemType <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice> <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee> <eBayNotes> string </eBayNotes> <HideFromSearch> boolean </HideFromSearch> <ItemID> ItemIDType (string) </ItemID> <ListingDetails> ListingDetailsType <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> <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch> <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice> <SellerProfiles> SellerProfilesType <SellerPaymentProfile> SellerPaymentProfileType <PaymentProfileID> long </PaymentProfileID> <PaymentProfileName> string </PaymentProfileName> </SellerPaymentProfile> <SellerReturnProfile> SellerReturnProfileType <ReturnProfileID> long </ReturnProfileID> <ReturnProfileName> string </ReturnProfileName> </SellerReturnProfile> <SellerShippingProfile> SellerShippingProfileType <ShippingProfileID> long </ShippingProfileID> <ShippingProfileName> string </ShippingProfileName> </SellerShippingProfile> </SellerProfiles> <SellingStatus> SellingStatusType <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice> <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice> <QuantitySold> int </QuantitySold> <ReserveMet> boolean </ReserveMet> </SellingStatus> <ShippingDetails> ShippingDetailsType <GlobalShipping> boolean </GlobalShipping> <ShippingServiceOptions> ShippingServiceOptionsType <LocalPickup> boolean </LocalPickup> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> </ShippingServiceOptions> <!-- ... more ShippingServiceOptions nodes allowed here ... --> <ShippingType> ShippingTypeCodeType </ShippingType> </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 <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice> <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice> <QuantitySold> int </QuantitySold> <ReserveMet> boolean </ReserveMet> </SellingStatus> <SKU> SKUType (string) </SKU> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> <VariationSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </VariationSpecifics> <!-- ... more VariationSpecifics nodes allowed here ... --> <VariationTitle> string </VariationTitle> <WatchCount> long </WatchCount> </Variation> <!-- ... more Variation nodes allowed here ... --> </Variations> <WatchCount> long </WatchCount> </Item> <!-- ... more Item nodes allowed here ... --> </ItemArray> <PaginationResult> PaginationResultType <TotalNumberOfEntries> int </TotalNumberOfEntries> <TotalNumberOfPages> int </TotalNumberOfPages> </PaginationResult> </ScheduledList> <SellingSummary> SellingSummaryType <ActiveAuctionCount> int </ActiveAuctionCount> <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> <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount> <RefundStatus> string </RefundStatus> <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> <ConvertedTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedTransactionPrice> <CreatedDate> dateTime </CreatedDate> <FeedbackLeft> FeedbackInfoType <CommentType> CommentTypeCodeType </CommentType> </FeedbackLeft> <FeedbackReceived> FeedbackInfoType <CommentType> CommentTypeCodeType </CommentType> </FeedbackReceived> <IsMultiLegShipping> boolean </IsMultiLegShipping> <Item> ItemType <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice> <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee> <HideFromSearch> boolean </HideFromSearch> <ItemID> ItemIDType (string) </ItemID> <ListingDetails> ListingDetailsType <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> <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch> <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice> <SellerProfiles> SellerProfilesType <SellerPaymentProfile> SellerPaymentProfileType <PaymentProfileID> long </PaymentProfileID> <PaymentProfileName> string </PaymentProfileName> </SellerPaymentProfile> <SellerReturnProfile> SellerReturnProfileType <ReturnProfileID> long </ReturnProfileID> <ReturnProfileName> string </ReturnProfileName> </SellerReturnProfile> <SellerShippingProfile> SellerShippingProfileType <ShippingProfileID> long </ShippingProfileID> <ShippingProfileName> string </ShippingProfileName> </SellerShippingProfile> </SellerProfiles> <SellingStatus> SellingStatusType <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice> <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice> <QuantitySold> int </QuantitySold> <ReserveMet> boolean </ReserveMet> </SellingStatus> <ShippingDetails> ShippingDetailsType <GlobalShipping> boolean </GlobalShipping> <ShippingServiceOptions> ShippingServiceOptionsType <LocalPickup> boolean </LocalPickup> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> </ShippingServiceOptions> <!-- ... more ShippingServiceOptions nodes allowed here ... --> <ShippingType> ShippingTypeCodeType </ShippingType> </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 <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice> <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice> <QuantitySold> int </QuantitySold> <ReserveMet> boolean </ReserveMet> </SellingStatus> <SKU> SKUType (string) </SKU> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> <VariationSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </VariationSpecifics> <!-- ... more VariationSpecifics nodes allowed here ... --> <VariationTitle> string </VariationTitle> <WatchCount> long </WatchCount> </Variation> <!-- ... more Variation nodes allowed here ... --> </Variations> <WatchCount> long </WatchCount> </Item> <OrderLineItemID> string </OrderLineItemID> <PaidTime> dateTime </PaidTime> <Platform> TransactionPlatformCodeType </Platform> <QuantityPurchased> int </QuantityPurchased> <SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus> <ShippedTime> dateTime </ShippedTime> <Status> TransactionStatusType <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus> </Status> <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice> <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice> <TransactionID> string </TransactionID> </Transaction> <!-- ... more Transaction nodes allowed here ... --> </TransactionArray> </Order> <Transaction> TransactionType <Buyer> UserType <BuyerInfo> BuyerType <ShippingAddress> AddressType <PostalCode> string </PostalCode> </ShippingAddress> </BuyerInfo> <Email> string </Email> <UserID> UserIDType (string) </UserID> </Buyer> <ConvertedTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedTransactionPrice> <CreatedDate> dateTime </CreatedDate> <FeedbackLeft> FeedbackInfoType <CommentType> CommentTypeCodeType </CommentType> </FeedbackLeft> <FeedbackReceived> FeedbackInfoType <CommentType> CommentTypeCodeType </CommentType> </FeedbackReceived> <IsMultiLegShipping> boolean </IsMultiLegShipping> <Item> ItemType <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice> <ClassifiedAdPayPerLeadFee currencyID="CurrencyCodeType"> AmountType (double) </ClassifiedAdPayPerLeadFee> <HideFromSearch> boolean </HideFromSearch> <ItemID> ItemIDType (string) </ItemID> <ListingDetails> ListingDetailsType <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> <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch> <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice> <SellerProfiles> SellerProfilesType <SellerPaymentProfile> SellerPaymentProfileType <PaymentProfileID> long </PaymentProfileID> <PaymentProfileName> string </PaymentProfileName> </SellerPaymentProfile> <SellerReturnProfile> SellerReturnProfileType <ReturnProfileID> long </ReturnProfileID> <ReturnProfileName> string </ReturnProfileName> </SellerReturnProfile> <SellerShippingProfile> SellerShippingProfileType <ShippingProfileID> long </ShippingProfileID> <ShippingProfileName> string </ShippingProfileName> </SellerShippingProfile> </SellerProfiles> <SellingStatus> SellingStatusType <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice> <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice> <QuantitySold> int </QuantitySold> <ReserveMet> boolean </ReserveMet> </SellingStatus> <ShippingDetails> ShippingDetailsType <GlobalShipping> boolean </GlobalShipping> <ShippingServiceOptions> ShippingServiceOptionsType <LocalPickup> boolean </LocalPickup> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> </ShippingServiceOptions> <!-- ... more ShippingServiceOptions nodes allowed here ... --> <ShippingType> ShippingTypeCodeType </ShippingType> </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 <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice> <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice> <QuantitySold> int </QuantitySold> <ReserveMet> boolean </ReserveMet> </SellingStatus> <SKU> SKUType (string) </SKU> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> <VariationSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </VariationSpecifics> <!-- ... more VariationSpecifics nodes allowed here ... --> <VariationTitle> string </VariationTitle> <WatchCount> long </WatchCount> </Variation> <!-- ... more Variation nodes allowed here ... --> </Variations> <WatchCount> long </WatchCount> </Item> <OrderLineItemID> string </OrderLineItemID> <PaidTime> dateTime </PaidTime> <Platform> TransactionPlatformCodeType </Platform> <QuantityPurchased> int </QuantityPurchased> <SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus> <ShippedTime> dateTime </ShippedTime> <Status> TransactionStatusType <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus> </Status> <TotalPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalPrice> <TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice> <TransactionID> string </TransactionID> </Transaction> </OrderTransaction> <!-- ... more OrderTransaction nodes allowed here ... --> </OrderTransactionArray> <PaginationResult> PaginationResultType <TotalNumberOfEntries> int </TotalNumberOfEntries> <TotalNumberOfPages> int </TotalNumberOfPages> </PaginationResult> </SoldList> <Summary> MyeBaySellingSummaryType <ActiveAuctionCount> int </ActiveAuctionCount> <AmountLimitRemaining currencyID="CurrencyCodeType"> AmountType (double) </AmountLimitRemaining> <AuctionSellingCount> int </AuctionSellingCount> <ClassifiedAdCount> int </ClassifiedAdCount> <QuantityLimitRemaining> long </QuantityLimitRemaining> <SoldDurationInDays> int </SoldDurationInDays> <TotalAuctionSellingValue currencyID="CurrencyCodeType"> AmountType (double) </TotalAuctionSellingValue> <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> <HideFromSearch> boolean </HideFromSearch> <ItemID> ItemIDType (string) </ItemID> <LeadCount> int </LeadCount> <ListingDetails> ListingDetailsType <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> <ReasonHideFromSearch> ReasonHideFromSearchCodeType </ReasonHideFromSearch> <Relisted> boolean </Relisted> <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice> <SellerProfiles> SellerProfilesType <SellerPaymentProfile> SellerPaymentProfileType <PaymentProfileID> long </PaymentProfileID> <PaymentProfileName> string </PaymentProfileName> </SellerPaymentProfile> <SellerReturnProfile> SellerReturnProfileType <ReturnProfileID> long </ReturnProfileID> <ReturnProfileName> string </ReturnProfileName> </SellerReturnProfile> <SellerShippingProfile> SellerShippingProfileType <ShippingProfileID> long </ShippingProfileID> <ShippingProfileName> string </ShippingProfileName> </SellerShippingProfile> </SellerProfiles> <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 <GlobalShipping> boolean </GlobalShipping> <ShippingServiceOptions> ShippingServiceOptionsType <LocalPickup> boolean </LocalPickup> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> </ShippingServiceOptions> <!-- ... more ShippingServiceOptions nodes allowed here ... --> <ShippingType> ShippingTypeCodeType </ShippingType> </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 <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> <SKU> SKUType (string) </SKU> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> <VariationSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </VariationSpecifics> <!-- ... more VariationSpecifics nodes allowed here ... --> <VariationTitle> string </VariationTitle> <WatchCount> long </WatchCount> </Variation> <!-- ... more Variation nodes allowed here ... --> </Variations> <WatchCount> long </WatchCount> </Item> <!-- ... more Item nodes allowed here ... --> </ItemArray> <PaginationResult> PaginationResultType <TotalNumberOfEntries> int </TotalNumberOfEntries> <TotalNumberOfPages> int </TotalNumberOfPages> </PaginationResult> </UnsoldList> <!-- 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 allowed here ... --> <LongMessage> string </LongMessage> <SeverityCode> SeverityCodeType </SeverityCode> <ShortMessage> string </ShortMessage> </Errors> <!-- ... more Errors nodes allowed here ... --> <HardExpirationWarning> string </HardExpirationWarning> <Timestamp> dateTime </Timestamp> <Version> string </Version> </GetMyeBaySellingResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Call-specific Output Fields [Jump to standard fields] |
| ActiveList | PaginatedItemArrayType | Conditionally |
This container consists of active listings. This container will be returned if the eBay user has one or more active listings on eBay.com. This container will not be returned in the response (even if there are one or more active listings) if the DetailLevel value is set to ReturnSummary and the ActiveList.Include field is omitted or set to false.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray | ItemArrayType | Conditionally |
An array of one or more items returned under one or more containers in a GetMyeBayBuying or GetMyeBaySelling call response.
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 the eBayAuthToken) has an order 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. Note: When making a GetSellerList call, items that are on-hold due to an eBay policy violation will not be returned in the response. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .BestOfferDetails |
BestOfferDetailsType | Conditionally |
For Add/Revise/Relist/Verify calls: This container is used to enable the Best Offer feature on a listing. Note that the Best Offer feature can be set for auction listings on the US, Canada, UK, Germany, Australia, France, Italy, and Spain marketplaces, but a seller can only use Best Offer or Buy It Now, but not both. Once an auction listing receives a qualifying bid, the Best Offer feature will be turned off and any pending Best Offers or Counteroffers will no longer be valid. For GetItem and other calls that retrieve item data, this container will include the status (GetMyeBayBuying only) and dollar amount of the latest Best Offer on a fixed-price listing, and the number of Best Offers received for the fixed-price listing. Note: Best Offer is not available for multi-variation listings. 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 Best Offers made, this field will not appear in the response. This field is not applicable to the Add/Revise/Relist calls.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .BuyItNowPrice |
AmountType (double) | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. 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 |
The email and phone lead fee for a pay-per-lead item. 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .HideFromSearch |
boolean | Conditionally |
This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
|
|
ActiveList.ItemArray.Item .ItemID |
ItemIDType (string) | Conditionally |
The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified. 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. Your code should be prepared to handle IDs of up to 19 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. In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
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.
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. Note: As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
GTC is specified in this field, it will be ignored, and GTC will be used instead.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ListingDurationCodeType |
|
ActiveList.ItemArray.Item .ListingType |
ListingTypeCodeType | Conditionally |
The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value). If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings. This field is not applicable to Revise calls because the selling format of active listings cannot be changed. Applicable values: See ListingType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing types. |
|
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 |
This container consists of the data associated with photos within the listing. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. It is required that all listings have at least one picture. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .PictureDetails.GalleryURL |
anyURI | Conditionally |
This field shows the URL for the gallery image of an item returned in GetMyeBayBuying and GetMyeBaySelling. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .PrivateNotes |
string | Conditionally |
A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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). |
|
ActiveList.ItemArray.Item .Quantity |
int | Conditionally |
For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations. For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1. For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and three items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.When eBay auto-renews a GTC listing (ListingDuration = GTC) on your behalf, eBay relists with correct quantity available. For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1. 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. For order line item 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). Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .QuantityAvailable |
int | Conditionally |
This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.
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. |
|
ActiveList.ItemArray.Item .ReasonHideFromSearch |
ReasonHideFromSearchCodeType | Conditionally |
This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.
Applicable values: This enumeration value is associated with eBay Duplicate Listings Policy, which is applicable on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page. Code so that your app gracefully handles any future changes to this list. |
|
ActiveList.ItemArray.Item .ReservePrice |
AmountType (double) | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| ActiveList.ItemArray.Item .ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .SellerProfiles |
SellerProfilesType | Conditionally |
This container is used if the seller would like to use/reference business policies to create, revise, relist, or verify their listing. The seller's account must be opted in to business policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy must be specified and applied to the listing. If the seller's account is not opted in to business policies, that seller may not use this container. Sellers must opt-in to business policies through My eBay or by using the optInToProgram call of the eBay Account API. If business policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request. Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. This container is only returned in 'Get' calls if business policies are set for the listing, and the person making the API call is the seller of the listing. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify API call to reference and use the settings/values of a payment business policy. Payment business policies contain a setting to control whether immediate payment is required, settings to specify due dates for the deposit and full payment of a motor vehicle listing (Motors policy only), and settings to specify which offline payment methods are avaiable to buyers for sales transactions that happen off of eBay's platform. Multiple payment business policies can be created and saved at the account level by sellers. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. Note: Sellers will never have to specify electronic payment methods, but offline payment methods are required for listings where offline payment is required or supported. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerPaymentProfile .PaymentProfileID |
long | Conditionally |
The unique identifier of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a return business policy. Return business policies contain detailed information on the seller's return policy for domestic and international buyers (if the seller ships internationally), including whether or not the seller accepts returns from domestic and international buyers, how many days the buyer has to return the item for a refund, and who pays the return shipping costs. Multiple return policy business policies can be created and saved at the account level by sellers. Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container. This container is only returned in 'Get' calls if Business Policies are set for the listing and the person making the API call is the seller of the listing. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. Return policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a specific shipping business policy. Shipping business policies contain detailed information on domestic and international shipping, including shipping service options and costs, handling time, shipping discount information, and excluded ship-to locations. Multiple shipping business policies can be created and saved at the account level by sellers. Note: Any shipping inclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a shipping business policy. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shippping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence. Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ShipppingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a shipping business policy. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shipping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShippingProfileID takes precedence. In the 'Get' calls, the ShippingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
ActiveList.ItemArray.Item .SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status.
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 auction item.
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 auction listings. 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 |
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. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price 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 |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .SellingStatus.HighBidder |
UserType | Conditionally |
For ended auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, fixed-price 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. In the case of PlaceOffer, for auction listings, 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 order line item (or only for the first order line item that is created). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.HighBidder .FeedbackRatingStar |
FeedbackRatingStarCodeType | Conditionally |
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. Applicable values: See FeedbackRatingStar. Code so that your app gracefully handles any future changes to this list. 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 either side of an order. Each order line item 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 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. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.
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, 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". Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: 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 Philippines site: 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 Philippines site 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". 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 |
Original price of an item whose price a seller has reduced with the Promotional Price Display feature. 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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. 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 order, including flat and calculated shipping costs. Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the ShippingDetails container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container. If you do not use a fulfillment business policy, many of the fields under this ShippingDetails container become required in your request. Note: For ReviseItem and ReviseFixedPriceItem calls: If you are updating any field under the ShippingDetails container, you must include all containers and fields set under this container even if their values are not changing. If you do not do this, some fields may be removed from the listing. To find out the values included in the current listing, call GetItem and look through the ShippingDetails container in the response. For additional information, see Revise shipping details. 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, 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 any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform. Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
For GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .ShippingDetails .GlobalShipping |
boolean | Conditionally |
Note: The Global Shipping Program (GSP) is only available on the UK marketplace. On the US marketplace, the Global Shipping Program was replaced by the intermediated international shipping program called eBay International Shipping. eBay International Shipping is an account level setting, and no field will need to be set in a add/revise call to enable this setting. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into eBay International Shipping, that same seller can still also specify individual international shipping service options through the ShippingDetails.InternationalShippingServiceOption container. In an Add/Revise/Relist call, this boolean field can be included and set to True if the seller would like to use eBay's Global Shipping Program for orders that are shipped internationally. In 'Get' calls, if this field is returned as True, it indicates that international shipping through the Global Shipping Program is available for the listing. If this field is returned as False, the seller is responsible for shipping the item internationally using one of the specified international shipping service options set for the listing. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. 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> 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 four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .LocalPickup |
boolean | Conditionally |
The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping. |
|
ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .ShippingDetails.ShippingType |
ShippingTypeCodeType | Conditionally |
The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these. GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.
Applicable values: See ShippingType. Code so that your app gracefully handles any future changes to this list. |
| ActiveList.ItemArray.Item.SKU | SKUType (string) | Conditionally |
A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus 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 an order line item is created. (SKU is recommended as an alternative to ApplicationData.) If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request. Note: The eBay site 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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing. 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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| ActiveList.ItemArray.Item .StartPrice [ attribute currencyID ] |
CurrencyCodeType | 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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. 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 Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Title |
string | Conditionally |
This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours. Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations |
VariationsType | Conditionally |
Variations are similar (but not identical) items in a multiple-variation, 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 order line item can contain multiple items from a single variation.) If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories. 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 purchases, 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.) For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request. Note: This container will stop being returned in GetItemTransactions on January 31, 2024. 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 item variation from another. For example, if an item varies 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 item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call. When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. 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 |
This value indicates the quantity of the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total quantity associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract SellingStatus.QuantitySold from this value. For RelistFixedPriceItem:
0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings). For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, unless you set the OutOfStockControlPreference boolean field of the SetUserPreferences call to true, at least one variation must remain with a non-zero quantity in order for the listing to remain active. If you set the OutOfStockControlPreference field to true, a multiple-variation listing will remain active but hidden from search even if the quantity of all variations in the listing is set to 0. 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 User Guide for more details about setting and modifying a variation's quantity. Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus.BidCount |
int | Conditionally | Number of bids placed so far against the auction item. |
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus.BidderCount |
long | Conditionally | Number of bidders for an item. Only applicable to auction listings. Only returned for the seller of the item. |
|
ActiveList.ItemArray.Item .Variations.Variation .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. |
| ActiveList.ItemArray.Item .Variations.Variation .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | 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. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. |
| ActiveList.ItemArray.Item .Variations.Variation .SellingStatus.CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus.HighBidder |
UserType | Conditionally |
For ended auction listings that have a winning bidder, this field is a container for the high bidder's user ID. For ended, single-item, fixed-price 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. In the case of PlaceOffer, for auction listings, 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 order line item (or only for the first order line item that is created). |
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus.HighBidder .FeedbackRatingStar |
FeedbackRatingStarCodeType | Conditionally |
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. Applicable values: See FeedbackRatingStar. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .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 either side of an order. Each order line item 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 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. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .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, 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". Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: 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 Philippines site: 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 Philippines site 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". For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .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. |
|
ActiveList.ItemArray.Item .Variations.Variation .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 .Variations.Variation .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 .Variations.Variation .SellingStatus .PromotionalSaleDetails .OriginalPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Original price of an item whose price a seller has reduced with the Promotional Price Display feature. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .Variations.Variation .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 .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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. 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 .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. |
|
ActiveList.ItemArray.Item .Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the VariationSpecifics identifying values. 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 include the Item.InventoryTrackingMethod field in an 'FixedPriceItem' call and set its value to SKU, the Variation.SKU values become required for each variation..For GetItem, GetOrders and other 'Get' calls: Only returned if the seller specified a SKU for the variation. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See SKU identifiers. |
|
ActiveList.ItemArray.Item .Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Pricing. |
| ActiveList.ItemArray.Item .Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditionally,
repeatable: [2..5] |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of Item Specific names, but each variation must provide a unique combination of values for those Item Specific names. For example, if the items vary by color and size, then every variation must specify 'Color' and 'Size' as Item Specific names, but no two variations can specify the same combination of 'Color' and 'Size' values. When you revise a listing that includes variations, you can change names of Variationpecifics by using the Variations.ModifyNameList container. You can also add, 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 (order line items). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, Variationpecifics are not returned if the variation has a SKU. If the variation has no SKU, then Variationpecifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force Variationpecifics to be returned, even when the SKU is returned. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. 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 variations, 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:
For PlaceOffer: Required if the item being purchased includes Item Variations. For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required. Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name. For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing. Max length: 65. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI. If an item specific only supports a single value, only the first item specific value specified in the request will be used. For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description. Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning'). 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 Variationpecifics. 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]. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 120. 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.
|
| ActiveList.PaginationResult | PaginationResultType | Conditionally |
This container shows the total numer of items that matched the input criteria and the total number of the results set. Users can use the Pagination.PageNumber field in the request to toggle through different pages in the results set.
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 call requests. 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. 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 |
This container consists of the items that are scheduled to become active at a future date/time. This container will be returned if the eBay user has one or more listings scheduled to become active at a future date/time. This container will not be returned in the response (even if there are listings scheduled to become active) if the DetailLevel value is set to ReturnSummary and the ScheduledList.Include field is omitted or set to false.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray | ItemArrayType | Conditionally |
An array of one or more items returned under one or more containers in a GetMyeBayBuying or GetMyeBaySelling call response.
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 the eBayAuthToken) has an order 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. Note: When making a GetSellerList call, items that are on-hold due to an eBay policy violation will not be returned in the response. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .BuyItNowPrice |
AmountType (double) | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. 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 |
The email and phone lead fee for a pay-per-lead item. 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .HideFromSearch |
boolean | Conditionally |
This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
|
|
ScheduledList.ItemArray.Item .ItemID |
ItemIDType (string) | Conditionally |
The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified. 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. Your code should be prepared to handle IDs of up to 19 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. In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
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.
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. Note: As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
GTC is specified in this field, it will be ignored, and GTC will be used instead.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ListingDurationCodeType |
|
ScheduledList.ItemArray.Item .ListingType |
ListingTypeCodeType | Conditionally |
The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value). If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings. This field is not applicable to Revise calls because the selling format of active listings cannot be changed. Applicable values: See ListingType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing types. |
|
ScheduledList.ItemArray.Item .PictureDetails |
PictureDetailsType | Conditionally |
This container consists of the data associated with photos within the listing. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. It is required that all listings have at least one picture. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .PictureDetails.GalleryURL |
anyURI | Conditionally |
This field shows the URL for the gallery image of an item returned in GetMyeBayBuying and GetMyeBaySelling. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .PrivateNotes |
string | Conditionally |
A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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). |
|
ScheduledList.ItemArray.Item .Quantity |
int | Conditionally |
For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations. For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1. For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and three items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.When eBay auto-renews a GTC listing (ListingDuration = GTC) on your behalf, eBay relists with correct quantity available. For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1. 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. For order line item 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). Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .QuantityAvailable |
int | Conditionally |
This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.
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. |
|
ScheduledList.ItemArray.Item .ReasonHideFromSearch |
ReasonHideFromSearchCodeType | Conditionally |
This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.
Applicable values: This enumeration value is associated with eBay Duplicate Listings Policy, which is applicable on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page. Code so that your app gracefully handles any future changes to this list. |
|
ScheduledList.ItemArray.Item .ReservePrice |
AmountType (double) | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| ScheduledList.ItemArray.Item .ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .SellerProfiles |
SellerProfilesType | Conditionally |
This container is used if the seller would like to use/reference business policies to create, revise, relist, or verify their listing. The seller's account must be opted in to business policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy must be specified and applied to the listing. If the seller's account is not opted in to business policies, that seller may not use this container. Sellers must opt-in to business policies through My eBay or by using the optInToProgram call of the eBay Account API. If business policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request. Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. This container is only returned in 'Get' calls if business policies are set for the listing, and the person making the API call is the seller of the listing. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify API call to reference and use the settings/values of a payment business policy. Payment business policies contain a setting to control whether immediate payment is required, settings to specify due dates for the deposit and full payment of a motor vehicle listing (Motors policy only), and settings to specify which offline payment methods are avaiable to buyers for sales transactions that happen off of eBay's platform. Multiple payment business policies can be created and saved at the account level by sellers. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. Note: Sellers will never have to specify electronic payment methods, but offline payment methods are required for listings where offline payment is required or supported. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerPaymentProfile .PaymentProfileID |
long | Conditionally |
The unique identifier of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a return business policy. Return business policies contain detailed information on the seller's return policy for domestic and international buyers (if the seller ships internationally), including whether or not the seller accepts returns from domestic and international buyers, how many days the buyer has to return the item for a refund, and who pays the return shipping costs. Multiple return policy business policies can be created and saved at the account level by sellers. Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container. This container is only returned in 'Get' calls if Business Policies are set for the listing and the person making the API call is the seller of the listing. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. Return policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a specific shipping business policy. Shipping business policies contain detailed information on domestic and international shipping, including shipping service options and costs, handling time, shipping discount information, and excluded ship-to locations. Multiple shipping business policies can be created and saved at the account level by sellers. Note: Any shipping inclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a shipping business policy. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shippping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence. Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ShipppingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a shipping business policy. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shipping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShippingProfileID takes precedence. In the 'Get' calls, the ShippingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
ScheduledList.ItemArray.Item .SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status.
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 |
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. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price 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 |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. 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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. 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 order, including flat and calculated shipping costs. Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the ShippingDetails container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container. If you do not use a fulfillment business policy, many of the fields under this ShippingDetails container become required in your request. Note: For ReviseItem and ReviseFixedPriceItem calls: If you are updating any field under the ShippingDetails container, you must include all containers and fields set under this container even if their values are not changing. If you do not do this, some fields may be removed from the listing. To find out the values included in the current listing, call GetItem and look through the ShippingDetails container in the response. For additional information, see Revise shipping details. 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, 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 any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform. Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
For GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .ShippingDetails .GlobalShipping |
boolean | Conditionally |
Note: The Global Shipping Program (GSP) is only available on the UK marketplace. On the US marketplace, the Global Shipping Program was replaced by the intermediated international shipping program called eBay International Shipping. eBay International Shipping is an account level setting, and no field will need to be set in a add/revise call to enable this setting. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into eBay International Shipping, that same seller can still also specify individual international shipping service options through the ShippingDetails.InternationalShippingServiceOption container. In an Add/Revise/Relist call, this boolean field can be included and set to True if the seller would like to use eBay's Global Shipping Program for orders that are shipped internationally. In 'Get' calls, if this field is returned as True, it indicates that international shipping through the Global Shipping Program is available for the listing. If this field is returned as False, the seller is responsible for shipping the item internationally using one of the specified international shipping service options set for the listing. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. 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> 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 four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .LocalPickup |
boolean | Conditionally |
The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping. |
|
ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ShippingDetails.ShippingType |
ShippingTypeCodeType | Conditionally |
The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these. GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.
Applicable values: See ShippingType. Code so that your app gracefully handles any future changes to this list. |
|
ScheduledList.ItemArray.Item .SKU |
SKUType (string) | Conditionally |
A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus 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 an order line item is created. (SKU is recommended as an alternative to ApplicationData.) If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request. Note: The eBay site 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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing. 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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| ScheduledList.ItemArray.Item .StartPrice [ attribute currencyID ] |
CurrencyCodeType | 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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. 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 Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Title |
string | Conditionally |
This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours. Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations |
VariationsType | Conditionally |
Variations are similar (but not identical) items in a multiple-variation, 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 order line item can contain multiple items from a single variation.) If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories. 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 purchases, 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.) For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request. Note: This container will stop being returned in GetItemTransactions on January 31, 2024. 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 item variation from another. For example, if an item varies 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 item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call. When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. 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 |
This value indicates the quantity of the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total quantity associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract SellingStatus.QuantitySold from this value. For RelistFixedPriceItem:
0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings). For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, unless you set the OutOfStockControlPreference boolean field of the SetUserPreferences call to true, at least one variation must remain with a non-zero quantity in order for the listing to remain active. If you set the OutOfStockControlPreference field to true, a multiple-variation listing will remain active but hidden from search even if the quantity of all variations in the listing is set to 0. 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 User Guide for more details about setting and modifying a variation's quantity. Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .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. |
| ScheduledList.ItemArray.Item .Variations.Variation .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | 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. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .Variations.Variation .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. |
| ScheduledList.ItemArray.Item .Variations.Variation .SellingStatus.CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. 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 .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. |
|
ScheduledList.ItemArray.Item .Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the VariationSpecifics identifying values. 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 include the Item.InventoryTrackingMethod field in an 'FixedPriceItem' call and set its value to SKU, the Variation.SKU values become required for each variation..For GetItem, GetOrders and other 'Get' calls: Only returned if the seller specified a SKU for the variation. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See SKU identifiers. |
|
ScheduledList.ItemArray.Item .Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Pricing. |
| ScheduledList.ItemArray.Item .Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditionally,
repeatable: [2..5] |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of Item Specific names, but each variation must provide a unique combination of values for those Item Specific names. For example, if the items vary by color and size, then every variation must specify 'Color' and 'Size' as Item Specific names, but no two variations can specify the same combination of 'Color' and 'Size' values. When you revise a listing that includes variations, you can change names of Variationpecifics by using the Variations.ModifyNameList container. You can also add, 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 (order line items). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, Variationpecifics are not returned if the variation has a SKU. If the variation has no SKU, then Variationpecifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force Variationpecifics to be returned, even when the SKU is returned. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. 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 variations, 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:
For PlaceOffer: Required if the item being purchased includes Item Variations. For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required. Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name. For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing. Max length: 65. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI. If an item specific only supports a single value, only the first item specific value specified in the request will be used. For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description. Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning'). 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 Variationpecifics. 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]. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 120. 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.
|
| ScheduledList.PaginationResult | PaginationResultType | Conditionally |
This container shows the total numer of items that matched the input criteria and the total number of the results set. Users can use the Pagination.PageNumber field in the request to toggle through different pages in the results set.
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 call requests. 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. Returned with a value of 0 if no pages are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SellingSummary | SellingSummaryType | Conditionally |
This container consists of seller activity counts and values. For this container to be returned, the user must include the SellingSummary.Include field in the request and set its value to true.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .ActiveAuctionCount |
int | Conditionally |
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 .AuctionSellingCount |
int | Conditionally |
The total number of currently active auctions for a given seller. Equivalent to the "Auction Quantity" value in My eBay.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .SoldDurationInDays |
int | Conditionally |
The average duration, in days, of all items sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .TotalAuctionSellingValue |
AmountType (double) | Conditionally |
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 |
The total value of all items the seller has for sale in all listings. For a list of possible enumeration values, see CurrencyCodeType. |
| SellingSummary.TotalSoldCount | int | Conditionally |
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) | Conditionally |
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 |
The total monetary value of the items the seller has sold. For a list of possible enumeration values, see CurrencyCodeType. |
| SoldList | PaginatedOrderTransactionArrayType | Conditionally |
This container consists of order line items that have been sold. This container will be returned if the eBay user has one or more listings that have had recent sales. This container will not be returned in the response (even if there are one or more sales) if the DetailLevel value is set to ReturnSummary and the SoldList.Include field is omitted or set to false.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray | OrderTransactionArrayType | Conditionally |
Contains the list of orders.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction |
OrderTransactionType | Conditionally,
repeatable: [0..*] |
This container consists of detailed information on a specific order and each order line item in that order.
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 |
A unique identifier for an eBay order. This identifier is globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Note that the order ID will change for a 'non-immediate payment' order as it goes from an unpaid order to a paid order. Note: The value in the OrderID and ExtendedOrderID fields should always be the same. The ExtendedOrderID field was added back in 2019 during a transition period where the Trading API was supporting both old and new order ID formats, and which order ID format that was returned was dependent on the compatibility level version used. Max length: 40. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .RefundAmount |
AmountType (double) | Conditionally |
The amount of the refund due to, or already issued to the buyer for the order. This field is only returned in GetMyeBaySelling if a buyer refund is due, or was issued for the order.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .RefundAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The amount of the refund due to, or already issued to the buyer for the order. This field is only returned in GetMyeBaySelling if a buyer refund is due, or was issued for the order. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .RefundStatus |
string | Conditionally |
This string value indicates the result of a seller's refund to the buyer. Its value are 'Success', 'Failure' or 'Pending'. This field is only returned in GetMyeBaySelling if the buyer has received a refund from the seller, or is due to receive a refund.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .Subtotal |
AmountType (double) | Conditionally |
The cumulative item cost for all line items in the order. This value does not take into account any shipping/handling costs, sales tax costs, or any discounts. For a single line item order, the amount in this field should be the same as the amount in the Transaction.TransactionPrice field. For a multiple line item order, the amount in this field should equal the cumulative amount of each Transaction.TransactionPrice fields for each order line item. Note: For GetOrders only: This field, for backward compatibility, includes discounts from the TransactionPrice value and Order.Subtotal value. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .Subtotal [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cumulative item cost for all line items in the order. This value does not take into account any shipping/handling costs, sales tax costs, or any discounts. For a single line item order, the amount in this field should be the same as the amount in the Transaction.TransactionPrice field. For a multiple line item order, the amount in this field should equal the cumulative amount of each Transaction.TransactionPrice fields for each order line item. Note: For GetOrders only: This field, for backward compatibility, includes discounts from the TransactionPrice value and Order.Subtotal value. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray |
TransactionArrayType | Conditionally |
Container consisting of one or more line items that comprise an order. The data for each order line item in the order is stored in a separate Transaction container. Under the TransactionArray container in an AddOrder call, a seller or buyer specifies two or more (up to 40) order line items into a 'Combined Invoice' order. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Combined Invoice. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction |
TransactionType | Conditionally,
repeatable: [0..*] |
A Transaction container is returned for each line item in the order. This container consists of detailed information on one order line item. For the AddOrder call, a Transaction container is used to identified the unpaid order line items that are being combined into one Combined Invoice order. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer |
UserType | Conditionally |
Container consisting of user and shipping details for the order's buyer. To be returned by GetItemsAwaitingFeedback the seller must be the one making the request. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties. 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 |
This container shows the buyer's shipping address. Note: For an Authenticity Guarantee program order returned in GetItemTransactions or GetSellerTransactions, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer's shipping address. Note: For In-Store Pickup and Click and Collect orders, this is the address of the merchant's store where the buyer will pick up the order. This is only applicable for GetItemTransactions and GetSellerTransactions calls. Note: For eBay Vault scenarios: GetItemTransactions calls, and GetSellerTransactions calls (Seller View only), mock address details are returned for: <ShippingAddress> 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. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. 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. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) 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. For the GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field . 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, 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". Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: 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 Philippines site: 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 Philippines site 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". For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .ConvertedTransactionPrice |
AmountType (double) | Conditionally |
This field shows the converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned for sales transactions. This value should be the same as the value in TransactionPrice if the eBay listing site and the site that returned the response are the same, or use the same currency. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .ConvertedTransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field shows the converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned for sales transactions. This value should be the same as the value in TransactionPrice if the eBay listing site and the site that returned the response are the same, or use the same currency. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .CreatedDate |
dateTime | Conditionally |
This timestamp indicates date/time when the sales transaction occurred. A sales transaction is created when there is a commitment to buy, or when the buyer purchases the item through a 'Buy it Now' option. For auction listings, a sales transaction is created when that listing ends with a high bidder whose bid meets or exceeds the Reserve Price (if set). For a fixed-price listing or a 'Buy It Now' auction listing, a sales transaction is created once the buyer clicks the Buy button.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackLeft |
FeedbackInfoType | Conditionally |
This container consists of Feedback left by the caller for their order partner. This container is only returned if the order is complete and feedback on the order line item has been left by the caller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackLeft.CommentType |
CommentTypeCodeType | Conditionally |
This value indicates the Feedback rating for the user specified in the TargetUser field. This field is required in CompleteSale if the FeedbackInfo container is used. A Positive rating increases the user's Feedback score, a Negative rating decreases the user's Feedback score, and a Neutral rating does not affect the user's Feedback score. eBay users also have the right to withdraw feedback for whatever reason. Sellers cannot leave Neutral or Negative ratings for buyers. Applicable values: See CommentType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackReceived |
FeedbackInfoType | Conditionally |
This container consists of Feedback received by the caller from their order partner. This container is only returned if the order is complete and feedback on the order line item has been received by the caller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackReceived.CommentType |
CommentTypeCodeType | Conditionally |
This value indicates the Feedback rating for the user specified in the TargetUser field. This field is required in CompleteSale if the FeedbackInfo container is used. A Positive rating increases the user's Feedback score, a Negative rating decreases the user's Feedback score, and a Neutral rating does not affect the user's Feedback score. eBay users also have the right to withdraw feedback for whatever reason. Sellers cannot leave Neutral or Negative ratings for buyers. Applicable values: See CommentType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .IsMultiLegShipping |
boolean | Conditionally |
Order line items requiring multiple shipping legs include items being shipped through the Global Shipping Program or through eBay International Shipping, as well as order line items subject to/eligible for the Authenticity Guarantee program. For both international shipping options, the address of the shipping logistics provider is shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress container. Similarly, for Authenticity Guarantee orders, the authentication partner's shipping address is shown in the same container. If an order line item is subject to the Authenticity Guarantee service, the Transaction.Program container will be returned. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item |
ItemType | Conditionally |
This container consists of relevant details about the listing associated with the sales transaction. Which listing fields are returned under this container will depend on the listing, the eBay marketplace, and the API call. In an AddOrder call, only the unique identifier of the listing (ItemID) is needed to help identify the sales transaction to combine into a 'Combined Invoice' order. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.BuyItNowPrice |
AmountType (double) | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. 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 |
The email and phone lead fee for a pay-per-lead item. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.HideFromSearch |
boolean | Conditionally |
This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
|
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ItemID |
ItemIDType (string) | Conditionally |
The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified. 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. Your code should be prepared to handle IDs of up to 19 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. In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
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.
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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingType |
ListingTypeCodeType | Conditionally |
The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value). If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings. This field is not applicable to Revise calls because the selling format of active listings cannot be changed. Applicable values: See ListingType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing types. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PictureDetails |
PictureDetailsType | Conditionally |
This container consists of the data associated with photos within the listing. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. It is required that all listings have at least one picture. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PictureDetails .GalleryURL |
anyURI | Conditionally |
This field shows the URL for the gallery image of an item returned in GetMyeBayBuying and GetMyeBaySelling. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PrivateNotes |
string | Conditionally |
A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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). |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Quantity |
int | Conditionally |
For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations. For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1. For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and three items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.When eBay auto-renews a GTC listing (ListingDuration = GTC) on your behalf, eBay relists with correct quantity available. For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1. 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. For order line item 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). Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.QuantityAvailable |
int | Conditionally |
This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.
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. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ReasonHideFromSearch |
ReasonHideFromSearchCodeType | Conditionally |
This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.
Applicable values: This enumeration value is associated with eBay Duplicate Listings Policy, which is applicable on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page. Code so that your app gracefully handles any future changes to this list. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ReservePrice |
AmountType (double) | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles |
SellerProfilesType | Conditionally |
This container is used if the seller would like to use/reference business policies to create, revise, relist, or verify their listing. The seller's account must be opted in to business policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy must be specified and applied to the listing. If the seller's account is not opted in to business policies, that seller may not use this container. Sellers must opt-in to business policies through My eBay or by using the optInToProgram call of the eBay Account API. If business policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request. Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. This container is only returned in 'Get' calls if business policies are set for the listing, and the person making the API call is the seller of the listing. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify API call to reference and use the settings/values of a payment business policy. Payment business policies contain a setting to control whether immediate payment is required, settings to specify due dates for the deposit and full payment of a motor vehicle listing (Motors policy only), and settings to specify which offline payment methods are avaiable to buyers for sales transactions that happen off of eBay's platform. Multiple payment business policies can be created and saved at the account level by sellers. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. Note: Sellers will never have to specify electronic payment methods, but offline payment methods are required for listings where offline payment is required or supported. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerPaymentProfile .PaymentProfileID |
long | Conditionally |
The unique identifier of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a return business policy. Return business policies contain detailed information on the seller's return policy for domestic and international buyers (if the seller ships internationally), including whether or not the seller accepts returns from domestic and international buyers, how many days the buyer has to return the item for a refund, and who pays the return shipping costs. Multiple return policy business policies can be created and saved at the account level by sellers. Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container. This container is only returned in 'Get' calls if Business Policies are set for the listing and the person making the API call is the seller of the listing. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. Return policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a specific shipping business policy. Shipping business policies contain detailed information on domestic and international shipping, including shipping service options and costs, handling time, shipping discount information, and excluded ship-to locations. Multiple shipping business policies can be created and saved at the account level by sellers. Note: Any shipping inclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a shipping business policy. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shippping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence. Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ShipppingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a shipping business policy. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shipping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShippingProfileID takes precedence. In the 'Get' calls, the ShippingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
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, the current high bidder, quantity sold, current price, and listing status.
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 |
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. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price 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 |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. 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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. 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 order, including flat and calculated shipping costs. Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the ShippingDetails container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container. If you do not use a fulfillment business policy, many of the fields under this ShippingDetails container become required in your request. Note: For ReviseItem and ReviseFixedPriceItem calls: If you are updating any field under the ShippingDetails container, you must include all containers and fields set under this container even if their values are not changing. If you do not do this, some fields may be removed from the listing. To find out the values included in the current listing, call GetItem and look through the ShippingDetails container in the response. For additional information, see Revise shipping details. 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, 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 any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform. Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
For GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .GlobalShipping |
boolean | Conditionally |
Note: The Global Shipping Program (GSP) is only available on the UK marketplace. On the US marketplace, the Global Shipping Program was replaced by the intermediated international shipping program called eBay International Shipping. eBay International Shipping is an account level setting, and no field will need to be set in a add/revise call to enable this setting. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into eBay International Shipping, that same seller can still also specify individual international shipping service options through the ShippingDetails.InternationalShippingServiceOption container. In an Add/Revise/Relist call, this boolean field can be included and set to True if the seller would like to use eBay's Global Shipping Program for orders that are shipped internationally. In 'Get' calls, if this field is returned as True, it indicates that international shipping through the Global Shipping Program is available for the listing. If this field is returned as False, the seller is responsible for shipping the item internationally using one of the specified international shipping service options set for the listing. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. 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> 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 four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (unbounded) fields 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 .LocalPickup |
boolean | Conditionally |
The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. 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 |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingType |
ShippingTypeCodeType | Conditionally |
The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these. GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.
Applicable values: See ShippingType. Code so that your app gracefully handles any future changes to this list. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SKU |
SKUType (string) | Conditionally |
A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus 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 an order line item is created. (SKU is recommended as an alternative to ApplicationData.) If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request. Note: The eBay site 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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing. 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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | 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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. 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 Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Title |
string | Conditionally |
This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours. Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations |
VariationsType | Conditionally |
Variations are similar (but not identical) items in a multiple-variation, 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 order line item can contain multiple items from a single variation.) If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories. 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 purchases, 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.) For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request. Note: This container will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one item variation from another. For example, if an item varies 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 item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call. When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .Quantity |
int | Conditionally |
This value indicates the quantity of the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total quantity associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract SellingStatus.QuantitySold from this value. For RelistFixedPriceItem:
0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings). For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, unless you set the OutOfStockControlPreference boolean field of the SetUserPreferences call to true, at least one variation must remain with a non-zero quantity in order for the listing to remain active. If you set the OutOfStockControlPreference field to true, a multiple-variation listing will remain active but hidden from search even if the quantity of all variations in the listing is set to 0. 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 User Guide for more details about setting and modifying a variation's quantity. Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .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. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | 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. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .SellingStatus.CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. 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.Variations.Variation .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. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the VariationSpecifics identifying values. 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 include the Item.InventoryTrackingMethod field in an 'FixedPriceItem' call and set its value to SKU, the Variation.SKU values become required for each variation..For GetItem, GetOrders and other 'Get' calls: Only returned if the seller specified a SKU for the variation. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See SKU identifiers. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Pricing. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditionally,
repeatable: [2..5] |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of Item Specific names, but each variation must provide a unique combination of values for those Item Specific names. For example, if the items vary by color and size, then every variation must specify 'Color' and 'Size' as Item Specific names, but no two variations can specify the same combination of 'Color' and 'Size' values. When you revise a listing that includes variations, you can change names of Variationpecifics by using the Variations.ModifyNameList container. You can also add, 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 (order line items). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, Variationpecifics are not returned if the variation has a SKU. If the variation has no SKU, then Variationpecifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force Variationpecifics to be returned, even when the SKU is returned. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
SoldList.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 variations, 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:
For PlaceOffer: Required if the item being purchased includes Item Variations. For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required. Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name. For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing. Max length: 65. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI. If an item specific only supports a single value, only the first item specific value specified in the request will be used. For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description. Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning'). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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 Variationpecifics. 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]. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 120. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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. |
|
SoldList.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.
|
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .OrderLineItemID |
string | Always |
A unique identifier for an eBay order line item. This identifier is created as soon as there is a commitment to buy from the seller, or the buyer actually purchases the item using a 'Buy it Now' option. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, order line item ID is only returned to the buyer or seller, and a dummy value of 10000000000000 will be returned to all third parties. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .PaidTime |
dateTime | Conditionally |
Indicates the time when the buyer paid for the order and/or order was marked as 'Paid' by the seller. This field is returned once payment has been made by the buyer. This value will only be visible to the user on either side of the order. An order can be marked as 'Paid' in the following ways:
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Platform |
TransactionPlatformCodeType | Conditionally |
This value indicates the site on which the sales transaction originated. Note: Currently, the only value that should be returned in this field is eBay, as the Half.com marketplace no longer exists.
Applicable values: (Not all values in TransactionPlatformCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .QuantityPurchased |
int | Conditionally |
This value indicates the quantity of the line item purchased at the same time by the same buyer from one listing. For auction listings, this value is always '1'. For fixed-price, non-variation listings, this value can be greater than 1.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .SellerPaidStatus |
PaidStatusCodeType | Conditionally |
Specifies the paid status of the order.
Applicable values: See SellerPaidStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .ShippedTime |
dateTime | Conditionally |
Indicates the time when the line item was marked as 'Shipped'. This value will only be visible to the user on either side of the order. An order can be marked as 'Shipped' by purchasing an eBay shipping label, providing shipment tracking in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call. Note: This field does not appear in the Sell Feed API's LMS_ORDER_REPORT responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in the LMS_ORDER_REPORT responses.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Status |
TransactionStatusType | Conditionally |
Container consisting of checkout/payment status details for an order line item. Several of these fields change values during the checkout flow. For GetOrders, only a limited number of applicable fields are returned at the order line item level. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Status.PaymentHoldStatus |
PaymentHoldStatusCodeType | Always |
This field indicates the type and/or status of a payment hold on the item. If there is no hold against the item, this field is returned with a value of NotApplicable. Note: For the GetItemTransactions and GetOrders, calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Applicable values: See PaymentHoldStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TotalPrice |
AmountType (double) | Conditionally |
This field indicates the total price for a sales transaction. Before payment, this dollar value will be the price before a shipping service option is selected. Once a shipping service option is selected, the price in this field will be updated to reflect the shipping and handling costs associated with that shipping service option.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TotalPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field indicates the total price for a sales transaction. Before payment, this dollar value will be the price before a shipping service option is selected. Once a shipping service option is selected, the price in this field will be updated to reflect the shipping and handling costs associated with that shipping service option. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TotalTransactionPrice |
AmountType (double) | Conditionally |
The sale price of the order line item. This amount does not take into account shipping and handling charges, sales tax, or any other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, this value will reflect that. So, if the base cost of the order line item was $15.00, and a quantity of two were purchased (Transaction.QuantityPurchased) the value in this field would show as 30.00. To see the full price of the order line item, including any shipping and handling charges, and any sales tax, the (Transaction.TotalPrice) field value should be viewed instead. However, note that the TotalPrice field value is only updated after a shipping service option is selected and payment is made. And if the seller is offering free shipping, the values in the TotalTransactionPrice and the TotalPrice fields may be the same. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TotalTransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The sale price of the order line item. This amount does not take into account shipping and handling charges, sales tax, or any other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, this value will reflect that. So, if the base cost of the order line item was $15.00, and a quantity of two were purchased (Transaction.QuantityPurchased) the value in this field would show as 30.00. To see the full price of the order line item, including any shipping and handling charges, and any sales tax, the (Transaction.TotalPrice) field value should be viewed instead. However, note that the TotalPrice field value is only updated after a shipping service option is selected and payment is made. And if the seller is offering free shipping, the values in the TotalTransactionPrice and the TotalPrice fields may be the same. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TransactionID |
string | Conditionally |
Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment from a buyer to purchase an item, or if/when the buyer actually purchases the line item through a 'Buy it Now' option. An ItemID/TransactionID pair can be used and referenced during an order checkout flow to identify a line item. The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing. Note: Beginning in July 2024, non-zero transaction IDs will start being returned for auction listings. If necessary, update code to handle non-zero transaction IDs for auction transactions before this time. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer and seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, transaction ID is only returned to the buyer and seller, and a dummy value of 10000000000000 will be returned to all third parties.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction |
TransactionType | Conditionally |
Contains the information describing a transaction.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Buyer |
UserType | Conditionally |
Container consisting of user and shipping details for the order's buyer. To be returned by GetItemsAwaitingFeedback the seller must be the one making the request. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Buyer.BuyerInfo .ShippingAddress |
AddressType | Conditionally |
This container shows the buyer's shipping address. Note: For an Authenticity Guarantee program order returned in GetItemTransactions or GetSellerTransactions, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer's shipping address. Note: For In-Store Pickup and Click and Collect orders, this is the address of the merchant's store where the buyer will pick up the order. This is only applicable for GetItemTransactions and GetSellerTransactions calls. Note: For eBay Vault scenarios: GetItemTransactions calls, and GetSellerTransactions calls (Seller View only), mock address details are returned for: <ShippingAddress> DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Buyer.BuyerInfo .ShippingAddress.PostalCode |
string | Conditionally |
User's postal code. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Buyer.Email |
string | Conditionally |
Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) 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. For the GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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, 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". Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: 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 Philippines site: 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 Philippines site 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". For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .ConvertedTransactionPrice |
AmountType (double) | Conditionally |
This field shows the converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned for sales transactions. This value should be the same as the value in TransactionPrice if the eBay listing site and the site that returned the response are the same, or use the same currency. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .ConvertedTransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field shows the converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned for sales transactions. This value should be the same as the value in TransactionPrice if the eBay listing site and the site that returned the response are the same, or use the same currency. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .CreatedDate |
dateTime | Conditionally |
This timestamp indicates date/time when the sales transaction occurred. A sales transaction is created when there is a commitment to buy, or when the buyer purchases the item through a 'Buy it Now' option. For auction listings, a sales transaction is created when that listing ends with a high bidder whose bid meets or exceeds the Reserve Price (if set). For a fixed-price listing or a 'Buy It Now' auction listing, a sales transaction is created once the buyer clicks the Buy button.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .FeedbackLeft |
FeedbackInfoType | Conditionally |
This container consists of Feedback left by the caller for their order partner. This container is only returned if the order is complete and feedback on the order line item has been left by the caller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .FeedbackLeft.CommentType |
CommentTypeCodeType | Conditionally |
This value indicates the Feedback rating for the user specified in the TargetUser field. This field is required in CompleteSale if the FeedbackInfo container is used. A Positive rating increases the user's Feedback score, a Negative rating decreases the user's Feedback score, and a Neutral rating does not affect the user's Feedback score. eBay users also have the right to withdraw feedback for whatever reason. Sellers cannot leave Neutral or Negative ratings for buyers. Applicable values: See CommentType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .FeedbackReceived |
FeedbackInfoType | Conditionally |
This container consists of Feedback received by the caller from their order partner. This container is only returned if the order is complete and feedback on the order line item has been received by the caller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .FeedbackReceived.CommentType |
CommentTypeCodeType | Conditionally |
This value indicates the Feedback rating for the user specified in the TargetUser field. This field is required in CompleteSale if the FeedbackInfo container is used. A Positive rating increases the user's Feedback score, a Negative rating decreases the user's Feedback score, and a Neutral rating does not affect the user's Feedback score. eBay users also have the right to withdraw feedback for whatever reason. Sellers cannot leave Neutral or Negative ratings for buyers. Applicable values: See CommentType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .IsMultiLegShipping |
boolean | Conditionally |
Order line items requiring multiple shipping legs include items being shipped through the Global Shipping Program or through eBay International Shipping, as well as order line items subject to/eligible for the Authenticity Guarantee program. For both international shipping options, the address of the shipping logistics provider is shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress container. Similarly, for Authenticity Guarantee orders, the authentication partner's shipping address is shown in the same container. If an order line item is subject to the Authenticity Guarantee service, the Transaction.Program container will be returned. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item |
ItemType | Conditionally |
This container consists of relevant details about the listing associated with the sales transaction. Which listing fields are returned under this container will depend on the listing, the eBay marketplace, and the API call. In an AddOrder call, only the unique identifier of the listing (ItemID) is needed to help identify the sales transaction to combine into a 'Combined Invoice' order. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.BuyItNowPrice |
AmountType (double) | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item .ClassifiedAdPayPerLeadFee |
AmountType (double) | Conditionally |
The email and phone lead fee for a pay-per-lead item.
DetailLevel: ReturnAll. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item .ClassifiedAdPayPerLeadFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The email and phone lead fee for a pay-per-lead item. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.HideFromSearch |
boolean | Conditionally |
This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
|
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ItemID |
ItemIDType (string) | Conditionally |
The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified. 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. Your code should be prepared to handle IDs of up to 19 digits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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. In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ListingType |
ListingTypeCodeType | Conditionally |
The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value). If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings. This field is not applicable to Revise calls because the selling format of active listings cannot be changed. Applicable values: See ListingType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing types. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.PictureDetails |
PictureDetailsType | Conditionally |
This container consists of the data associated with photos within the listing. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. It is required that all listings have at least one picture. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.PictureDetails .GalleryURL |
anyURI | Conditionally |
This field shows the URL for the gallery image of an item returned in GetMyeBayBuying and GetMyeBaySelling. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.PrivateNotes |
string | Conditionally |
A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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). |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Quantity |
int | Conditionally |
For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations. For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1. For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and three items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.When eBay auto-renews a GTC listing (ListingDuration = GTC) on your behalf, eBay relists with correct quantity available. For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1. 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. For order line item 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). Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.QuantityAvailable |
int | Conditionally |
This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.QuestionCount |
long | Conditionally | Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ReasonHideFromSearch |
ReasonHideFromSearchCodeType | Conditionally |
This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.
Applicable values: This enumeration value is associated with eBay Duplicate Listings Policy, which is applicable on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page. Code so that your app gracefully handles any future changes to this list. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ReservePrice |
AmountType (double) | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles |
SellerProfilesType | Conditionally |
This container is used if the seller would like to use/reference business policies to create, revise, relist, or verify their listing. The seller's account must be opted in to business policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy must be specified and applied to the listing. If the seller's account is not opted in to business policies, that seller may not use this container. Sellers must opt-in to business policies through My eBay or by using the optInToProgram call of the eBay Account API. If business policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request. Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. This container is only returned in 'Get' calls if business policies are set for the listing, and the person making the API call is the seller of the listing. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify API call to reference and use the settings/values of a payment business policy. Payment business policies contain a setting to control whether immediate payment is required, settings to specify due dates for the deposit and full payment of a motor vehicle listing (Motors policy only), and settings to specify which offline payment methods are avaiable to buyers for sales transactions that happen off of eBay's platform. Multiple payment business policies can be created and saved at the account level by sellers. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. Note: Sellers will never have to specify electronic payment methods, but offline payment methods are required for listings where offline payment is required or supported. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerPaymentProfile .PaymentProfileID |
long | Conditionally |
The unique identifier of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a return business policy. Return business policies contain detailed information on the seller's return policy for domestic and international buyers (if the seller ships internationally), including whether or not the seller accepts returns from domestic and international buyers, how many days the buyer has to return the item for a refund, and who pays the return shipping costs. Multiple return policy business policies can be created and saved at the account level by sellers. Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container. This container is only returned in 'Get' calls if Business Policies are set for the listing and the person making the API call is the seller of the listing. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. Return policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a specific shipping business policy. Shipping business policies contain detailed information on domestic and international shipping, including shipping service options and costs, handling time, shipping discount information, and excluded ship-to locations. Multiple shipping business policies can be created and saved at the account level by sellers. Note: Any shipping inclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a shipping business policy. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shippping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence. Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ShipppingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a shipping business policy. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shipping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShippingProfileID takes precedence. In the 'Get' calls, the ShippingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | 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. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price 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.Transaction .Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. 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.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.Transaction .Item.ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an order, including flat and calculated shipping costs. Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the ShippingDetails container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container. If you do not use a fulfillment business policy, many of the fields under this ShippingDetails container become required in your request. Note: For ReviseItem and ReviseFixedPriceItem calls: If you are updating any field under the ShippingDetails container, you must include all containers and fields set under this container even if their values are not changing. If you do not do this, some fields may be removed from the listing. To find out the values included in the current listing, call GetItem and look through the ShippingDetails container in the response. For additional information, see Revise shipping details. 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, 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 any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform. Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
For GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .GlobalShipping |
boolean | Conditionally |
Note: The Global Shipping Program (GSP) is only available on the UK marketplace. On the US marketplace, the Global Shipping Program was replaced by the intermediated international shipping program called eBay International Shipping. eBay International Shipping is an account level setting, and no field will need to be set in a add/revise call to enable this setting. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into eBay International Shipping, that same seller can still also specify individual international shipping service options through the ShippingDetails.InternationalShippingServiceOption container. In an Add/Revise/Relist call, this boolean field can be included and set to True if the seller would like to use eBay's Global Shipping Program for orders that are shipped internationally. In 'Get' calls, if this field is returned as True, it indicates that international shipping through the Global Shipping Program is available for the listing. If this field is returned as False, the seller is responsible for shipping the item internationally using one of the specified international shipping service options set for the listing. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. 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> 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 four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions .LocalPickup |
boolean | Conditionally |
The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingType |
ShippingTypeCodeType | Conditionally |
The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these. GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.
Applicable values: See ShippingType. Code so that your app gracefully handles any future changes to this list. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.SKU |
SKUType (string) | Conditionally |
A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus 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 an order line item is created. (SKU is recommended as an alternative to ApplicationData.) If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request. Note: The eBay site 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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
SoldList.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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | 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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.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 Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Title |
string | Conditionally |
This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours. Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations |
VariationsType | Conditionally |
Variations are similar (but not identical) items in a multiple-variation, 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 order line item can contain multiple items from a single variation.) If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories. 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 purchases, 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.) For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request. Note: This container will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one item variation from another. For example, if an item varies 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 item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call. When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .Quantity |
int | Conditionally |
This value indicates the quantity of the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total quantity associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract SellingStatus.QuantitySold from this value. For RelistFixedPriceItem:
0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings). For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, unless you set the OutOfStockControlPreference boolean field of the SetUserPreferences call to true, at least one variation must remain with a non-zero quantity in order for the listing to remain active. If you set the OutOfStockControlPreference field to true, a multiple-variation listing will remain active but hidden from search even if the quantity of all variations in the listing is set to 0. 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 User Guide for more details about setting and modifying a variation's quantity. Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .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. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | 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. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .SellingStatus.CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. 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.Transaction .Item.Variations.Variation .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. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the VariationSpecifics identifying values. 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 include the Item.InventoryTrackingMethod field in an 'FixedPriceItem' call and set its value to SKU, the Variation.SKU values become required for each variation..For GetItem, GetOrders and other 'Get' calls: Only returned if the seller specified a SKU for the variation. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See SKU identifiers. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Pricing. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditionally,
repeatable: [2..5] |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of Item Specific names, but each variation must provide a unique combination of values for those Item Specific names. For example, if the items vary by color and size, then every variation must specify 'Color' and 'Size' as Item Specific names, but no two variations can specify the same combination of 'Color' and 'Size' values. When you revise a listing that includes variations, you can change names of Variationpecifics by using the Variations.ModifyNameList container. You can also add, 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 (order line items). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, Variationpecifics are not returned if the variation has a SKU. If the variation has no SKU, then Variationpecifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force Variationpecifics to be returned, even when the SKU is returned. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
SoldList.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 variations, 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:
For PlaceOffer: Required if the item being purchased includes Item Variations. For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required. Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name. For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing. Max length: 65. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI. If an item specific only supports a single value, only the first item specific value specified in the request will be used. For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description. Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning'). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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 Variationpecifics. 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]. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 120. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.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. |
|
SoldList.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.
|
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .OrderLineItemID |
string | Always |
A unique identifier for an eBay order line item. This identifier is created as soon as there is a commitment to buy from the seller, or the buyer actually purchases the item using a 'Buy it Now' option. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, order line item ID is only returned to the buyer or seller, and a dummy value of 10000000000000 will be returned to all third parties. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .PaidTime |
dateTime | Conditionally |
Indicates the time when the buyer paid for the order and/or order was marked as 'Paid' by the seller. This field is returned once payment has been made by the buyer. This value will only be visible to the user on either side of the order. An order can be marked as 'Paid' in the following ways:
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Platform |
TransactionPlatformCodeType | Conditionally |
This value indicates the site on which the sales transaction originated. Note: Currently, the only value that should be returned in this field is eBay, as the Half.com marketplace no longer exists.
Applicable values: (Not all values in TransactionPlatformCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .QuantityPurchased |
int | Conditionally |
This value indicates the quantity of the line item purchased at the same time by the same buyer from one listing. For auction listings, this value is always '1'. For fixed-price, non-variation listings, this value can be greater than 1.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .SellerPaidStatus |
PaidStatusCodeType | Conditionally |
Specifies the paid status of the order.
Applicable values: See SellerPaidStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .ShippedTime |
dateTime | Conditionally |
Indicates the time when the line item was marked as 'Shipped'. This value will only be visible to the user on either side of the order. An order can be marked as 'Shipped' by purchasing an eBay shipping label, providing shipment tracking in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call. Note: This field does not appear in the Sell Feed API's LMS_ORDER_REPORT responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in the LMS_ORDER_REPORT responses.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Status |
TransactionStatusType | Conditionally |
Container consisting of checkout/payment status details for an order line item. Several of these fields change values during the checkout flow. For GetOrders, only a limited number of applicable fields are returned at the order line item level. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .Status.PaymentHoldStatus |
PaymentHoldStatusCodeType | Always |
This field indicates the type and/or status of a payment hold on the item. If there is no hold against the item, this field is returned with a value of NotApplicable. Note: For the GetItemTransactions and GetOrders, calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Applicable values: See PaymentHoldStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .TotalPrice |
AmountType (double) | Conditionally |
This field indicates the total price for a sales transaction. Before payment, this dollar value will be the price before a shipping service option is selected. Once a shipping service option is selected, the price in this field will be updated to reflect the shipping and handling costs associated with that shipping service option.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .TotalPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field indicates the total price for a sales transaction. Before payment, this dollar value will be the price before a shipping service option is selected. Once a shipping service option is selected, the price in this field will be updated to reflect the shipping and handling costs associated with that shipping service option. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .TotalTransactionPrice |
AmountType (double) | Conditionally |
The sale price of the order line item. This amount does not take into account shipping and handling charges, sales tax, or any other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, this value will reflect that. So, if the base cost of the order line item was $15.00, and a quantity of two were purchased (Transaction.QuantityPurchased) the value in this field would show as 30.00. To see the full price of the order line item, including any shipping and handling charges, and any sales tax, the (Transaction.TotalPrice) field value should be viewed instead. However, note that the TotalPrice field value is only updated after a shipping service option is selected and payment is made. And if the seller is offering free shipping, the values in the TotalTransactionPrice and the TotalPrice fields may be the same. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray .OrderTransaction.Transaction .TotalTransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The sale price of the order line item. This amount does not take into account shipping and handling charges, sales tax, or any other costs related to the order line item. If multiple units were purchased through a non- variation, fixed-price listing, this value will reflect that. So, if the base cost of the order line item was $15.00, and a quantity of two were purchased (Transaction.QuantityPurchased) the value in this field would show as 30.00. To see the full price of the order line item, including any shipping and handling charges, and any sales tax, the (Transaction.TotalPrice) field value should be viewed instead. However, note that the TotalPrice field value is only updated after a shipping service option is selected and payment is made. And if the seller is offering free shipping, the values in the TotalTransactionPrice and the TotalPrice fields may be the same. For a list of possible enumeration values, see CurrencyCodeType. |
|
SoldList.OrderTransactionArray .OrderTransaction.Transaction .TransactionID |
string | Conditionally |
Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment from a buyer to purchase an item, or if/when the buyer actually purchases the line item through a 'Buy it Now' option. An ItemID/TransactionID pair can be used and referenced during an order checkout flow to identify a line item. The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing. Note: Beginning in July 2024, non-zero transaction IDs will start being returned for auction listings. If necessary, update code to handle non-zero transaction IDs for auction transactions before this time. For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer and seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, transaction ID is only returned to the buyer and seller, and a dummy value of 10000000000000 will be returned to all third parties.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.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. |
|
SoldList.PaginationResult .TotalNumberOfEntries |
int | Conditionally |
Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.PaginationResult .TotalNumberOfPages |
int | Conditionally |
Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Summary | MyeBaySellingSummaryType | Always |
This container consists of seller activity counts and values. This container is always returned if there has been recent sell activity.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Summary.ActiveAuctionCount | int | Conditionally |
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. |
| Summary.AmountLimitRemaining | AmountType (double) | Conditionally |
The total value of the items listed price that this seller can list. This amount is the total of the prices specified upon listing. For example, for fixed price listings, this is the total of the fixed price amounts. For auction listings, this is the total of the starting prices. The seller will be unable to list an item if the amount of the item's fixed price or starting price (for auctions) exceeds the amount limit. This is part of the seller limit, which can be increased by requesting an increase from eBay using the "Request higher selling limits" link in the All Selling section of My eBay. (Under "Selling Limits".) Notice that the quantity limit (see QuantityLimitRemaining) may be reached before the amount limit is reached.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Seller Limits. |
| Summary.AmountLimitRemaining [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The total value of the items listed price that this seller can list. This amount is the total of the prices specified upon listing. For example, for fixed price listings, this is the total of the fixed price amounts. For auction listings, this is the total of the starting prices. The seller will be unable to list an item if the amount of the item's fixed price or starting price (for auctions) exceeds the amount limit. This is part of the seller limit, which can be increased by requesting an increase from eBay using the "Request higher selling limits" link in the All Selling section of My eBay. (Under "Selling Limits".) Notice that the quantity limit (see QuantityLimitRemaining) may be reached before the amount limit is reached. For a list of possible enumeration values, see CurrencyCodeType. |
| Summary.AuctionSellingCount | int | Conditionally |
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. |
| Summary.ClassifiedAdCount | int | Conditionally |
The total number of Classified Ad listings listed by the seller.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Summary.QuantityLimitRemaining | long | Conditionally |
The quantity of items that this seller can list. This number refers to the total quantity of items in all listings. For example, if the seller's limit was a quantity of 100, this could be 100 listings of one item each, or one listing with a quantity of 100 items. The seller will be unable to list additional items or quantities of items for sale in excess of this number for the current month unless the seller requests an increase from eBay using the "Request higher selling limits" link in the All Selling section of My eBay. (Under "Selling Limits".) Notice that the amount limit (see AmountLimitRemaining) may be reached before the quantity limit is reached.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Seller Limits. |
| Summary.SoldDurationInDays | int | Conditionally |
The average duration, in days, of all items sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
Summary .TotalAuctionSellingValue |
AmountType (double) | Conditionally |
For all items that the seller has for sale, the total selling values of those items having bids and where the Reserve price is met (if a Reserve price is specified).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Summary .TotalAuctionSellingValue [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
For all items that the seller has for sale, the total selling values of those items having bids and where the Reserve price is met (if a Reserve price is specified). For a list of possible enumeration values, see CurrencyCodeType. |
| Summary.TotalListingsWithLeads | int | Conditionally |
The total number of Classified Ad listings that have an associated lead.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Summary.TotalSoldCount | int | Conditionally |
The total number of items that the seller has sold in the past 31 days.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Summary.TotalSoldValue | AmountType (double) | Conditionally |
The total monetary value of the items the seller has sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Summary.TotalSoldValue [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The total monetary value of the items the seller has sold. For a list of possible enumeration values, see CurrencyCodeType. |
| UnsoldList | PaginatedItemArrayType | Conditionally |
This container consists of listings that have ended without sales. This container will be returned if the eBay user has one or more listings that have ended without sales. This container will not be returned in the response (even if there are one or more listings that ended without sales) if the DetailLevel value is set to ReturnSummary and the UnsoldList.Include field is omitted or set to false.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| UnsoldList.ItemArray | ItemArrayType | Conditionally |
An array of one or more items returned under one or more containers in a GetMyeBayBuying or GetMyeBaySelling call response.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| UnsoldList.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 the eBayAuthToken) has an order 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. Note: When making a GetSellerList call, items that are on-hold due to an eBay policy violation will not be returned in the response. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .BuyItNowPrice |
AmountType (double) | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| UnsoldList.ItemArray.Item .BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.ItemArray.Item .ClassifiedAdPayPerLeadFee |
AmountType (double) | Conditionally |
The email and phone lead fee for a pay-per-lead item.
DetailLevel: ReturnAll. |
| UnsoldList.ItemArray.Item .ClassifiedAdPayPerLeadFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The email and phone lead fee for a pay-per-lead item. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.ItemArray.Item .eBayNotes |
string | Conditionally |
Returns a note from eBay displayed below items in the user's My eBay account.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .HideFromSearch |
boolean | Conditionally |
This boolean field is returned as true if the listing has been hidden from all searches occurring on eBay. If a listing is hidden from eBay searches, the reason can be found in the ReasonHideFromSearch field.
|
|
UnsoldList.ItemArray.Item .ItemID |
ItemIDType (string) | Conditionally |
The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified. 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. Your code should be prepared to handle IDs of up to 19 digits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.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. |
|
UnsoldList.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. In an Add/Revise/Relist call, this container is used to set the Best Offer Auto-Accept and Best Offer Auto-Decline threshold values. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.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. Note: As of April 1, 2019, 'GTC' is the only supported listing duration for all eBay marketplaces with the following exceptions:
GTC is specified in this field, it will be ignored, and GTC will be used instead.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ListingDurationCodeType |
|
UnsoldList.ItemArray.Item .ListingType |
ListingTypeCodeType | Conditionally |
The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value). If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings. This field is not applicable to Revise calls because the selling format of active listings cannot be changed. Applicable values: See ListingType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing types. |
|
UnsoldList.ItemArray.Item .PictureDetails |
PictureDetailsType | Conditionally |
This container consists of the data associated with photos within the listing. Sellers can have up to 24 pictures in almost any category at no cost. Motor vehicle listings are an exception. The number of included pictures in motor vehicle listings depend on the selected vehicle package (see Fees for selling vehicles on eBay Motors). These photos can be hosted by eBay Picture Services (EPS), or the seller can host pictures on a non-eBay server. If pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. It is required that all listings have at least one picture. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .PictureDetails.GalleryURL |
anyURI | Conditionally |
This field shows the URL for the gallery image of an item returned in GetMyeBayBuying and GetMyeBaySelling. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .PrivateNotes |
string | Conditionally |
A note that a user makes on an item from their My eBay account. GetMyeBayBuying and GetMyeBaySelling return this field, and only if you pass in the IncludeNotes field in the request, and set its value to true. This field will only be returned if set for an item, and only returned 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). |
|
UnsoldList.ItemArray.Item .Quantity |
int | Conditionally |
For AddItem family of calls: The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. If this field is not included when creating a new fixed-price listing, quantity defaults to '1'. If variations are specified in AddFixedPriceItem or VerifyAddFixedPriceItem, the Item.Quantity is not required since the quantity of variations is specified in Variation.Quantity instead. See the Creating a listing with variations eBay Help page for more information on variations. For ReviseItem and ReviseFixedPriceItem: This value can only be changed for a fixed-price listing with no variations. The quantity of variations is controlled in the Variation.Quantity field and the Item.Quantity value for an auction listing should always be 1. For RelistItem and RelistFixedPriceItem: Like most fields, when you use RelistItem or RelistFixedPriceItem, Quantity retains its original value unless you specifically change it. This means that the item is relisted with the value that was already in Quantity, not with the remaining quantity available. For example, if the original Quantity value was 10, and three items have been sold, eBay sets the relisted item's Quantity to 10 by default, and not 7. So, we strongly recommend that you always set Quantity to the correct value (your actual quantity available) in your relist requests.When eBay auto-renews a GTC listing (ListingDuration = GTC) on your behalf, eBay relists with correct quantity available. For GetSellerEvents: Quantity is only returned for listings where item quantity is greater than 1. 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. For order line item 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). Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .QuantityAvailable |
int | Conditionally |
This integer value indicates the quantity of an item that is still available for purchase in a multiple-quantity, fixed-price listing. This field is not applicable to auction listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .QuestionCount |
long | Conditionally | Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. |
|
UnsoldList.ItemArray.Item .ReasonHideFromSearch |
ReasonHideFromSearchCodeType | Conditionally |
This field is returned only when the listing is currently being hidden from any searches occurring on eBay. Listings may be hidden from search if an active listing is currently out of stock or if the listing has been determined by eBay to be a duplicate listing.
Applicable values: This enumeration value is associated with eBay Duplicate Listings Policy, which is applicable on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this policy. For more information, read eBay's Duplicate Listings Policy help page. Code so that your app gracefully handles any future changes to this list. |
|
UnsoldList.ItemArray.Item .Relisted |
boolean | Conditionally |
This boolean field is returned as true if the item in this listing was relisted. When an item is relisted, a brand new Item ID value is automatically created by eBay. This field is only returned for an original listing whose item has been relisted, so a false value should never get returned. Note: A new listing will not return this field. |
|
UnsoldList.ItemArray.Item .ReservePrice |
AmountType (double) | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| UnsoldList.ItemArray.Item .ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
This field is used to set the lowest price at which the seller is willing to sell an auction item. The StartPrice value must be lower than the ReservePrice value. Note that setting a reserve price will incur a listing fee of $5 or 7.5% of the reserve price, whichever is greater, and this fee is charged regardless of whether or not the auction item has a qualifying, winning bidder. As long as no bidder has matched your reserve price, and the scheduled end time of the auction is 12 or more hours away, you can lower or remove the reserve price. However, even if you remove the reserve price from an active listing, you will still be charged the fee and not eligible for a credit. In 'get' calls that retrieve item data, the ReservePrice field will only be returned to the seller of that particular auction item, and only if a reserve price has been set up. The reserve price is never exposed to anyone other than the seller of the item. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.ItemArray.Item .SellerProfiles |
SellerProfilesType | Conditionally |
This container is used if the seller would like to use/reference business policies to create, revise, relist, or verify their listing. The seller's account must be opted in to business policies to use this container. If this container is used, exactly one Payment Business Policy, one Shipping Business Policy, and one Return Business Policy must be specified and applied to the listing. If the seller's account is not opted in to business policies, that seller may not use this container. Sellers must opt-in to business policies through My eBay or by using the optInToProgram call of the eBay Account API. If business policies are applied to a listing, all payment, shipping, and return policy settings in these policies will override any other payment, shipping, or return policy legacy fields that are included in the call request. Note: To make sure that the shipping cost override and policies are set correctly on an item (that is using business policies and has one or more shipping service cost overrides set up), the Item.SellerProfiles.SellerShippingProfile container and the Item.ShippingServiceCostOverrideList.ShippingServiceCostOverride container(s) must be included, even if no changes are being made. This container is only returned in 'Get' calls if business policies are set for the listing, and the person making the API call is the seller of the listing. |
|
UnsoldList.ItemArray.Item .SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist/Verify API call to reference and use the settings/values of a payment business policy. Payment business policies contain a setting to control whether immediate payment is required, settings to specify due dates for the deposit and full payment of a motor vehicle listing (Motors policy only), and settings to specify which offline payment methods are avaiable to buyers for sales transactions that happen off of eBay's platform. Multiple payment business policies can be created and saved at the account level by sellers. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. Note: Sellers will never have to specify electronic payment methods, but offline payment methods are required for listings where offline payment is required or supported. |
|
UnsoldList.ItemArray.Item .SellerProfiles .SellerPaymentProfile .PaymentProfileID |
long | Conditionally |
The unique identifier of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. Payment profile IDs can be retrieved with the getPaymentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
UnsoldList.ItemArray.Item .SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a payment business policy. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the payment settings/values of a payment business policy. If both fields are provided and their values don't match, the PaymentProfileID takes precedence. In the 'Get' calls, the PaymentProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The PaymentProfileName value will be returned if a name is assigned to the payment business policy. |
|
UnsoldList.ItemArray.Item .SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a return business policy. Return business policies contain detailed information on the seller's return policy for domestic and international buyers (if the seller ships internationally), including whether or not the seller accepts returns from domestic and international buyers, how many days the buyer has to return the item for a refund, and who pays the return shipping costs. Multiple return policy business policies can be created and saved at the account level by sellers. Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers. This update can be made through the ReturnPolicy container or through a return business policy that is referenced through the SellerProfiles.SellerReturnProfile container. This container is only returned in 'Get' calls if Business Policies are set for the listing and the person making the API call is the seller of the listing. |
|
UnsoldList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. Return policy profile IDs can be retrieved with the getReturnPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
UnsoldList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a return policy business policy. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the return policy settings/values of a return policy business policy. If both fields are provided and their values don't match, the ReturnProfileID takes precedence. In the 'Get' calls, the ReturnProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ReturnProfileName value will be returned if a name is assigned to the return policy business policy. |
|
UnsoldList.ItemArray.Item .SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist/Verify Trading API call to reference and use the settings/values of a specific shipping business policy. Shipping business policies contain detailed information on domestic and international shipping, including shipping service options and costs, handling time, shipping discount information, and excluded ship-to locations. Multiple shipping business policies can be created and saved at the account level by sellers. Note: Any shipping inclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program. This container is only returned in 'Get' calls if Business Policies are set for the listing, and the person making the API call is the seller of the listing. |
|
UnsoldList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a shipping business policy. A ShippingProfileID and/or a ShipppingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shippping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShipppingProfileID takes precedence. Shipping profile IDs can be retrieved with the getFulfillmentPolicies call of the Account API or with the getSellerProfiles call of the Business Policies Management API. Business policy IDs can also be retrieved through the Business policies section of My eBay. In the 'Get' calls, the ShipppingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShipppingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
UnsoldList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a shipping business policy. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist/Verify call to reference and use the shipping-related settings/values of a shipping business policy. If both fields are provided and their values don't match, the ShippingProfileID takes precedence. In the 'Get' calls, the ShippingProfileID value will always be returned if business policies are set for the listing, and the person making the API call is the seller of the listing. The ShippingProfileName value will be returned if a name is assigned to the shipping business policy. |
|
UnsoldList.ItemArray.Item .SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .SellingStatus.BidCount |
int | Conditionally |
Number of bids placed so far against the auction item.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .SellingStatus.BidderCount |
long | Conditionally |
Number of bidders for an item. Only applicable to auction listings. Only returned for the seller of the item.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.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. |
| UnsoldList.ItemArray.Item .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | 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. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.ItemArray.Item .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price 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. |
| UnsoldList.ItemArray.Item .SellingStatus.CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.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. |
|
UnsoldList.ItemArray.Item .ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an order, including flat and calculated shipping costs. Note: For sellers who are using a shipping (aka Fulfillment) business policy to create/revise/relist an item, none of the fields under the ShippingDetails container are necessary. A fulfillment business policy can be set up and/or modified in My eBay, or via the Account API. A fulfillment business policy is associated to a listing through the Item.SellerProfiles.SellerShippingProfile container. If you do not use a fulfillment business policy, many of the fields under this ShippingDetails container become required in your request. Note: For ReviseItem and ReviseFixedPriceItem calls: If you are updating any field under the ShippingDetails container, you must include all containers and fields set under this container even if their values are not changing. If you do not do this, some fields may be removed from the listing. To find out the values included in the current listing, call GetItem and look through the ShippingDetails container in the response. For additional information, see Revise shipping details. 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, 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 any classified ad listings, as shipping/delivery/pickup is handled by the buyer and seller off of the eBay platform. Note: To create a listing that is 'Local Pickup only' (buyer picks up, with no shipping/delivery available), the user does the following two things:
For GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
UnsoldList.ItemArray.Item .ShippingDetails .GlobalShipping |
boolean | Conditionally |
Note: The Global Shipping Program (GSP) is only available on the UK marketplace. On the US marketplace, the Global Shipping Program was replaced by the intermediated international shipping program called eBay International Shipping. eBay International Shipping is an account level setting, and no field will need to be set in a add/revise call to enable this setting. As long as the US seller's account is opted in to eBay International Shipping, this shipping option will be automatically enabled for all listings where international shipping is available. Even if the US seller is opted into eBay International Shipping, that same seller can still also specify individual international shipping service options through the ShippingDetails.InternationalShippingServiceOption container. In an Add/Revise/Relist call, this boolean field can be included and set to True if the seller would like to use eBay's Global Shipping Program for orders that are shipped internationally. In 'Get' calls, if this field is returned as True, it indicates that international shipping through the Global Shipping Program is available for the listing. If this field is returned as False, the seller is responsible for shipping the item internationally using one of the specified international shipping service options set for the listing. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. 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> 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 four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
UnsoldList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .LocalPickup |
boolean | Conditionally |
The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping. |
|
UnsoldList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| UnsoldList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping set to true) and flat-rate shipping is being used domestically (ShippingType is set to Flat or FlatDomesticCalculatedInternational), the seller must still include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. Do not include ShippingServiceCost when the domestic shipping service option is set to represent domestic calculated shipping (ShippingType is set to Calculated or CalculatedDomesticFlatInternational), as error 10019 occurs. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.ItemArray.Item .ShippingDetails.ShippingType |
ShippingTypeCodeType | Conditionally |
The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these. GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.
Applicable values: See ShippingType. Code so that your app gracefully handles any future changes to this list. |
| UnsoldList.ItemArray.Item.SKU | SKUType (string) | Conditionally |
A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus 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 an order line item is created. (SKU is recommended as an alternative to ApplicationData.) If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence. If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request. Note: The eBay site 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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
UnsoldList.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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| UnsoldList.ItemArray.Item .StartPrice [ attribute currencyID ] |
CurrencyCodeType | 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 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): 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. For Revise calls: If the StartPrice value for a fixed-price item is changed with a Revise call, the MinimumBestOfferPrice and BestOfferAutoAcceptPrice fields in the ListingDetails container will be dropped (if set), basically turning off the Best Offer Auto Accept and/or Auto Decline features. If the seller wanted to reintroduce either of these Best Offer threshold values in the listing again, an additional Revise call would have to be made, passing in the desired threshold values. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.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 Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .Title |
string | Conditionally |
This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours. Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .Variations |
VariationsType | Conditionally |
Variations are similar (but not identical) items in a multiple-variation, 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 order line item can contain multiple items from a single variation.) If you list in two categories, both categories must support listing with variations. See VariationsEnabled in GetCategoryFeatures to determine applicable categories. 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 purchases, 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.) For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling: Only returned when a listing has variations and HideVariations was set to false or not specified in the request. Note: This container will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one item variation from another. For example, if an item varies 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 item variation, and you might have a plan to add more item variations to the listing in the future. However, if you don't plan to add other item variations in the future, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. If you specify multiple Variation containers in an add/revise/relist/verify add call to define multiple item variations, the Variation containers must be contiguous or an error will occur. This means that you would not want to input a Pictures or a VariationSpecificsSet container in between Variation containers in an API call. When you modify an item variation with a ReviseFixedPriceItem call, the best practice is to include all applicable fields under the Variation container, even if some of the values/settings are not being modified. The StartPrice and VariationSpecifics must be included when modifying an existing item variation, even if these values are not being changed. If a SKU value is defined for the item variation, it is strongly recommended that you include the SKU field, regardless of whether the SKU value is changing or not. If the SKU field is not included, any existing SKU value will be removed from the item variation. It is also strongly recommended that you include the Quantity field and input an accurate value, because if the Quantity field is omitted in the API call, the quantity for the item variation is set to 0. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.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. |
|
UnsoldList.ItemArray.Item .Variations.Variation.Quantity |
int | Conditionally |
This value indicates the quantity of the specific variation that are available for purchase. If you set Variation.Quantity to 0 when you create, revise, or relist an item listing, the variation is dropped from the listing. To prevent this, you can set SetUserPreferences.OutOfStockControlPreference to true. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total quantity associated with the variation, including the quantity available and the quantity sold. To calculate the quantity available for sale, subtract SellingStatus.QuantitySold from this value. For RelistFixedPriceItem:
0 when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding Variation.Quantity field of a relist call. Alternatively, you can update the correct quantity available by using a ReviseInventoryStatus call and passing in a Quantity value, while also making sure to pass in the correct SKU value(s) to identify the correct item variation. A ReviseInventoryStatus call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings). For ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, unless you set the OutOfStockControlPreference boolean field of the SetUserPreferences call to true, at least one variation must remain with a non-zero quantity in order for the listing to remain active. If you set the OutOfStockControlPreference field to true, a multiple-variation listing will remain active but hidden from search even if the quantity of all variations in the listing is set to 0. 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 User Guide for more details about setting and modifying a variation's quantity. Note: The number in the Variation.Quantity field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to 0, and the Item.IgnoreQuantity will also be returned as True. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
UnsoldList.ItemArray.Item .Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .Variations.Variation .SellingStatus.BidCount |
int | Conditionally | Number of bids placed so far against the auction item. |
|
UnsoldList.ItemArray.Item .Variations.Variation .SellingStatus.BidderCount |
long | Conditionally | Number of bidders for an item. Only applicable to auction listings. Only returned for the seller of the item. |
|
UnsoldList.ItemArray.Item .Variations.Variation .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. |
| UnsoldList.ItemArray.Item .Variations.Variation .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | 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. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.ItemArray.Item .Variations.Variation .SellingStatus.CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. |
| UnsoldList.ItemArray.Item .Variations.Variation .SellingStatus.CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.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 order line item. For order line item calls, also see Transaction.QuantityPurchased for the number of items purchased in the order line item. In multi-variation listings, this value matches total quantity sold across all variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .Variations.Variation .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. |
|
UnsoldList.ItemArray.Item .Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the VariationSpecifics identifying values. 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 include the Item.InventoryTrackingMethod field in an 'FixedPriceItem' call and set its value to SKU, the Variation.SKU values become required for each variation..For GetItem, GetOrders and other 'Get' calls: Only returned if the seller specified a SKU for the variation. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See SKU identifiers. |
|
UnsoldList.ItemArray.Item .Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Pricing. |
| UnsoldList.ItemArray.Item .Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The fixed price for this item 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 this field, and the prices can be the same for all variations, or 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. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
|
UnsoldList.ItemArray.Item .Variations.Variation .VariationSpecifics |
NameValueListArrayType | Conditionally,
repeatable: [2..5] |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of Item Specific names, but each variation must provide a unique combination of values for those Item Specific names. For example, if the items vary by color and size, then every variation must specify 'Color' and 'Size' as Item Specific names, but no two variations can specify the same combination of 'Color' and 'Size' values. When you revise a listing that includes variations, you can change names of Variationpecifics by using the Variations.ModifyNameList container. You can also add, 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 (order line items). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, Variationpecifics are not returned if the variation has a SKU. If the variation has no SKU, then Variationpecifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force Variationpecifics to be returned, even when the SKU is returned. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
UnsoldList.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 variations, 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:
For PlaceOffer: Required if the item being purchased includes Item Variations. For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required. Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name. For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing. Max length: 65. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI. If an item specific only supports a single value, only the first item specific value specified in the request will be used. For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description. Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning'). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.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 Variationpecifics. 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]. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 120. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.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. |
|
UnsoldList.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.
|
| UnsoldList.PaginationResult | PaginationResultType | Conditionally |
This container shows the total numer of items that matched the input criteria and the total number of the results set. Users can use the Pagination.PageNumber field in the request to toggle through different pages in the results set.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.PaginationResult .TotalNumberOfEntries |
int | Conditionally |
Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
UnsoldList.PaginationResult .TotalNumberOfPages |
int | Conditionally |
Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| Standard Output 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 the Ack field.
Applicable values: (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. |
| 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 |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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. |
| Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
| 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 Errors By Number. |
| 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 | 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.Value | string | Conditionally | This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID. |
| 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: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Error handling section of the Making a Trading API call guide for more information. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list. |
| 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 the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. |
| Input Output Samples Change History |
Detail Controls
DetailLevel
The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)
The none column indicates the fields that are returned when you do not specify a DetailLevel.
| Y | The field is always returned. |
| (Y) | The field is conditionally returned. See the field documentation for clarification of conditions. |
| - | The field is not returned. |
| Input Output Detail Controls Change History |
Samples
New to making API calls? Please see Making a Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Sample: Basic Call
Retrieves list of active items being sold by the authenticated user.
Description
Seller m***************r has listed several Harry Potter books and wants to get the selling status of active listings on eBay. She is interested in the items that are ending soonest.
Input
Because seller m***************r is interested in active items, she sets up an ActiveList container for the input, and specifies a sort order with the Sort field. Note that the Pagination values limit the response to a manageable set of items.
XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetMyeBaySellingRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<ActiveList>
<Sort>TimeLeft</Sort>
<Pagination>
<EntriesPerPage>3</EntriesPerPage>
<PageNumber>1</PageNumber>
</Pagination>
</ActiveList>
</GetMyeBaySellingRequest>
Output
Important information is returned the ItemID field and SellingStatus container (which lists the CurrentPrice). In addition, the TimeLeft field can help the seller to determine whether the item is selling as expected, and if it needs revising or relisting.
XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetMyeBaySellingResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-04T22:15:04.052Z</Timestamp>
<Ack>Success</Ack>
<Version>1131</Version>
<Build>E1131_CORE_APISELLING_19099826_R1</Build>
<ActiveList>
<ItemArray>
<Item>
<ItemID>1**********3</ItemID>
<ListingDetails>
<StartTime>2019-10-12T18:41:12.000Z</StartTime>
</ListingDetails>
<ListingType>Chinese</ListingType>
<Quantity>1</Quantity>
<ReservePrice currencyID="MYR">0.0</ReservePrice>
<SellingStatus>
<ConvertedCurrentPrice currencyID="USD">10.95</ConvertedCurrentPrice>
<CurrentPrice currencyID="MYR">11.0</CurrentPrice>
<ReserveMet>true</ReserveMet>
</SellingStatus>
<StartPrice currencyID="MYR">11.0</StartPrice>
<TimeLeft>PT28M17S</TimeLeft>
<Title>Test Auction Title</Title>
<QuantityAvailable>1</QuantityAvailable>
</Item>
<Item>
<ItemID>1**********9</ItemID>
<ListingDetails>
<StartTime>2019-10-13T17:23:04.000Z</StartTime>
</ListingDetails>
<ListingType>Chinese</ListingType>
<Quantity>1</Quantity>
<PrivateNotes>6:IDNew3My notes for Relist here (#*%$).</PrivateNotes>
<ReservePrice currencyID="USD">0.0</ReservePrice>
<SellingStatus>
<CurrentPrice currencyID="USD">1.0</CurrentPrice>
<ReserveMet>true</ReserveMet>
</SellingStatus>
<StartPrice currencyID="USD">1.0</StartPrice>
<TimeLeft>PT28M45S</TimeLeft>
<Title>Test for ExternalProductIdentifier</Title>
<QuantityAvailable>1</QuantityAvailable>
</Item>
<Item>
<ItemID>1**********2</ItemID>
<ListingDetails>
<StartTime>2019-10-14T11:44:56.000Z</StartTime>
</ListingDetails>
<ListingType>Chinese</ListingType>
<Quantity>1</Quantity>
<PrivateNotes>7:ID99999My notes here (#*%$).</PrivateNotes>
<ReservePrice currencyID="USD">0.0</ReservePrice>
<SellingStatus>
<CurrentPrice currencyID="USD">1.0</CurrentPrice>
<ReserveMet>true</ReserveMet>
</SellingStatus>
<StartPrice currencyID="USD">1.0</StartPrice>
<TimeLeft>PT29M35S</TimeLeft>
<Title>Test for ExternalProductIdentifier</Title>
<QuantityAvailable>1</QuantityAvailable>
</Item>
</ItemArray>
<PaginationResult>
<TotalNumberOfPages>1</TotalNumberOfPages>
<TotalNumberOfEntries>3</TotalNumberOfEntries>
</PaginationResult>
</ActiveList>
</GetMyeBaySellingResponse>
| Input Output Detail Controls Samples |
Change History
| Change Date | Description |
|---|---|
| 1345 2024-02-05 |
|
| 1323 2023-08-25 |
|
| 1201 2021-04-09 |
|
| 1157 2020-06-05 |
|
| 1145 2020-03-13 |
|
| 1119 2019-08-02 |
|
| 1081 2018-09-28 |
|
| 1073 2018-08-03 |
|
| 1027 2017-08-04 |
|
| 0929 2015-06-26 |
|
| 0925 2015-05-29 |
|
| 0859 2014-02-11 |
|
| 0823 2013-05-08 |
|
| 0821 2013-04-24 |
|
| 0811 2013-02-13 |
|
| 0807 2013-01-23 |
|
| 0793 2012-09-26 |
|
| 0771 2012-04-25 |
|
| 0763 2012-02-29 |
|
| 0747 2011-11-09 |
|
| 0741 2011-09-28 |
|
| 0731 2011-07-20 |
|
| 0719 2011-04-27 |
|
| 0705 2011-01-19 |
|
| 0693 2010-10-27 |
|
| 0691 2010-10-13 |
|
| 0689 2010-09-27 |
|
| 0677 2010-07-07 |
|
| 0673 2010-06-09 |
|
| 0663 2010-03-31 |
|
| 0653 2010-01-20 |
|
| 0629 2009-08-05 |
|
| 0605 2009-02-18 |
|
| 0587 2008-10-15 |
|
| 0573 2008-07-09 |
|
| 0567 2008-05-28 |
|
| 0561 2008-04-16 |
|
| 0551 2008-02-06 |
|
| 0537 2007-10-31 |
|
| 0507 2007-04-04 |
|
| 0499 2007-02-07 |
|
| 0497 2007-01-24 |
|
| 0477 2006-09-06 |
|
| 0457 2006-04-19 |
|
| 0439 2005-12-14 |
|