Use this call to return information from the All Selling section of the authenticated user's My eBay account. You can review items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items. You can also return a items that the user has deleted from their sold and unsold lists, and items that have been scheduled but are not yet active.
GetMyeBaySelling returns information for only the user authenticated with the call. Responses are based on the information in their My eBay account.
Depending on the selling information you want to inspect, GetMyeBaySelling can return any combination of selling information contained in the user's My eBay account. For each response container you want returned, specify a value of true in the respective container's Include field in your request. For example, the following code returns the list of items currently for sale:
<ActiveList>
<Include>true</Include>
</ActiveList>
Each response container returns with a default set of fields. If you need, use the controls provided in each container to filter or alter the presentation of the default response set. For example, some containers can be sorted and some support pagination.
To return all the selling containers, set DetailLevel to ReturnAll. In this case, you only have to specify a container if you want to override the default return set with a custom setting. If you want to exclude a specific container from the response, set Include to false in the appropriate container.
Note, however, that SellingSummary is not automatically returned when DetailLevel is set to ReturnAll; if you want a selling summary returned, you must specify the container in the request.
You can test GetMyeBaySelling in the Sandbox. Because the call returns information for only the user making the call, you will need to use several test users to fully test the call. Create tokens for the different users and use the appropriate tokens when making calls for the different users. If needed, you can use automated test users in the Sandbox; see Using the Sandbox for more information.
Create several sample listings with a registered Sandbox user. Have one or more different users place bids on the listings, then end the listings with sold and unsold items.
Make sure that items returned in ScheduledList or ActiveList are for scheduled or active listings, respectively. Also, ensure that items returned in SoldList and UnsoldList containers are for listings that have ended. Check the user's My eBay accounts in the Sandbox user interface and make sure the lists returned by the call match those in the UI.
Request a SoldList or UnsoldList using a DurationInDays value. Check the user's My eBay in the Sandbox user interface to make sure the correct number of items is returned.
See:
My eBay
Managing Selling and Reminders with My eBay
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History Top Errors for GetMyeBaySelling User Notes |
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?>
<GetMyeBaySellingRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- 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>
<DeletedFromSoldList> ItemListCustomizationType
<DurationInDays> int </DurationInDays>
<Include> boolean </Include>
<IncludeNotes> boolean </IncludeNotes>
<Sort> ItemSortTypeCodeType </Sort>
</DeletedFromSoldList>
<DeletedFromUnsoldList> ItemListCustomizationType
<DurationInDays> int </DurationInDays>
<Include> boolean </Include>
<IncludeNotes> boolean </IncludeNotes>
<Sort> ItemSortTypeCodeType </Sort>
</DeletedFromUnsoldList>
<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 |
Returns the list of items the user is actively selling (the currently active listings). Include and set the ActiveList.Include flag to 'true' to retrieve the default response set of ActiveList in the response. |
| ActiveList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
| ActiveList.IncludeNotes | boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| ActiveList.ListingType | ListingTypeCodeType | Optional |
Specifies the listing type of items in the returned list.
Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Auction (in/out) An optional input parameter used with GetMyeBaySelling. When used in the request, returns items of competitive-bid auctions. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. (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. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. For GetOrders, the maximum value is 100 and the default value is 25 orders per page. For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored. For GetProducts, the maximum value is 20, and any higher values are ignored. |
|
ActiveList.Pagination .PageNumber |
int | Optional |
Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. Min: 1. Default: 1. |
| ActiveList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| DeletedFromSoldList | ItemListCustomizationType | Optional |
Returns the list of items the user sold, and then deleted from their My eBay page. Allowed values for DurationInDays are 0-60. Include and set the DeletedFromSoldList.Include flag to 'true' to retrieve the default response set of DeletedFromSoldList in the response. |
|
DeletedFromSoldList .DurationInDays |
int | Optional |
Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. For example, to return the items won or lost in the last week, specify a DurationInDays of 7. Min: 0. Max: 60. |
| DeletedFromSoldList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
|
DeletedFromSoldList .IncludeNotes |
boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| DeletedFromSoldList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| DeletedFromUnsoldList | ItemListCustomizationType | Optional |
Returns the list of items the user either ended or did not sell, and subsequently were deleted them from their My eBay page. Allowed values for DurationInDays are 0-60. Include and set the DeletedFromUnsoldList.Include flag to 'true' to retrieve the default response set of DeletedFromUnsoldList in the response. |
|
DeletedFromUnsoldList .DurationInDays |
int | Optional |
Specifies the time period during which an item was won or lost. Similar to the period drop-down menu in the My eBay user interface. For example, to return the items won or lost in the last week, specify a DurationInDays of 7. Min: 0. Max: 60. |
| DeletedFromUnsoldList.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
|
DeletedFromUnsoldList .IncludeNotes |
boolean | Optional |
Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. Default: false. |
| DeletedFromUnsoldList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| HideVariations | boolean | Optional |
If 'true', the Variations node is omitted for all multi-variation listings in the response. If 'false', the Variations node is returned for all multi-variation listings in the response. Please note that if the seller includes a large number of variations in many listings, retrieving variations (setting this flag to 'false') may degrade the call's performance. Therefore, when this is 'false', you may need to reduce the total number of items you're requesting at once (by using other input fields, such as Pagination). Default: false. |
| ScheduledList | ItemListCustomizationType | Optional |
Returns the list of items the user has scheduled to sell but whose listings have not yet opened. Include and set the ScheduledList.Include flag to 'true' to retrieve the default response set of ScheduledList in the response. |
| 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. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. For GetOrders, the maximum value is 100 and the default value is 25 orders per page. For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored. For GetProducts, the maximum value is 20, and any higher values are ignored. |
|
ScheduledList.Pagination .PageNumber |
int | Optional |
Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. Min: 1. Default: 1. |
| ScheduledList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| SellingSummary | ItemListCustomizationType | Optional |
Returns a summary of the user's buying activity. Include and set the SellingSummary.Include flag to 'true' to retrieve the default response set of SellingSummary in the response. |
| SellingSummary.Include | boolean | Optional |
Specifies whether or not to include the container in the response. Set the value to true to return the default set of fields for the container. Not needed if you set a value for at least one other field in the container. If you set DetailLevel to ReturnAll, set Include to false to exclude the container from the response. |
| SoldList | ItemListCustomizationType | Optional |
Returns the list of items the user has sold. Include and set the SoldList.Include flag to 'true' to retrieve the default response set of SoldList in the response. |
| 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 the eBay Web site UI to mark an order as Paid or Shipped in My eBay. Sellers can also specify PaymentStatus in ReviseCheckoutStatus to mark an order as Paid or awaiting payment in My eBay.) Default: All. Applicable values: • All (in) All applicable sold listings, regardless of their Paid or Shipped status. • AwaitingPayment (in) Sold listings that have not yet been marked as Paid in My eBay. • AwaitingShipment (in) Sold listings that have not yet been marked as Shipped in My eBay. • CustomCode (in) Reserved for future or internal use. • PaidAndShipped (in) Sold listings that have been marked as Paid and Shipped in My eBay. |
| SoldList.Pagination | PaginationType | Optional |
Specifies how to create virtual pages in the returned list. Default for EntriesPerPage with GetMyeBayBuying is 200. |
|
SoldList.Pagination .EntriesPerPage |
int | Optional |
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. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. For GetOrders, the maximum value is 100 and the default value is 25 orders per page. For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored. For GetProducts, the maximum value is 20, and any higher values are ignored. |
| SoldList.Pagination.PageNumber | int | Optional |
Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. Min: 1. Default: 1. |
| SoldList.Sort | ItemSortTypeCodeType | Optional |
Specifies the sort order of the result. Default is Ascending.
Applicable values: See Sort. |
| UnsoldList | ItemListCustomizationType | Optional |
Returns the list of items the user has listed, but whose listings have ended without being sold. Include and set the UnsoldList.Include flag to 'true' to retrieve the default response set of UnsoldList in the response. |
| 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. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. For GetOrders, the maximum value is 100 and the default value is 25 orders per page. For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored. For GetProducts, the maximum value is 20, and any higher values are ignored. |
|
UnsoldList.Pagination .PageNumber |
int | Optional |
Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. 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 processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. • ReturnSummary (in) Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See "GetMyMessages" in the eBay Web Services Guide for a code sample that demonstrates this. (Not all values in DetailLevelCodeType apply to this field.) |
| ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong |
| MessageID | string | Optional |
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 this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. |
| Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
| WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level. |
| Input Detail Controls Samples Change History Top Errors for GetMyeBaySelling User Notes |
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
<?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>
<eBayNotes> string </eBayNotes>
<ItemID> ItemIDType (string) </ItemID>
<LeadCount> int </LeadCount>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingDuration> token </ListingDuration>
<ListingType> ListingTypeCodeType </ListingType>
<NewLeadCount> int </NewLeadCount>
<OutOfStockControl> boolean </OutOfStockControl>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellerProfiles> SellerProfilesType
<SellerPaymentProfile> SellerPaymentProfileType
<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>
<ShippingPackageDetails> ShipPackageDetailsType
</ShippingPackageDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value 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>
<DeletedFromSoldList> PaginatedOrderTransactionArrayType
<OrderTransactionArray> OrderTransactionArrayType
<OrderTransaction> OrderTransactionType
<Order> OrderType
<OrderID> OrderIDType (string) </OrderID>
<Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal>
<TransactionArray> TransactionArrayType
<Transaction> TransactionType
<Buyer> UserType
<BuyerInfo> BuyerType
<ShippingAddress> AddressType
<PostalCode> string </PostalCode>
</ShippingAddress>
</BuyerInfo>
<Email> string </Email>
<StaticAlias> string </StaticAlias>
<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>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<OutOfStockControl> boolean </OutOfStockControl>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellerProfiles> SellerProfilesType
<SellerPaymentProfile> SellerPaymentProfileType
<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>
</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>
<ShippingPackageDetails> ShipPackageDetailsType
</ShippingPackageDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value 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>
<PaisaPayID> string </PaisaPayID>
<Platform> TransactionPlatformCodeType </Platform>
<QuantityPurchased> int </QuantityPurchased>
<SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
<ShippedTime> dateTime </ShippedTime>
<Status> TransactionStatusType
<PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
</Status>
<TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
<TransactionID> string </TransactionID>
<TransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TransactionPrice>
</Transaction>
<!-- ... more Transaction nodes allowed here ... -->
</TransactionArray>
</Order>
<Transaction> TransactionType
<Buyer> UserType
<BuyerInfo> BuyerType
<ShippingAddress> AddressType
<PostalCode> string </PostalCode>
</ShippingAddress>
</BuyerInfo>
<Email> string </Email>
<StaticAlias> string </StaticAlias>
<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>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<OutOfStockControl> boolean </OutOfStockControl>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellerProfiles> SellerProfilesType
<SellerPaymentProfile> SellerPaymentProfileType
<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>
</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>
<ShippingPackageDetails> ShipPackageDetailsType
</ShippingPackageDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value 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>
<PaisaPayID> string </PaisaPayID>
<Platform> TransactionPlatformCodeType </Platform>
<QuantityPurchased> int </QuantityPurchased>
<SellerPaidStatus> PaidStatusCodeType </SellerPaidStatus>
<ShippedTime> dateTime </ShippedTime>
<Status> TransactionStatusType
<PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
</Status>
<TotalTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TotalTransactionPrice>
<TransactionID> string </TransactionID>
<TransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TransactionPrice>
</Transaction>
</OrderTransaction>
<!-- ... more OrderTransaction nodes allowed here ... -->
</OrderTransactionArray>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
</DeletedFromSoldList>
<DeletedFromUnsoldList> PaginatedItemArrayType
<ItemArray> ItemArrayType
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<OutOfStockControl> boolean </OutOfStockControl>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellerProfiles> SellerProfilesType
<SellerPaymentProfile> SellerPaymentProfileType
<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>
</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>
<ShippingPackageDetails> ShipPackageDetailsType
</ShippingPackageDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value 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>
</DeletedFromUnsoldList>
<ScheduledList> PaginatedItemArrayType
<ItemArray> ItemArrayType
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<eBayNotes> string </eBayNotes>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingDuration> token </ListingDuration>
<ListingType> ListingTypeCodeType </ListingType>
<OutOfStockControl> boolean </OutOfStockControl>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellerProfiles> SellerProfilesType
<SellerPaymentProfile> SellerPaymentProfileType
<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>
<ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes allowed here ... -->
<ShippingType> ShippingTypeCodeType </ShippingType>
</ShippingDetails>
<ShippingPackageDetails> ShipPackageDetailsType
</ShippingPackageDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value 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>
<AuctionBidCount> int </AuctionBidCount>
<AuctionSellingCount> int </AuctionSellingCount>
<SoldDurationInDays> int </SoldDurationInDays>
<TotalAuctionSellingValue currencyID="CurrencyCodeType"> AmountType (double) </TotalAuctionSellingValue>
<TotalSoldCount> int </TotalSoldCount>
<TotalSoldValue currencyID="CurrencyCodeType"> AmountType (double) </TotalSoldValue>
</SellingSummary>
<SoldList> PaginatedOrderTransactionArrayType
<OrderTransactionArray> OrderTransactionArrayType
<OrderTransaction> OrderTransactionType
<Order> OrderType
<OrderID> OrderIDType (string) </OrderID>
<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>
<StaticAlias> string </StaticAlias>
<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>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<OutOfStockControl> boolean </OutOfStockControl>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellerProfiles> SellerProfilesType
<SellerPaymentProfile> SellerPaymentProfileType
<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>
<ShippingPackageDetails> ShipPackageDetailsType
</ShippingPackageDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value 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>
<PaisaPayID> string </PaisaPayID>
<PaymentHoldDetails> PaymentHoldDetailType
<ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
<PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
<RequiredSellerActionArray> RequiredSellerActionArrayType
<RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
<!-- ... more RequiredSellerAction values allowed here ... -->
</RequiredSellerActionArray>
</PaymentHoldDetails>
<Platform> TransactionPlatformCodeType </Platform>
<QuantityPurchased> int </QuantityPurchased>
<RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
<RefundStatus> string </RefundStatus>
<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>
<TransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TransactionPrice>
</Transaction>
<!-- ... more Transaction nodes allowed here ... -->
</TransactionArray>
</Order>
<Transaction> TransactionType
<Buyer> UserType
<BuyerInfo> BuyerType
<ShippingAddress> AddressType
<PostalCode> string </PostalCode>
</ShippingAddress>
</BuyerInfo>
<Email> string </Email>
<StaticAlias> string </StaticAlias>
<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>
<ItemID> ItemIDType (string) </ItemID>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingType> ListingTypeCodeType </ListingType>
<OutOfStockControl> boolean </OutOfStockControl>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellerProfiles> SellerProfilesType
<SellerPaymentProfile> SellerPaymentProfileType
<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>
<ShippingPackageDetails> ShipPackageDetailsType
</ShippingPackageDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value 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>
<PaisaPayID> string </PaisaPayID>
<PaymentHoldDetails> PaymentHoldDetailType
<ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
<PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
<RequiredSellerActionArray> RequiredSellerActionArrayType
<RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
<!-- ... more RequiredSellerAction values allowed here ... -->
</RequiredSellerActionArray>
</PaymentHoldDetails>
<Platform> TransactionPlatformCodeType </Platform>
<QuantityPurchased> int </QuantityPurchased>
<RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
<RefundStatus> string </RefundStatus>
<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>
<TransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TransactionPrice>
</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>
<AuctionBidCount> int </AuctionBidCount>
<AuctionSellingCount> int </AuctionSellingCount>
<ClassifiedAdCount> int </ClassifiedAdCount>
<ClassifiedAdOfferCount> int </ClassifiedAdOfferCount>
<QuantityLimitRemaining> long </QuantityLimitRemaining>
<SoldDurationInDays> int </SoldDurationInDays>
<TotalAuctionSellingValue currencyID="CurrencyCodeType"> AmountType (double) </TotalAuctionSellingValue>
<TotalLeadCount> int </TotalLeadCount>
<TotalListingsWithLeads> int </TotalListingsWithLeads>
<TotalSoldCount> int </TotalSoldCount>
<TotalSoldValue currencyID="CurrencyCodeType"> AmountType (double) </TotalSoldValue>
</Summary>
<UnsoldList> PaginatedItemArrayType
<ItemArray> ItemArrayType
<Item> ItemType
<BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice>
<eBayNotes> string </eBayNotes>
<ItemID> ItemIDType (string) </ItemID>
<LeadCount> int </LeadCount>
<ListingDetails> ListingDetailsType
<ConvertedBuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedBuyItNowPrice>
<ConvertedReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedReservePrice>
<ConvertedStartPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedStartPrice>
<EndTime> dateTime </EndTime>
<StartTime> dateTime </StartTime>
</ListingDetails>
<ListingDuration> token </ListingDuration>
<ListingType> ListingTypeCodeType </ListingType>
<OutOfStockControl> boolean </OutOfStockControl>
<PictureDetails> PictureDetailsType
<GalleryURL> anyURI </GalleryURL>
</PictureDetails>
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<QuantityAvailable> int </QuantityAvailable>
<QuestionCount> long </QuestionCount>
<Relisted> boolean </Relisted>
<ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice>
<SellerProfiles> SellerProfilesType
<SellerPaymentProfile> SellerPaymentProfileType
<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>
<ShippingPackageDetails> ShipPackageDetailsType
</ShippingPackageDetails>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<TimeLeft> duration </TimeLeft>
<Title> string </Title>
<Variations> VariationsType
<Variation> VariationType
<PrivateNotes> string </PrivateNotes>
<Quantity> int </Quantity>
<SellingStatus> SellingStatusType
<QuantitySold> int </QuantitySold>
</SellingStatus>
<SKU> SKUType (string) </SKU>
<StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value 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 |
Contains the items the user is selling that have active listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray | ItemArrayType | Conditionally |
Contains a list of Item types.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item | ItemType | Conditionally,
repeatable: [0..*] |
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has 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. 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. The Best Offer feature is not available for auction listings. 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. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .BestOfferDetails .BestOfferCount |
int | Conditionally |
The number of Best Offers made for this item, if any. In other words, if there are no Best Offers made, this container will not appear in the response.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .BuyItNowPrice |
AmountType (double) | Conditionally |
For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing. There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid. This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings. Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .eBayNotes |
string | Conditionally |
Returns a note from eBay displayed below items in the user's My eBay account. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .ItemID |
ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .LeadCount |
int | Conditionally |
Specifies the number of leads (emails) buyers have posted about the item. You must be the seller of the item to retrieve the lead count.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed.
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. To set a duration of 1 day, the seller must have a Feedback score of at least 10. When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours. Required for Half.com (but only specify GTC). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
Applicable values: See ListingDurationCodeType |
|
ActiveList.ItemArray.Item .ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as auction style or fixed price. Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • PersonalOffer (out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .NewLeadCount |
int | Conditionally |
Specifies the number of new leads (unanswered emails) buyers have posted about the item.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .OutOfStockControl |
boolean | Conditionally | When this field is set to 'true' the item is hidden when the quantity goes to 0 (zero) but the listing is kept alive. Using an OutOfStockControl flag in an Add/Revise/Relist call, a seller can keep a Fixed-Price GTC (Good 'Til Canceled) listing alive even when the "quantity available" value goes to 0 (zero). While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the 'OutOfStock' Enum would be returned. This is useful for a seller who is waiting for additional stock of an item. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields in an AddFixedPriceItem call) and the listing would appear again. |
|
ActiveList.ItemArray.Item .PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .PictureDetails.GalleryURL |
anyURI | Conditionally |
Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
ActiveList.ItemArray.Item .Quantity |
int | Conditionally |
The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the Item.Quantity value indicates the number of identical items the seller has available for purchase in the listing. For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the Item.Quantity should not be used; instead, the quantity of each variation is specified in the Variation.Variation.Quantity field instead. See the Creating a listing with variations eBay Help page for more information on variations. 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 3 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. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. 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. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. 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). For GetDispute: Quantity is the number of items being raised in the dispute. For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
ActiveList.ItemArray.Item .ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings. The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| ActiveList.ItemArray.Item .ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ActiveList.ItemArray.Item .SellerProfiles |
SellerProfilesType | Conditionally | Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address. Business Policies payment profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies payment profile. 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 the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option, how many days the buyer has to return the item for a refund, warranty information, and restocking fee (if any). Business Policies return policy profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the return policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information. Business Policies shipping profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
ActiveList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
ActiveList.ItemArray.Item .SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.BidCount |
int | Conditionally |
Number of bids placed so far against the 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 |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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, or for active Store Inventory 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 |
Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.
Applicable values: • Blue (out) Blue Star, feedback score 50-99. • CustomCode (out) Reserved for internal or future use. • Green (out) Green Star, feedback score 5,000-9,999. • GreenShooting (out) Green Shooting Star, feedback score 500,000-999,999. • None (out) No graphic displayed, feedback score 0-9. • Purple (out) Purple Star, feedback score 500-999. • PurpleShooting (out) Purple Shooting Star, feedback score 50,000-99,999. • Red (out) Red Star, feedback score 1,000-4,999 • RedShooting (out) Red Shooting Star, feedback score 100,000-499,999. • SilverShooting (out) Silver Shooting Star, feedback score 1,000,000 and above. • Turquoise (out) Turquoise Star, feedback score 100-499. • TurquoiseShooting (out) Turquoise Shooting Star, feedback score 25,000-49,999. • Yellow (out) Yellow Star, feedback score 10-49. • YellowShooting (out) Yellow Shooting Star, feedback score 10,000-24,999. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .SellingStatus.HighBidder .FeedbackScore |
int | Conditionally |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in 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. 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". Note that 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 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 |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing. Shipping details are not applicable to Real Estate listings and Half.com. GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .ShippingDetails .GlobalShipping |
boolean | Conditionally |
Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is False, the seller is responsible for specifying an international shipping service for the listing if desired. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Introduction to Shipping for information about Global Shipping Program eligibility. |
|
ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). 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. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .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 meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. 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 GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. Not applicable to Half.com. Applicable values: • Calculated (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. • NotSpecified (in/out) The seller did not specify the shipping type. (Not all values in ShippingTypeCodeType apply to this field.) |
|
ActiveList.ItemArray.Item .ShippingPackageDetails |
ShipPackageDetailsType | Conditionally | Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the "Get" calls if specified for the item. |
| ActiveList.ItemArray.Item.SKU | SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method. If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
ActiveList.ItemArray.Item .StartPrice |
AmountType (double) | Conditionally |
This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted. For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For fixed-price listings: This is the fixed-price at which a buyer may purchase the item. For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| ActiveList.ItemArray.Item .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For the AddItem family of calls: Not applicable to Half.com. For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one 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). 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. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. Variation, Pictures, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests. 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 items in 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. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total number of items 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 ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that 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.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. For GetItem and related calls: Only returned if the seller specified a SKU for the variation. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ActiveList.ItemArray.Item .Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. 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, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 40. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 50. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .Variations.Variation .WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.ItemArray.Item .WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
| ActiveList.PaginationResult | PaginationResultType | Conditionally |
Provides information about the list, including number of pages and number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ActiveList.PaginationResult .TotalNumberOfEntries |
int | Conditionally |
Indicates the total number of entries that could be returned by repeated 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. |
| DeletedFromSoldList | PaginatedOrderTransactionArrayType | Conditionally |
Contains the items the seller has sold and deleted from My eBay.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray |
OrderTransactionArrayType | Conditionally |
Contains the list of orders.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction |
OrderTransactionType | Conditionally,
repeatable: [0..*] |
The individual order or transaction.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order |
OrderType | Conditionally |
Contains the information describing an order.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .OrderID |
OrderIDType (string) | Conditionally |
A unique identifier that identifies a single line item or multiple line item order. For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order or an order that goes through the eBay shopping cart flow, the OrderID value is automatically created by eBay. A Combined Payment order can be created through the site by a buyer or seller when the buyer or seller share multiple, common order line items. A Combined Payment order can also be created by the seller through the AddOrder call. An OrderID value overrides an OrderLineItemID value or an ItemID/TransactionID pair if these fields are also specified in the same request. Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .Subtotal |
AmountType (double) | Conditionally |
The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .Subtotal [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray |
TransactionArrayType | Conditionally |
Container consisting of one or more line items that comprise an order. The data for an order line item is stored in the Transaction container. For the AddOrder call, there will always be at least two order line items in the container, but no more than 40. We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same Combined Payment order. (In the future, AddOrder may enforce this recommendation.) Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction |
TransactionType | Conditionally,
repeatable: [0..*] |
The Transaction container consists of detailed information on one order line item. Also applicable to Half.com (for GetOrders).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing an Item. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer |
UserType | Conditionally |
UserType container consisting of eBay user data for the buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if the seller is making the request. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.BuyerInfo |
BuyerType | Conditionally |
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.BuyerInfo .ShippingAddress |
AddressType | Conditionally |
Contains the shipping address of the buyer. See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.BuyerInfo .ShippingAddress.PostalCode |
string | Conditionally |
User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.Email |
string | Conditionally |
Email address for the user. 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 order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request. 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. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.StaticAlias |
string | Conditionally |
Contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message. (Each eBay member is assigned a static alias. The alias is used within a static email address.)
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Buyer.UserID |
UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID 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 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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .ConvertedTransactionPrice |
AmountType (double) | Conditionally |
This value indicates 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. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .ConvertedTransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .CreatedDate |
dateTime | Conditionally |
Indicates the creation time of the order line item. For auction listings, an order line item 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, an order line item is created once the buyer clicks the Buy button. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackLeft |
FeedbackInfoType | Conditionally |
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. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackLeft.CommentType |
CommentTypeCodeType | Conditionally |
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: • CustomCode (in/out) This value is reserved for internal or future use. • IndependentlyWithdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. • Negative (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1. • Neutral (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same. • Positive (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1. • Withdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .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. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .FeedbackReceived.CommentType |
CommentTypeCodeType | Conditionally |
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: • CustomCode (in/out) This value is reserved for internal or future use. • IndependentlyWithdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. • Negative (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1. • Neutral (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same. • Positive (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1. • Withdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .IsMultiLegShipping |
boolean | Conditionally |
If IsMultilegShipping is true, the order or transaction uses the Global Shipping Program, in which the shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the items were listed, and the Get family of calls will return InternationalPriorityShipping as the default international shipping service in the listings of all the items in the order. If IsMultilegShipping is false, the order or transaction does not use the Global Shipping Program. The shipment might use a different international shipping service, or it might be domestic. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item |
ItemType | Conditionally |
Container consisting of details about an item in a listing. The child fields returned are dependent on the call, the type of item or listing, and the listing site. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.BuyItNowPrice |
AmountType (double) | Conditionally |
For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing. There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid. This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings. Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ItemID |
ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails.EndTime |
dateTime | Conditionally |
Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as auction style or fixed price. Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • PersonalOffer (out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.OutOfStockControl |
boolean | Conditionally | When this field is set to 'true' the item is hidden when the quantity goes to 0 (zero) but the listing is kept alive. Using an OutOfStockControl flag in an Add/Revise/Relist call, a seller can keep a Fixed-Price GTC (Good 'Til Canceled) listing alive even when the "quantity available" value goes to 0 (zero). While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the 'OutOfStock' Enum would be returned. This is useful for a seller who is waiting for additional stock of an item. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields in an AddFixedPriceItem call) and the listing would appear again. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PictureDetails .GalleryURL |
anyURI | Conditionally |
Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Quantity |
int | Conditionally |
The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the Item.Quantity value indicates the number of identical items the seller has available for purchase in the listing. For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the Item.Quantity should not be used; instead, the quantity of each variation is specified in the Variation.Variation.Quantity field instead. See the Creating a listing with variations eBay Help page for more information on variations. 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 3 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. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. 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. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. 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). For GetDispute: Quantity is the number of items being raised in the dispute. For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings. The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles |
SellerProfilesType | Conditionally | Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address. Business Policies payment profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies payment profile. 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 the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option, how many days the buyer has to return the item for a refund, warranty information, and restocking fee (if any). Business Policies return policy profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the return policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information. Business Policies shipping profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .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. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SellingStatus .QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that 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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing. Shipping details are not applicable to Real Estate listings and Half.com. GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .GlobalShipping |
boolean | Conditionally |
Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is False, the seller is responsible for specifying an international shipping service for the listing if desired. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Introduction to Shipping for information about Global Shipping Program eligibility. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). 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. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. 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 GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .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. Not applicable to Half.com. Applicable values: • Calculated (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. • NotSpecified (in/out) The seller did not specify the shipping type. (Not all values in ShippingTypeCodeType apply to this field.) |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.ShippingPackageDetails |
ShipPackageDetailsType | Conditionally | Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the "Get" calls if specified for the item. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method. If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.StartPrice |
AmountType (double) | Conditionally |
This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted. For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For fixed-price listings: This is the fixed-price at which a buyer may purchase the item. For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For the AddItem family of calls: Not applicable to Half.com. For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one 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). 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. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. Variation, Pictures, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .Quantity |
int | Conditionally |
This value indicates the quantity of items in 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. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total number of items 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 ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that 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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. For GetItem and related calls: Only returned if the seller specified a SKU for the variation. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .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 names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. 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, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 40. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 50. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.Variations.Variation .WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Item.WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .OrderLineItemID |
string | Always |
A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .PaidTime |
dateTime | Conditionally |
Indicates the time when the order was marked paid. 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:
Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .PaisaPayID |
string | Conditionally | Unique identifier for a PaisaPay transaction. Only applicable for the India site (203) if PaisaPay was the payment method used. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Platform |
TransactionPlatformCodeType | Conditionally |
Name of the eBay co-branded site upon which the order line item (transaction) was created.
Applicable values: • CustomCode (in/out) Reserved for future use. • eBay (in/out) The order line item was created on the main eBay site. • Express (in/out) The order line item was created on the eBay Express site. • Half (in/out) The order line item was created on Half.com site. • Shopping (in/out) The order line item was created on the Shopping.com site. • WorldOfGood (in/out) The order line item was created on the WorldOfGood site. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .QuantityPurchased |
int | Conditionally |
This value indicates the number of identical items 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. In either case, this field is tied to the same order line item. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .SellerPaidStatus |
PaidStatusCodeType | Conditionally |
Specifies the paid status of the order. Not applicable to Half.com. Applicable values: • BuyerHasNotCompletedCheckout (out) The buyer has not completed the checkout process and so has not made payment. • CustomCode (out) Reserved for future use. • EscrowPaymentCancelled (out) The buyer has made an escrow payment, but has cancelled the payment. • MarkedAsPaid (out) The order is marked as paid by either buyer or seller. • NotPaid (out) The buyer has not completed checkout, but has not paid through PayPal or PaisaPay (but please also see the documentation for PaymentHoldStatus and its applicable values). The buyer might have paid using another method, but the payment might not have been received or cleared. Important: Please see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment. • Paid (out) Paid • PaidCOD (out) PaidCOD • PaidWithEscrow (out) The buyer has made an escrow payment, and the seller has received payment. • PaidWithPaisaPay (out) The buyer has paid with PaisaPay, and the payment is complete. • PaidWithPaisaPayEscrow (out) Paid With PaisaPay Escrow • PaidWithPayPal (out) The buyer has made a PayPal payment, and the payment is complete. But please also see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment. • PaisaPayNotPaid (out) Paisa Pay Not Paid • PaymentPending (out) The buyer has made a payment other than PayPal, escrow, or PaisaPay, but the payment is still being processed. • PaymentPendingWithEscrow (out) The buyer has made an escrow payment, but the seller has not yet received it. • PaymentPendingWithPaisaPay (out) The buyer has paid with PaisaPay, but the payment is still being processed. The seller has not yet received payment. • PaymentPendingWithPaisaPayEscrow (out) Payment Pending With PaisaPay Escrow • PaymentPendingWithPayPal (out) The buyer has made a PayPal payment, but the seller has not yet received it. • Refunded (out) Refunded • WaitingForCODPayment (out) WaitingForCODPayment DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .ShippedTime |
dateTime | Conditionally |
Indicates the time when the item(s) associated with the order were 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 in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Status |
TransactionStatusType | Conditionally |
Container consisting of status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements. For GetOrders, only the IntegratedMerchantCreditCardEnabled and PaymentMethodUsed child elements are returned. The PaymentHoldStatus container will be returned for those sellers subject to the new eBay payment process. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .Status.PaymentHoldStatus |
PaymentHoldStatusCodeType | Conditionally |
This field indicates the type and/or status of a payment hold on the item.
Applicable values: • CustomCode (out) This value is reserved for internal or future use. • MerchantHold (out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying. • NewSellerHold (out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:
• None (out) This value indicates that there is no payment hold on the item. • PaymentHold (out) This value indicates that there is a payment hold on the item. • PaymentReview (out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying. • ReleaseConfirmed (out) This value indicates that the funds are available in the seller's PayPal account. • Released (out) This value indicates that a payment hold on the item has been released. • ReleasePending (out) This value indicates that the process for the release of funds for the order has been initiated. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TotalTransactionPrice |
AmountType (double) | Conditionally |
The price of one order line item. This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through a non-variation, fixed-price listing, this value is the total combined price for all units of the order line item. With GetMyeBaySelling, you can also get this value by multiplying SellingStatus.QuantitySold by SellingStatus.CurrentPrice. For eBay Motors Vehicle listings, TotalTransactionPrice is the deposit amount. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TotalTransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TransactionID |
string | Conditionally |
Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed. Applicable to Half.com (for GetOrders only). Max length: 19 (Note: The eBay database specifies 38. Transaction IDs are usually 9 to 12 digits.). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TransactionPrice |
AmountType (double) | Conditionally |
The price of one order line item. This price is returned only for Best Offer items. This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through Best Offer, this value is the per-unit price. For eBay Motors Vehicle listings, TransactionPrice is the deposit amount. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Order .TransactionArray.Transaction .TransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction |
TransactionType | Conditionally |
Contains the information describing a transaction.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer |
UserType | Conditionally |
UserType container consisting of eBay user data for the buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if the seller is making the request. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer.BuyerInfo |
BuyerType | Conditionally |
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer.BuyerInfo .ShippingAddress |
AddressType | Conditionally |
Contains the shipping address of the buyer. See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer.BuyerInfo .ShippingAddress.PostalCode |
string | Conditionally |
User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .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 order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request. 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. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer.StaticAlias |
string | Conditionally |
Contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message. (Each eBay member is assigned a static alias. The alias is used within a static email address.)
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Buyer.UserID |
UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Note that in this format, the anonymous bidder ID 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 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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .ConvertedTransactionPrice |
AmountType (double) | Conditionally |
This value indicates 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. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .ConvertedTransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .CreatedDate |
dateTime | Conditionally |
Indicates the creation time of the order line item. For auction listings, an order line item 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, an order line item is created once the buyer clicks the Buy button. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .FeedbackLeft |
FeedbackInfoType | Conditionally |
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. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .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: • CustomCode (in/out) This value is reserved for internal or future use. • IndependentlyWithdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. • Negative (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1. • Neutral (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same. • Positive (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1. • Withdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .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. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .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: • CustomCode (in/out) This value is reserved for internal or future use. • IndependentlyWithdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn based on the decision of a third-party (such as eBay). If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. • Negative (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Negative" experience. If an eBay user receives a Negative rating for an order line item from a Verified User, their overall Feedback score decreases by a value of 1. • Neutral (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives a Neutral rating for an order line item from a Verified User, their overall Feedback score remains the same. • Positive (in/out) This value indicates that the submitting user's experience with the other user (receiving feedback) was rated as a "Positive" experience. If an eBay user receives a Positive rating for an order line item from a Verified User, their overall Feedback score increases by a value of 1. • Withdrawn (in/out) This value indicates that a submitted Feedback entry was withdrawn. If a Feedback entry is withdrawn, the effect of that entry on the overall Feedback score is nullified. However, Feedback comments from the withdrawn entry are still visible. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .IsMultiLegShipping |
boolean | Conditionally |
If IsMultilegShipping is true, the order or transaction uses the Global Shipping Program, in which the shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the items were listed, and the Get family of calls will return InternationalPriorityShipping as the default international shipping service in the listings of all the items in the order. If IsMultilegShipping is false, the order or transaction does not use the Global Shipping Program. The shipment might use a different international shipping service, or it might be domestic. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item |
ItemType | Conditionally |
Container consisting of details about an item in a listing. The child fields returned are dependent on the call, the type of item or listing, and the listing site. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.BuyItNowPrice |
AmountType (double) | Conditionally |
For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing. There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid. This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings. Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ItemID |
ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails.EndTime |
dateTime | Conditionally |
Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as auction style or fixed price. Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • PersonalOffer (out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.OutOfStockControl |
boolean | Conditionally | When this field is set to 'true' the item is hidden when the quantity goes to 0 (zero) but the listing is kept alive. Using an OutOfStockControl flag in an Add/Revise/Relist call, a seller can keep a Fixed-Price GTC (Good 'Til Canceled) listing alive even when the "quantity available" value goes to 0 (zero). While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the 'OutOfStock' Enum would be returned. This is useful for a seller who is waiting for additional stock of an item. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields in an AddFixedPriceItem call) and the listing would appear again. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.PictureDetails .GalleryURL |
anyURI | Conditionally |
Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Quantity |
int | Conditionally |
The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the Item.Quantity value indicates the number of identical items the seller has available for purchase in the listing. For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the Item.Quantity should not be used; instead, the quantity of each variation is specified in the Variation.Variation.Quantity field instead. See the Creating a listing with variations eBay Help page for more information on variations. 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 3 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. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. 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. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. 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). For GetDispute: Quantity is the number of items being raised in the dispute. For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings. The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles |
SellerProfilesType | Conditionally | Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address. Business Policies payment profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies payment profile. 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 the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option, how many days the buyer has to return the item for a refund, warranty information, and restocking fee (if any). Business Policies return policy profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the return policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information. Business Policies shipping profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .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. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SellingStatus .QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that 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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing. Shipping details are not applicable to Real Estate listings and Half.com. GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .GlobalShipping |
boolean | Conditionally |
Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is False, the seller is responsible for specifying an international shipping service for the listing if desired. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Introduction to Shipping for information about Global Shipping Program eligibility. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). 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. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions .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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. 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 GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .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. Not applicable to Half.com. Applicable values: • Calculated (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. • NotSpecified (in/out) The seller did not specify the shipping type. (Not all values in ShippingTypeCodeType apply to this field.) |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.ShippingPackageDetails |
ShipPackageDetailsType | Conditionally | Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the "Get" calls if specified for the item. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method. If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.StartPrice |
AmountType (double) | Conditionally |
This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted. For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For fixed-price listings: This is the fixed-price at which a buyer may purchase the item. For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For the AddItem family of calls: Not applicable to Half.com. For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one 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). 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. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. Variation, Pictures, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .Quantity |
int | Conditionally |
This value indicates the quantity of items in 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. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total number of items 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 ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that 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. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. For GetItem and related calls: Only returned if the seller specified a SKU for the variation. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .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 names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. 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, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 40. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 50. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.Variations.Variation .WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Item.WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .OrderLineItemID |
string | Always |
A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .PaidTime |
dateTime | Conditionally |
Indicates the time when the order was marked paid. 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:
Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .PaisaPayID |
string | Conditionally | Unique identifier for a PaisaPay transaction. Only applicable for the India site (203) if PaisaPay was the payment method used. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Platform |
TransactionPlatformCodeType | Conditionally |
Name of the eBay co-branded site upon which the order line item (transaction) was created.
Applicable values: • CustomCode (in/out) Reserved for future use. • eBay (in/out) The order line item was created on the main eBay site. • Express (in/out) The order line item was created on the eBay Express site. • Half (in/out) The order line item was created on Half.com site. • Shopping (in/out) The order line item was created on the Shopping.com site. • WorldOfGood (in/out) The order line item was created on the WorldOfGood site. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .QuantityPurchased |
int | Conditionally |
This value indicates the number of identical items 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. In either case, this field is tied to the same order line item. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .SellerPaidStatus |
PaidStatusCodeType | Conditionally |
Specifies the paid status of the order. Not applicable to Half.com. Applicable values: • BuyerHasNotCompletedCheckout (out) The buyer has not completed the checkout process and so has not made payment. • CustomCode (out) Reserved for future use. • EscrowPaymentCancelled (out) The buyer has made an escrow payment, but has cancelled the payment. • MarkedAsPaid (out) The order is marked as paid by either buyer or seller. • NotPaid (out) The buyer has not completed checkout, but has not paid through PayPal or PaisaPay (but please also see the documentation for PaymentHoldStatus and its applicable values). The buyer might have paid using another method, but the payment might not have been received or cleared. Important: Please see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment. • Paid (out) Paid • PaidCOD (out) PaidCOD • PaidWithEscrow (out) The buyer has made an escrow payment, and the seller has received payment. • PaidWithPaisaPay (out) The buyer has paid with PaisaPay, and the payment is complete. • PaidWithPaisaPayEscrow (out) Paid With PaisaPay Escrow • PaidWithPayPal (out) The buyer has made a PayPal payment, and the payment is complete. But please also see the documentation for PaymentHoldStatus and its applicable values. PaymentHoldStatus contains the current status of a hold on a PayPal payment. • PaisaPayNotPaid (out) Paisa Pay Not Paid • PaymentPending (out) The buyer has made a payment other than PayPal, escrow, or PaisaPay, but the payment is still being processed. • PaymentPendingWithEscrow (out) The buyer has made an escrow payment, but the seller has not yet received it. • PaymentPendingWithPaisaPay (out) The buyer has paid with PaisaPay, but the payment is still being processed. The seller has not yet received payment. • PaymentPendingWithPaisaPayEscrow (out) Payment Pending With PaisaPay Escrow • PaymentPendingWithPayPal (out) The buyer has made a PayPal payment, but the seller has not yet received it. • Refunded (out) Refunded • WaitingForCODPayment (out) WaitingForCODPayment DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .ShippedTime |
dateTime | Conditionally |
Indicates the time when the item(s) associated with the order were 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 in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Status |
TransactionStatusType | Conditionally |
Container consisting of status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements. For GetOrders, only the IntegratedMerchantCreditCardEnabled and PaymentMethodUsed child elements are returned. The PaymentHoldStatus container will be returned for those sellers subject to the new eBay payment process. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .Status.PaymentHoldStatus |
PaymentHoldStatusCodeType | Conditionally |
This field indicates the type and/or status of a payment hold on the item.
Applicable values: • CustomCode (out) This value is reserved for internal or future use. • MerchantHold (out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying. • NewSellerHold (out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:
• None (out) This value indicates that there is no payment hold on the item. • PaymentHold (out) This value indicates that there is a payment hold on the item. • PaymentReview (out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying. • ReleaseConfirmed (out) This value indicates that the funds are available in the seller's PayPal account. • Released (out) This value indicates that a payment hold on the item has been released. • ReleasePending (out) This value indicates that the process for the release of funds for the order has been initiated. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .TotalTransactionPrice |
AmountType (double) | Conditionally |
The price of one order line item. This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through a non-variation, fixed-price listing, this value is the total combined price for all units of the order line item. With GetMyeBaySelling, you can also get this value by multiplying SellingStatus.QuantitySold by SellingStatus.CurrentPrice. For eBay Motors Vehicle listings, TotalTransactionPrice is the deposit amount. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .TotalTransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .TransactionID |
string | Conditionally |
Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed. Applicable to Half.com (for GetOrders only). Max length: 19 (Note: The eBay database specifies 38. Transaction IDs are usually 9 to 12 digits.). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .TransactionPrice |
AmountType (double) | Conditionally |
The price of one order line item. This price is returned only for Best Offer items. This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through Best Offer, this value is the per-unit price. For eBay Motors Vehicle listings, TransactionPrice is the deposit amount. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromSoldList .OrderTransactionArray .OrderTransaction.Transaction .TransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromSoldList .PaginationResult |
PaginationResultType | Conditionally |
Specifies information about the list, including number of pages and number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .PaginationResult .TotalNumberOfEntries |
int | Conditionally |
Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromSoldList .PaginationResult .TotalNumberOfPages |
int | Conditionally |
Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList | PaginatedItemArrayType | Conditionally |
Contains the items with listings that were ended or did not sell and have been deleted from My eBay.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray |
ItemArrayType | Conditionally |
Contains a list of Item types.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item |
ItemType | Conditionally,
repeatable: [0..*] |
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has 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. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.BuyItNowPrice |
AmountType (double) | Conditionally |
For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing. There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid. This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings. Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.ItemID |
ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .EndTime |
dateTime | Conditionally |
Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingDetails .StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as auction style or fixed price. Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • PersonalOffer (out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromUnsoldList .ItemArray.Item .OutOfStockControl |
boolean | Conditionally | When this field is set to 'true' the item is hidden when the quantity goes to 0 (zero) but the listing is kept alive. Using an OutOfStockControl flag in an Add/Revise/Relist call, a seller can keep a Fixed-Price GTC (Good 'Til Canceled) listing alive even when the "quantity available" value goes to 0 (zero). While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the 'OutOfStock' Enum would be returned. This is useful for a seller who is waiting for additional stock of an item. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields in an AddFixedPriceItem call) and the listing would appear again. |
|
DeletedFromUnsoldList .ItemArray.Item.PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.PictureDetails .GalleryURL |
anyURI | Conditionally |
Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromUnsoldList .ItemArray.Item.PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
DeletedFromUnsoldList .ItemArray.Item.Quantity |
int | Conditionally |
The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the Item.Quantity value indicates the number of identical items the seller has available for purchase in the listing. For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the Item.Quantity should not be used; instead, the quantity of each variation is specified in the Variation.Variation.Quantity field instead. See the Creating a listing with variations eBay Help page for more information on variations. 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 3 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. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. 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. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. 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). For GetDispute: Quantity is the number of items being raised in the dispute. For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item .QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
DeletedFromUnsoldList .ItemArray.Item.ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings. The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| DeletedFromUnsoldList .ItemArray.Item.ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.SellerProfiles |
SellerProfilesType | Conditionally | Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing. |
|
DeletedFromUnsoldList .ItemArray.Item.SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address. Business Policies payment profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
DeletedFromUnsoldList .ItemArray.Item.SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies payment profile. 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 the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile. |
|
DeletedFromUnsoldList .ItemArray.Item.SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option, how many days the buyer has to return the item for a refund, warranty information, and restocking fee (if any). Business Policies return policy profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
DeletedFromUnsoldList .ItemArray.Item.SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
DeletedFromUnsoldList .ItemArray.Item.SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the return policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
DeletedFromUnsoldList .ItemArray.Item.SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information. Business Policies shipping profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
DeletedFromUnsoldList .ItemArray.Item.SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
DeletedFromUnsoldList .ItemArray.Item.SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
DeletedFromUnsoldList .ItemArray.Item.SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .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. |
| DeletedFromUnsoldList .ItemArray.Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.SellingStatus .QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that 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. |
|
DeletedFromUnsoldList .ItemArray.Item .ShippingDetails |
ShippingDetailsType | Conditionally |
The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing. Shipping details are not applicable to Real Estate listings and Half.com. GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromUnsoldList .ItemArray.Item .ShippingDetails .GlobalShipping |
boolean | Conditionally |
Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is False, the seller is responsible for specifying an international shipping service for the listing if desired. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Introduction to Shipping for information about Global Shipping Program eligibility. |
|
DeletedFromUnsoldList .ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). 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. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
DeletedFromUnsoldList .ItemArray.Item .ShippingDetails .ShippingServiceOptions .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. |
|
DeletedFromUnsoldList .ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. 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 GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .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. Not applicable to Half.com. Applicable values: • Calculated (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. • NotSpecified (in/out) The seller did not specify the shipping type. (Not all values in ShippingTypeCodeType apply to this field.) |
|
DeletedFromUnsoldList .ItemArray.Item .ShippingPackageDetails |
ShipPackageDetailsType | Conditionally | Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the "Get" calls if specified for the item. |
|
DeletedFromUnsoldList .ItemArray.Item.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method. If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
DeletedFromUnsoldList .ItemArray.Item.StartPrice |
AmountType (double) | Conditionally |
This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted. For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For fixed-price listings: This is the fixed-price at which a buyer may purchase the item. For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| DeletedFromUnsoldList .ItemArray.Item.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .ItemArray.Item.TimeLeft |
duration | Conditionally |
Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). See Data Types in the Trading API Guide for information about this format. For ended listings, the time left is PT0S (zero seconds). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For the AddItem family of calls: Not applicable to Half.com. For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one 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). 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. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. Variation, Pictures, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.PrivateNotes |
string | Conditionally |
A note a user makes on an item with variations in My eBay. For eBay.com, only GetMyeBaySelling (not GetItem) returns this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseFixedPriceItem. Use SetUserNotes instead. In SoldList, notes for variations are only returned at the Item level, not the variation level. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.Quantity |
int | Conditionally |
This value indicates the quantity of items in 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. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total number of items 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 ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.SellingStatus .QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that 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. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. For GetItem and related calls: Only returned if the seller specified a SKU for the variation. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
DeletedFromUnsoldList .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 names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. 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, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 40. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 50. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.Variations .Variation.WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .ItemArray.Item.WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
|
DeletedFromUnsoldList .PaginationResult |
PaginationResultType | Conditionally |
Provides information about the list, including number of pages and number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .PaginationResult .TotalNumberOfEntries |
int | Conditionally |
Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
DeletedFromUnsoldList .PaginationResult .TotalNumberOfPages |
int | Conditionally |
Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList | PaginatedItemArrayType | Conditionally |
Contains the items the user has scheduled for sale, but whose listings have not yet started.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray | ItemArrayType | Conditionally |
Contains a list of Item types.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item | ItemType | Conditionally,
repeatable: [0..*] |
Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has 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. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .BuyItNowPrice |
AmountType (double) | Conditionally |
For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy It Now price and end the auction immediately. Use this field to specify the Buy It Now price. Including and specifying a BuyItNowPrice value enables the Buy It Now feature for the auction listing. There is a minimum percentage value that the Buy It Now price must be set above the Start Price. This minimum percentage value varies by site. To see the valid values for your site, call GeteBayDetails with DetailName set to ListingStartPriceDetails, and then look for the ListingStartPriceDetails.MinBuyItNowPricePercent field in the response. If this value is 40.0 (percent), that means that your Buy It Now price on your auction listing must exceed the Start Price by 40 percent to be valid. This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com listings. Once an auction has bids (and the high bid exceeds the Reserve Price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem still return the BuyItNowPrice that the seller originally set for the listing. Use the GetItem call and look for the inclusion of the Item.ListingDetails.BuyItNowAvailable flag in the output to determine whether the item can still be purchased using Buy It Now. You can also view the Item.SellingStatus.BidCount value in other item retrieval calls to determine whether an auction with Buy It Now has bids or not. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .eBayNotes |
string | Conditionally |
Returns a note from eBay displayed below items in the user's My eBay account. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .ItemID |
ItemIDType (string) | Conditionally |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .ListingDetails |
ListingDetailsType | Conditionally |
Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .ListingDetails .ConvertedBuyItNowPrice |
AmountType (double) | Conditionally |
Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .ListingDetails .ConvertedBuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ListingDetails .ConvertedReservePrice |
AmountType (double) | Conditionally |
Converted value of the ReservePrice in the currency of the site that returned this response. Only returned for listings with a reserve price when the requesting user is the listing's seller. For active items, refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Fixed Price and Store Inventory listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .ListingDetails .ConvertedReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ListingDetails .ConvertedStartPrice |
AmountType (double) | Conditionally |
Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .ListingDetails .ConvertedStartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ListingDetails.StartTime |
dateTime | Conditionally |
The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed.
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. To set a duration of 1 day, the seller must have a Feedback score of at least 10. When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours. Required for Half.com (but only specify GTC). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
Applicable values: See ListingDurationCodeType |
|
ScheduledList.ItemArray.Item .ListingType |
ListingTypeCodeType | Conditionally |
The format of the listing the seller wants to use, such as auction style or fixed price. Optional for eBay.com listings (defaults to auction style) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills in a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • PersonalOffer (out) Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing. eBay does not charge an Insertion Fee, but if the bidder accepts the offer, the regular Final Value Fee is charged. In the case of an Unpaid Item, the seller should ensure that everything has been done to resolve the issue with the winning bidder before sending a Second Chance Offer to another bidder. See the Unpaid Items Process for details. Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. Use AddSecondChanceItem to submit Second Chance Offers. Listed on eBay, but does not appear when browsing or searching listings. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. (Not all values in ListingTypeCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .OutOfStockControl |
boolean | Conditionally | When this field is set to 'true' the item is hidden when the quantity goes to 0 (zero) but the listing is kept alive. Using an OutOfStockControl flag in an Add/Revise/Relist call, a seller can keep a Fixed-Price GTC (Good 'Til Canceled) listing alive even when the "quantity available" value goes to 0 (zero). While the "quantity available" value is 0, the listing would be hidden from eBay search, and if that item was specifically searched for with GetItem (or related call), the 'OutOfStock' Enum would be returned. This is useful for a seller who is waiting for additional stock of an item. Instead of ending the listing and then recreating it when the inventory arrives, they can use this flag to hide the listing. Then when they have the item available they can update the inventory of the item (through the Item.Quantity or Item.Variations.Variation.Quantity fields in an AddFixedPriceItem call) and the listing would appear again. |
|
ScheduledList.ItemArray.Item .PictureDetails |
PictureDetailsType | Conditionally |
Contains the data for a picture associated with an item. With the exception of eBay Motors vehicle listings, you can add up to 12 standard pictures free of charge. It is required that all listings have at least one picture. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .PictureDetails.GalleryURL |
anyURI | Conditionally |
Supported in Production only (not Sandbox). The URL for a picture used as the Gallery thumbnail. On a free-Gallery site, if there is a PictureURL, the PictureURL fills in or replaces the GalleryURL. Note that GalleryURL is ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: The following sites offer free Gallery: US (site ID 0), the Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), ES (site ID 186), FR (site ID 71), IT (site ID 101),and NL (site ID 146). On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs was specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Note: If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name. Max length: 1024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .PrivateNotes |
string | Conditionally |
A note a user makes on an item in their My eBay account. The note is prefaced with the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem) return this field, and only if you pass IncludeNotes in the request. Only visible to the user who created the note. Not supported as input in ReviseItem. Use SetUserNotes instead. For GetMyeBayBuying In WatchList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the site). In WonList, notes for variations are only returned at the Item level, not the variation level. They are only set if you specified ItemID and TransactionID in SetUserNotes (or selected the equivalent in the My eBay UI on the site). Not applicable to Half.com (instead, use Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) |
|
ScheduledList.ItemArray.Item .Quantity |
int | Conditionally |
The value indicates the quantity of items available for purchase in the listing. This field is required for all auction listings and for non-variation, fixed-price listings. For auction listings, this value is always '1'. For a non-variation, fixed-price listing, the Item.Quantity value indicates the number of identical items the seller has available for purchase in the listing. For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and ReviseFixedPriceItem: in a multi-variation, fixed-price listing, the Item.Quantity should not be used; instead, the quantity of each variation is specified in the Variation.Variation.Quantity field instead. See the Creating a listing with variations eBay Help page for more information on variations. 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 3 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. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. 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. Even for items that supported Dutch auctions, where one of several items can be purchased during the auction, this number does not change. 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). For GetDispute: Quantity is the number of items being raised in the dispute. For SetCart input, this is only required if the parent container is submitted. Also applicable to Half.com (valid range 1 to 1000). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .QuantityAvailable |
int | Conditionally |
Specifies how many of a certain item are available. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .QuestionCount |
long | Conditionally |
Specifies the number of questions buyers have posted about the item. Returned only if greater than 0. Not applicable to Half.com. |
|
ScheduledList.ItemArray.Item .ReservePrice |
AmountType (double) | Conditionally |
The lowest price at which the seller is willing to sell the item. (StartPrice must be lower than ReservePrice.) Not all categories support a reserve price. See GetCategories and "Determining Whether a Category Supports Reserve Prices" in the Trading API Guide. In calls that retrieve item data, ReservePrice only has a non-zero value for listings with a reserve price and where the user requesting the item data is also the item's seller. Not applicable to fixed- price items or ad format listings. You can remove the reserve price of a US eBay Motors listing if the category allows it, the current reserve price has not been met, and the reserve price is at least $2.00 more than the current high bid. In this case, if the item has bids, the reserve price is set to $1.00 over the current high bid. The next bid meets the reserve and wins. See the Fees Overview on the eBay Web site for information about fee credits that may be available when the reserve price is removed for a Motors listing. See the Trading API Guide for validation rules when revising US Motors listings. The relisted item cannot have a reserve price if the original listing didn't have one. If the original listing had a reserve price, the relisted item's reserve price can't be greater than that of the original listing. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
| ScheduledList.ItemArray.Item .ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .SellerProfiles |
SellerProfilesType | Conditionally | Root container consisting of references to one or more Business Policies profiles. Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile may be applied to the listing. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerPaymentProfile |
SellerPaymentProfileType | Conditionally |
The SellerPaymentProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies payment profile. Business Policies payment profiles contain accepted payment methods, a flag to set up the immediate payment feature, a payment instructions field, and a field to specify the seller's PayPal email address. Business Policies payment profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerPaymentProfile .PaymentProfileName |
string | Conditionally |
The name of a Business Policies payment profile. A PaymentProfileID and/or a PaymentProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies payment profile. 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 the listing is using a Business Policies payment profile, and the PaymentProfileName value will be returned if a name is assigned to the payment profile. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerReturnProfile |
SellerReturnProfileType | Conditionally |
The SellerReturnProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies return policy profile. Business Policies return policy profiles contain detailed information on the seller's return policy, including the refund option, how many days the buyer has to return the item for a refund, warranty information, and restocking fee (if any). Business Policies return policy profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileID |
long | Conditionally |
The unique identifier of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the payment policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerReturnProfile .ReturnProfileName |
string | Conditionally |
The name of a Business Policies return policy profile. A ReturnProfileID and/or a ReturnProfileName value is used in the Add/Revise/Relist call to reference and use the return policy values of a Business Policies return policy profile. 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 the listing is using a Business Policies return policy profile, and the ReturnProfileName value will be returned if a name is assigned to the return policy profile. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerShippingProfile |
SellerShippingProfileType | Conditionally |
The SellerShippingProfile container is used in an Add/Revise/Relist Trading API call to reference and use the values of a Business Policies shipping policy profile. Business Policies shipping profiles contain detailed information on domestic and international shipping, including shipping service options, handling time, package handling costs, excluded ship-to locations, and shipping insurance information. Business Policies shipping profiles are also returned in GetItem, GetMyeBaySelling, and other Trading calls that retrieve Item data. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileID |
long | Conditionally |
The unique identifier of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
ScheduledList.ItemArray.Item .SellerProfiles .SellerShippingProfile .ShippingProfileName |
string | Conditionally |
The name of a Business Policies shipping policy profile. A ShippingProfileID and/or a ShippingProfileName value is used in the Add/Revise/Relist call to reference and use the shipping policy values of a Business Policies shipping policy profile. 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 the listing is using a Business Policies shipping policy profile, and the ShippingProfileName value will be returned if a name is assigned to the shipping policy profile. |
|
ScheduledList.ItemArray.Item .SellingStatus |
SellingStatusType | Conditionally |
Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. IMPORTANT: To avoid loss of shipping details when revising a listing, you must include all ShippingDetails fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing. Shipping details are not applicable to Real Estate listings and Half.com. GetMyeBayBuying, GetMyeBaySelling: ShippingDetails is not returned (with a request version 677 or higher) if (a) the item is marked as local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a request version lower than 677, ShippingDetails is returned.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .ShippingDetails .GlobalShipping |
boolean | Conditionally |
Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of GlobalShipping is True, the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of GlobalShipping is False, the seller is responsible for specifying an international shipping service for the listing if desired. When calling RelistFixedPriceItem, RelistItem, ReviseFixedPriceItem or ReviseItem, you can omit this field if its value doesn't need to change. Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Introduction to Shipping for information about Global Shipping Program eligibility. |
|
ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). 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. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .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 meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. 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 GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingSurcharge |
AmountType (double) | Conditionally | An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only. |
| ScheduledList.ItemArray.Item .ShippingDetails .ShippingServiceOptions .ShippingSurcharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. Not applicable to Half.com. Applicable values: • Calculated (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. • NotSpecified (in/out) The seller did not specify the shipping type. (Not all values in ShippingTypeCodeType apply to this field.) |
|
ScheduledList.ItemArray.Item .ShippingPackageDetails |
ShipPackageDetailsType | Conditionally | Container consisting of dimension and size details related to a shipping package in which an item will be sent. The information in this container is applicable if the seller is using calculated shipping or flat rate shipping using shipping rate tables with weight surcharges. This container is only returned in the "Get" calls if specified for the item. |
|
ScheduledList.ItemArray.Item .SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method. If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
ScheduledList.ItemArray.Item .StartPrice |
AmountType (double) | Conditionally |
This value indicates the starting price of the item when it is listed for the first time, or when it is revised or relisted. For auction listings: competitive bidding starts at this value. Once at least one bid has been placed, StartPrice remains the same but CurrentPrice is increased to the amount of the current highest bid. If ReservePrice is also specified, the value of StartPrice must be lower than the value of ReservePrice. For fixed-price listings: This is the fixed-price at which a buyer may purchase the item. For both auction and fixed-price listings, there is a minimum value that may be specified as a StartPrice value. These minimum values vary per site. To retrieve these minimum values for a site, call GeteBayDetails passing in your SiteID value as a header, and using ListingStartPriceDetails as a DetailName value. In the GeteBayDetails response, look for the ListingStartPriceDetails.StartPrice fields for the 'Chinese' and 'FixedPriceItem' listing types. Note: There are seller limits on the US site for users who registered after October 2010. Seller limits control the quantity of items and/or the total value of the item(s) in the listing. (The GetMyeBaySelling call returns the remaining item quantity and remaining total value under the limits for the seller, if any such limits exist for the seller). 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. For auction listings, the total value limit applies to the start price, not the final sale amount. For more information, see the link to Seller Limits below. GetMyeBaySelling does not return Item.StartPrice for fixed-price items; it returns Item.SellingStatus.CurrentPrice. For AddFixedPriceItem and VerifyAddFixedPriceItem: Required when no variations are specified. If variations are specified, use Variation.StartPrice for each variation instead. Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this field for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing Policies. |
| ScheduledList.ItemArray.Item .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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). Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Title |
string | Conditionally |
Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For the AddItem family of calls: Not applicable to Half.com. For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations |
VariationsType | Conditionally |
Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one 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). 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. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation |
VariationType | Conditionally,
repeatable: [0..*] |
Contains data that distinguishes one variation from another. For example, if the items vary by color and size, each Variation node specifies a combination of one of those colors and sizes. When listing or relisting an item, you are allowed to create a listing with only one variation if you plan to add more variations to it in the future. However, if you don't plan to add other variations, we recommend that you avoid listing with only one variation, so that you avoid confusing buyers. When you modify a variation, it's safest to specify all the fields with the values you want in the listing. At a minimum, StartPrice and VariationSpecifics are required to modify an existing variation. If you omit SKU, the existing SKU (if any) is deleted from the variation. If you omit Quantity, it is set to 0. Variation, Pictures, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests. 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 items in 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. For GetItem (and other related calls that retrieve the Item object), the Variation.Quantity value indicates the total number of items 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 ReviseFixedPriceItem: You can revise a variation's quantity at any time, even if it has purchases. However, at least one variation must remain with a non-zero quantity in order for the listing to remain active. When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. If you revise the Quantity value for a variation after items have already sold, specify the quantity available for sale. (eBay will automatically add the quantity sold to the value you specify.) If you set the quantity to 0 and the variation has no purchases, the variation may be dropped from the listing. For GetSellerTransactions: See Item.Quantity instead. See the Trading API Guide for more details about setting and modifying a variation's quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .SellingStatus |
SellingStatusType | Conditionally |
Contains the variation's quantity sold. Always returned when variations are present.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .SellingStatus.QuantitySold |
int | Conditionally |
The total number of items purchased so far (in the listing's lifetime). Subtract this from Quantity to determine the quantity available. If the listing has Item Variations, then in GetItem (and related calls) and GetItemTransactions, Item.SellingStatus.QuantitySold contains the sum of all quantities sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number of items sold for that variation. In GetSellerTransactions, Transaction.Item.SellingStatus.QuantitySold contains the number of items sold in that 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.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. For GetItem and related calls: Only returned if the seller specified a SKU for the variation. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .StartPrice |
AmountType (double) | Conditionally |
The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00. Each variation requires its own price, and the prices can be different for each variation. This enables sellers to provide discounts on certain variations without affecting the price of others. Required (and always returned) for listings with variations. You can revise a variation's price at any time (even if it has purchases). When you modify a variation during revise or relist, you need to include both its StartPrice and Quantity. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ScheduledList.ItemArray.Item .Variations.Variation .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. When you revise a listing that includes variations, you can change names in variation specifics by using ModifyNameList. 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, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 40. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 50. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from the VariationSpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. PayPal may also use this value to identify item variations(for buyers and sellers).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .Variations.Variation .WatchCount |
long | Conditionally |
The number of watches placed on this variation by eBay users.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.ItemArray.Item .WatchCount |
long | Conditionally |
The number of watches placed on this item from buyers' My eBay accounts. Specify IncludeWatchCount as true in the request. Returned by GetMyeBaySelling only if greater than 0. Not applicable to Half.com. |
| ScheduledList.PaginationResult | PaginationResultType | Conditionally |
Provides information about the list, including number of pages and number of entries.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
ScheduledList.PaginationResult .TotalNumberOfEntries |
int | Conditionally |
Indicates the total number of entries that could be returned by repeated 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 | Always |
Contains summary information about the items the user is selling.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .ActiveAuctionCount |
int | Always |
The number of currently active auctions that will sell. That is, there is at least one bidder, and any reserve price has been met. Equivalent to the "Will Sell" value in My eBay.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SellingSummary.AuctionBidCount | int | Always |
The total number of bids made on the seller's active auction listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .AuctionSellingCount |
int | Always |
The total number of currently active auctions for a given seller. Equivalent to the "Auction Quantity" value in My eBay.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .SoldDurationInDays |
int | Always |
The average duration, in days, of all items sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SellingSummary .TotalAuctionSellingValue |
AmountType (double) | Always |
The total value of all items the seller has for sale in all listings.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SellingSummary .TotalAuctionSellingValue [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
| SellingSummary.TotalSoldCount | int | Always |
The total number of items the seller has sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Discrepancies Between Results of GetMyeBaySelling and GetSellerTransactions. |
| SellingSummary.TotalSoldValue | AmountType (double) | Always |
The total monetary value of the items the seller has sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Discrepancies Between Results of GetMyeBaySelling and GetSellerTransactions. |
| SellingSummary.TotalSoldValue [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
| SoldList | PaginatedOrderTransactionArrayType | Conditionally |
Contains the items the user has sold.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| SoldList.OrderTransactionArray | OrderTransactionArrayType | Conditionally |
Contains the list of orders.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction |
OrderTransactionType | Conditionally,
repeatable: [0..*] |
The individual order or transaction.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order |
OrderType | Conditionally |
Contains the information describing an order.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .OrderID |
OrderIDType (string) | Conditionally |
A unique identifier that identifies a single line item or multiple line item order. For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order or an order that goes through the eBay shopping cart flow, the OrderID value is automatically created by eBay. A Combined Payment order can be created through the site by a buyer or seller when the buyer or seller share multiple, common order line items. A Combined Payment order can also be created by the seller through the AddOrder call. An OrderID value overrides an OrderLineItemID value or an ItemID/TransactionID pair if these fields are also specified in the same request. Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
SoldList.OrderTransactionArray .OrderTransaction.Order .RefundAmount |
AmountType (double) | Conditionally |
Amount of the refund issued to the buyer. This field is only returned for a DE/AT order subject to the new eBay payment process, and if a refund was issued to the buyer. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll. A |