Note: GetSellingManagerSoldListings and all Selling Manager Pro calls are being deprecated. Selling Manager Pro calls will start being decommissioned beginning on June 1, 2021. The GetOrders call of Trading API or the Fulfillment API should be used to retrieve orders. |
Returns a Selling Manager user's sold listings. Response can be filtered by date, search values, and stores. To use this call, you must be a Selling Manager Pro subscriber.
See:
Using Selling Manager Calls in the Trading API
Selling Manager Pro page on the eBay Site
See also the reference documentation for this call:
Output Detail Controls Samples Change History |
See also Samples.
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?> <GetSellingManagerSoldListingsRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <Archived> boolean </Archived> <Filter> SellingManagerSoldListingsPropertyTypeCodeType </Filter> <!-- ... more Filter values allowed here ... --> <Pagination> PaginationType <EntriesPerPage> int </EntriesPerPage> <PageNumber> int </PageNumber> </Pagination> <SaleDateRange> TimeRangeType <TimeFrom> dateTime </TimeFrom> <TimeTo> dateTime </TimeTo> </SaleDateRange> <Search> SellingManagerSearchType <SearchType> SellingManagerSearchTypeCodeType </SearchType> <SearchValue> string </SearchValue> </Search> <Sort> SellingManagerSoldListingsSortTypeCodeType </Sort> <SortOrder> SortOrderCodeType </SortOrder> <StoreCategoryID> long </StoreCategoryID> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </GetSellingManagerSoldListingsRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
Archived | boolean | Conditional |
This field is included and set to true if the seller would like to retrieve one or more archived orders between 90 and 120 days old.
|
Filter | SellingManagerSoldListingsPropertyTypeCodeType | Optional,
repeatable: [0..*] |
One or more Filter fields can be used to retrieve Selling Manager Sale Records for orders that are in a certain state. See SellingManagerSoldListingsPropertyTypeCodeType for the supported values.
Applicable values: See Filter. |
Pagination | PaginationType | Optional | This container is used if the seller would like to control how many Sale Records are returned per page and which page to view. |
Pagination.EntriesPerPage | int | Optional |
This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. |
Pagination.PageNumber | int | Optional |
Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for the individual calls to determine the correct default value. Min: 1. Default: 1. |
SaleDateRange | TimeRangeType | Optional |
This container allows the seller to retrieve orders that were purchased within a specified time range. A time range can be set up to 90 days in the past (or up to 120 days if the Archived field is included and set to true .
|
SaleDateRange.TimeFrom | dateTime | Optional | Specifies the earliest (oldest) date to be used in a date range. |
SaleDateRange.TimeTo | dateTime | Optional | Specifies the latest (most recent) date to be used in a date range. |
Search | SellingManagerSearchType | Optional | This container is used if the seller would like to search for Selling Manager Sele Records based on certain identifiers like Saler Record ID, Item ID, listing title, buyer user ID, etc. The seller will specify one of the supported search types in SellingManagerSearchTypeCodeType, and then provides the value for that search type. |
Search.SearchType | SellingManagerSearchTypeCodeType | Optional |
Specifies the type of value, such as ProductID or BuyerUserID, for the search.
Applicable values: See SearchType. |
Search.SearchValue | string | Optional | String identifying the value, matching the SearchType, that the search should return listings for. For example, when ProductID is specified as the SearchType, SearchValue must be a valid ProductID. |
Sort | SellingManagerSoldListingsSortTypeCodeType | Optional |
This field is used if the seller would like to sort Selling Manager Sale Record results based on a specific aspect such as purchase date, checkout status, total price, etc. See SellingManagerSoldListingsSortTypeCodeType to read more about the available sorting options.
Applicable values: See Sort. |
SortOrder | SortOrderCodeType | Optional |
This field allows the seller to sort in ascending or descending order (based on the selected aspect in the Sort field).
Applicable values: |
StoreCategoryID | long | Optional | This field is used if the seller would like to retrieve all Selling Manager Sale Records for products listed in a specific eBay Store Category. |
Standard Input Fields |
ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
||||||||||||||||||||||||||||||||||||||||
Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
||||||||||||||||||||||||||||||||||||||||
WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
Input Detail Controls Samples Change History |
See also Samples.
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
<?xml version="1.0" encoding="utf-8"?> <GetSellingManagerSoldListingsResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <PaginationResult> PaginationResultType <TotalNumberOfEntries> int </TotalNumberOfEntries> <TotalNumberOfPages> int </TotalNumberOfPages> </PaginationResult> <SaleRecord> SellingManagerSoldOrderType <BuyerEmail> string </BuyerEmail> <BuyerID> string </BuyerID> <CashOnDeliveryCost currencyID="CurrencyCodeType"> AmountType (double) </CashOnDeliveryCost> <CreationTime> dateTime </CreationTime> <DaysSinceSale> int </DaysSinceSale> <ItemCost currencyID="CurrencyCodeType"> AmountType (double) </ItemCost> <OrderStatus> SellingManagerOrderStatusType <CheckoutStatus> CheckoutStatusCodeType </CheckoutStatus> <FeedbackReceived> CommentTypeCodeType </FeedbackReceived> <FeedbackSent> boolean </FeedbackSent> <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled> <PaidStatus> SellingManagerPaidStatusCodeType </PaidStatus> <PaidTime> dateTime </PaidTime> <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus> <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed> <ShippedStatus> SellingManagerShippedStatusCodeType </ShippedStatus> <ShippedTime> dateTime </ShippedTime> <TotalEmailsSent> int </TotalEmailsSent> </OrderStatus> <SalePrice currencyID="CurrencyCodeType"> AmountType (double) </SalePrice> <SaleRecordID> long </SaleRecordID> <SellingManagerSoldTransaction> SellingManagerSoldTransactionType <CharityListing> boolean </CharityListing> <CustomLabel> string </CustomLabel> <ItemID> ItemIDType (string) </ItemID> <ItemTitle> string </ItemTitle> <ListedOn> TransactionPlatformCodeType </ListedOn> <!-- ... more ListedOn values allowed here ... --> <ListingType> ListingTypeCodeType </ListingType> <OrderLineItemID> string </OrderLineItemID> <QuantitySold> int </QuantitySold> <Relisted> boolean </Relisted> <ReservePrice currencyID="CurrencyCodeType"> AmountType (double) </ReservePrice> <SaleRecordID> long </SaleRecordID> <SecondChanceOfferSent> boolean </SecondChanceOfferSent> <SoldOn> TransactionPlatformCodeType </SoldOn> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> <TransactionID> long </TransactionID> <Variation> VariationType </Variation> <WatchCount> int </WatchCount> </SellingManagerSoldTransaction> <!-- ... more SellingManagerSoldTransaction nodes allowed here ... --> <ShippingAddress> AddressType <Name> string </Name> <PostalCode> string </PostalCode> </ShippingAddress> <ShippingDetails> ShippingDetailsType <ShippingType> ShippingTypeCodeType </ShippingType> </ShippingDetails> <TotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalAmount> <TotalQuantity> int </TotalQuantity> <UnpaidItemStatus> UnpaidItemStatusTypeCodeType </UnpaidItemStatus> </SaleRecord> <!-- ... more SaleRecord nodes allowed here ... --> <!-- 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> </GetSellingManagerSoldListingsResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
PaginationResult | PaginationResultType | Always | Contains the total number of pages (TotalNumberOfPages) and the total number of products entries (TotalNumberOfEntries) that can be returned on repeated calls with the same format and report criteria. |
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. |
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. |
SaleRecord | SellingManagerSoldOrderType | Always,
repeatable: [1..*] |
A SaleRecord container is returned for each order that matches the input criteria. |
SaleRecord.BuyerEmail | string | Always | The email of the buyer. |
SaleRecord.BuyerID | string | Always | The user ID of the buyer. |
SaleRecord.CashOnDeliveryCost | AmountType (double) | Conditionally | The cost of cash-on-delivery. |
SaleRecord.CashOnDeliveryCost [ attribute currencyID ] |
CurrencyCodeType | Always |
The cost of cash-on-delivery. For a list of possible enumeration values, see CurrencyCodeType. |
SaleRecord.CreationTime | dateTime | Always | The sale date. |
SaleRecord.DaysSinceSale | int | Always | Number of days since the sale. |
SaleRecord.ItemCost | AmountType (double) | Conditionally | A SMPro seller can record the cost of the item, as calculated by the seller, in this field. |
SaleRecord.ItemCost [ attribute currencyID ] |
CurrencyCodeType | Always |
A SMPro seller can record the cost of the item, as calculated by the seller, in this field. For a list of possible enumeration values, see CurrencyCodeType. |
SaleRecord.OrderStatus | SellingManagerOrderStatusType | Always | Status of the order regarding payment, shipping, feedback, and other communications. |
SaleRecord.OrderStatus .CheckoutStatus |
CheckoutStatusCodeType | Conditionally |
Indicates the current status of the checkout flow for the order.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
SaleRecord.OrderStatus .FeedbackReceived |
CommentTypeCodeType | Conditionally |
The type of feedback received (if feedback was received).
Applicable values: See FeedbackReceived. Code so that your app gracefully handles any future changes to this list. |
SaleRecord.OrderStatus .FeedbackSent |
boolean | Conditionally | Whether the seller has left feedback. |
SaleRecord.OrderStatus .IntegratedMerchantCreditCardEnabled |
boolean | Conditionally |
Indicates whether the order can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true , then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true , and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. A payment gateway account is used by sellers to accept online credit cards (Visa, MasterCard, American Express, and Discover). Note: Beginning on May 1, 2019, eBay will no longer support electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller). |
SaleRecord.OrderStatus .PaidStatus |
SellingManagerPaidStatusCodeType | Conditionally |
The paid status of the order.
Applicable values: See PaidStatus. Code so that your app gracefully handles any future changes to this list. |
SaleRecord.OrderStatus .PaidTime |
dateTime | Conditionally | Date on which the order was paid. |
SaleRecord.OrderStatus .PaymentHoldStatus |
PaymentHoldStatusCodeType | Conditionally |
Contains the current status of a hold on a PayPal payment. The payment hold that is referred to as a "payment review" hold results from a possible issue with a buyer. The payment hold referred to as a "merchant hold" results from a possible issue with a seller. For more information, please see the link below.
Applicable values: See PaymentHoldStatus. Code so that your app gracefully handles any future changes to this list. |
SaleRecord.OrderStatus .PaymentMethodUsed |
BuyerPaymentMethodCodeType | Conditionally |
The payment method the buyer selected for paying the seller for the order. If checkout is incomplete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.
Applicable values: See PaymentMethodUsed. Code so that your app gracefully handles any future changes to this list. |
SaleRecord.OrderStatus .ShippedStatus |
SellingManagerShippedStatusCodeType | Conditionally |
The shipped status of the order.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
SaleRecord.OrderStatus .ShippedTime |
dateTime | Conditionally | The date on which the seller marks the item as shipped, either set by default as the date date the item was marked shipped or set explicitly by the seller using the Edit Sales Record page. Note that sellers have the ability to set this value up to 3 calendar days in the future. |
SaleRecord.OrderStatus .TotalEmailsSent |
int | Conditionally | The total emails sent. |
SaleRecord.SalePrice | AmountType (double) | Always | Amount of the accepted offer for the listing. |
SaleRecord.SalePrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Amount of the accepted offer for the listing. For a list of possible enumeration values, see CurrencyCodeType. |
SaleRecord.SaleRecordID | long | Always | The sale record ID. Applicable to Selling Manager users. When an item is sold, Selling Manager generates a sale record. A sale record contains buyer information, shipping, and other information. A sale record is displayed in the Sold view in Selling Manager. Each sale record has a sale record ID. In the following calls, the value for the sale record ID is in the SellingManagerSalesRecordNumber field: GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. In the Selling Manager calls, the value for the sale record ID is in the SaleRecordID field. The sale record ID can be for single or multiple line item orders. |
SaleRecord .SellingManagerSoldTransaction |
SellingManagerSoldTransactionType | Always,
repeatable: [1..*] |
Information about one line item in the order. |
SaleRecord .SellingManagerSoldTransaction .CharityListing |
boolean | Conditionally | This field is returned as 'true' if the item is listed as a charity item. |
SaleRecord .SellingManagerSoldTransaction .CustomLabel |
string | Conditionally | Custom label associated with this order line item. |
SaleRecord .SellingManagerSoldTransaction .ItemID |
ItemIDType (string) | Always | Unique identifier for an eBay listing. |
SaleRecord .SellingManagerSoldTransaction .ItemTitle |
string | Always |
The title of the item listing. Max length: 80. |
SaleRecord .SellingManagerSoldTransaction .ListedOn |
TransactionPlatformCodeType | Conditionally,
repeatable: [0..*] |
The platform on which the item was listed.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
SaleRecord .SellingManagerSoldTransaction .ListingType |
ListingTypeCodeType | Conditionally |
The item listing type.
Applicable values: See ListingType. Code so that your app gracefully handles any future changes to this list. |
SaleRecord .SellingManagerSoldTransaction .OrderLineItemID |
string | Always | A unique identifier for an eBay order line item. . |
SaleRecord .SellingManagerSoldTransaction .QuantitySold |
int | Always | Total number of identical items sold in the order line item. |
SaleRecord .SellingManagerSoldTransaction .Relisted |
boolean | Conditionally | Boolean value indicating whether the item is a relisted item. |
SaleRecord .SellingManagerSoldTransaction .ReservePrice |
AmountType (double) | Conditionally | Reserve Price of the item (if a Reserve Price was set for the item). |
SaleRecord .SellingManagerSoldTransaction .ReservePrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Reserve Price of the item (if a Reserve Price was set for the item). For a list of possible enumeration values, see CurrencyCodeType. |
SaleRecord .SellingManagerSoldTransaction .SaleRecordID |
long | Always |
Unique identifier for a Selling Manager sale record. This field is created at the same time as the order line item (transaction). A sale record is displayed in the Sold view in Selling Manager and contains information on the buyer and shipping. In the GetItemTransactions, GetSellerTransactions, GetOrders, and GetOrderTransactions calls, the SaleRecordID value is reflected in the ShippingDetails.SellingManagerSalesRecordNumber field. For orders that occurred within the last 30 days, passing only the SaleRecordID into the GetSellingManagerSoldListings request will return the sale record. However, for sales that occurred more than 30 days ago, the SaleDateRange container must also be used, passing in a date range that includes the date on which the specific sale occurred. |
SaleRecord .SellingManagerSoldTransaction .SecondChanceOfferSent |
boolean | Conditionally | Boolean value indicating whether or not a Second Chance offer was sent by the seller to an eligible bidder. |
SaleRecord .SellingManagerSoldTransaction .SoldOn |
TransactionPlatformCodeType | Conditionally |
The platform on which the item was sold.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
SaleRecord .SellingManagerSoldTransaction .StartPrice |
AmountType (double) | Conditionally | Start price of the item. |
SaleRecord .SellingManagerSoldTransaction .StartPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Start price of the item. For a list of possible enumeration values, see CurrencyCodeType. |
SaleRecord .SellingManagerSoldTransaction .TransactionID |
long | Always | 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. |
SaleRecord .SellingManagerSoldTransaction .Variation |
VariationType | Conditionally |
In a fixed-priced listing, a seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price. Due to the possible price differentiation, buyers can buy multiple items from this listing at the same time, but all of the items must be of the same variation. One order line item is created whether one or multiple items of the same variation are purchased. The Variation node contains information about which variation was purchased. Therefore, applications that process order line items should always check to see if this node is present. |
SaleRecord .SellingManagerSoldTransaction .WatchCount |
int | Conditionally | Number of users watching the item. |
SaleRecord.ShippingAddress | AddressType | Always | Shipping address of a buyer. |
SaleRecord.ShippingAddress .Name |
string | Conditionally |
The eBay user's name associated with an address on file with eBay. Max length: 128. |
SaleRecord.ShippingAddress .PostalCode |
string | Conditionally |
User's postal code. For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. |
SaleRecord.ShippingDetails | ShippingDetailsType | Always | The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs. |
SaleRecord.ShippingDetails .ShippingType |
ShippingTypeCodeType | Always |
The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these. GetMyeBayBuying: If the seller has set the ShipToLocation to Worldwide for an item, but has not specified any international shipping service options, NotSpecified is returned as the ShippingType value.
Applicable values: See ShippingType. Code so that your app gracefully handles any future changes to this list. |
SaleRecord.TotalAmount | AmountType (double) | Always | Total cost in the order. |
SaleRecord.TotalAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Total cost in the order. For a list of possible enumeration values, see CurrencyCodeType. |
SaleRecord.TotalQuantity | int | Always | Total item quantity. |
SaleRecord.UnpaidItemStatus | UnpaidItemStatusTypeCodeType | Always |
The status of an unpaid item regarding final value, state of communications between buyer and seller, and the filing of an Unpaid Item.
Applicable values: See UnpaidItemStatus. Code so that your app gracefully handles any future changes to this list. |
Standard Output Fields |
Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.
Applicable values: (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. |
Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
CorrelationID | string | Conditionally |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request.
See Error Handling. |
Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Errors.ErrorCode | token | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. |
Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
Errors.ErrorParameters.Value | string | Conditionally | This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID. |
Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
Errors.SeverityCode | SeverityCodeType | Conditionally |
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
Applicable values: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Compatible Application Check section of the eBay Features Guide for more information. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list. |
Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. |
Input Output Samples Change History |
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
Input Output Detail Controls Change History |
New to making API calls? Please see Making a Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Returns information about the sold listings of a seller.
Description
User magicalbookseller
wants to review all of her sold listings within the last 90 days. She calls GetSellingManagerSoldListings without using any filters or specifying Archived.
Input
The following GetSellingManagerSoldListings request sample specifies no filters, so all sold listings are returned.
XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerSoldListingsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>ABC...123</eBayAuthToken>
</RequesterCredentials>
</GetSellingManagerSoldListingsRequest>
Output
The response includes SaleRecord
containers, each of which has detailed information about each sold listing.
XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerSoldListingsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-05T22:09:22.515Z</Timestamp>
<Ack>Success</Ack>
<Version>1131</Version>
<Build>E1131_CORE_APISELLING_19099826_R1</Build>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>7426530007</TransactionID>
<SaleRecordID>287735</SaleRecordID>
<ItemID>170001996049</ItemID>
<QuantitySold>1</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>FixedPriceItem</ListingType>
<Relisted>false</Relisted>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>Vito De Niro</Name>
<PostalCode>93003</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="CAD">300.0</TotalAmount>
<TotalQuantity>1</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="CAD">300.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>SetPersonalInformation3@ebay.com</BuyerEmail>
<SaleRecordID>287735</SaleRecordID>
<CreationTime>2019-10-20T18:29:10.000Z</CreationTime>
</SaleRecord>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>0</TransactionID>
<SaleRecordID>287734</SaleRecordID>
<ItemID>170001996048</ItemID>
<QuantitySold>1</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>Chinese</ListingType>
<Relisted>false</Relisted>
<StartPrice currencyID="CAD">300.0</StartPrice>
<ReservePrice currencyID="CAD">310.0</ReservePrice>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>Vito De Niro</Name>
<PostalCode>93003</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="CAD">350.0</TotalAmount>
<TotalQuantity>1</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="CAD">350.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>SetPersonalInformation3@ebay.com</BuyerEmail>
<SaleRecordID>287734</SaleRecordID>
<CreationTime>2019-10-20T18:27:56.000Z</CreationTime>
</SaleRecord>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>7426518007</TransactionID>
<SaleRecordID>287733</SaleRecordID>
<ItemID>170001996038</ItemID>
<QuantitySold>1</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>FixedPriceItem</ListingType>
<Relisted>false</Relisted>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>Vito De Niro</Name>
<PostalCode>93003</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="GBP">300.0</TotalAmount>
<TotalQuantity>1</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="GBP">300.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>SetPersonalInformation3@ebay.com</BuyerEmail>
<SaleRecordID>287733</SaleRecordID>
<CreationTime>2019-10-20T18:22:45.000Z</CreationTime>
</SaleRecord>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>0</TransactionID>
<SaleRecordID>287732</SaleRecordID>
<ItemID>170001996032</ItemID>
<QuantitySold>1</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>Chinese</ListingType>
<Relisted>false</Relisted>
<StartPrice currencyID="GBP">300.0</StartPrice>
<ReservePrice currencyID="GBP">310.0</ReservePrice>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>Vito De Niro</Name>
<PostalCode>93003</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="GBP">350.0</TotalAmount>
<TotalQuantity>1</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="GBP">350.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>SetPersonalInformation3@ebay.com</BuyerEmail>
<SaleRecordID>287732</SaleRecordID>
<CreationTime>2019-10-20T18:21:08.000Z</CreationTime>
</SaleRecord>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>7426423007</TransactionID>
<SaleRecordID>287730</SaleRecordID>
<ItemID>170001995924</ItemID>
<QuantitySold>3</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>FixedPriceItem</ListingType>
<Relisted>false</Relisted>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>Vito De Niro</Name>
<PostalCode>93003</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="EUR">900.0</TotalAmount>
<TotalQuantity>3</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="EUR">900.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>SetPersonalInformation3@ebay.com</BuyerEmail>
<SaleRecordID>287730</SaleRecordID>
<CreationTime>2019-10-20T18:16:40.000Z</CreationTime>
</SaleRecord>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>7426424007</TransactionID>
<SaleRecordID>287731</SaleRecordID>
<ItemID>170001995923</ItemID>
<QuantitySold>3</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>StoresFixedPrice</ListingType>
<Relisted>false</Relisted>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>Vito De Niro</Name>
<PostalCode>93003</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="EUR">900.0</TotalAmount>
<TotalQuantity>3</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="EUR">900.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>SetPersonalInformation3@ebay.com</BuyerEmail>
<SaleRecordID>287731</SaleRecordID>
<CreationTime>2019-10-20T18:16:40.000Z</CreationTime>
</SaleRecord>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>7426422007</TransactionID>
<SaleRecordID>287729</SaleRecordID>
<ItemID>170001995924</ItemID>
<QuantitySold>3</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>FixedPriceItem</ListingType>
<Relisted>false</Relisted>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>QaTest stagingUser</Name>
<PostalCode>95125</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="EUR">900.0</TotalAmount>
<TotalQuantity>3</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="EUR">900.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>GenericUser@Domain.com</BuyerEmail>
<SaleRecordID>287729</SaleRecordID>
<CreationTime>2019-10-20T18:16:26.000Z</CreationTime>
</SaleRecord>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>7426420007</TransactionID>
<SaleRecordID>287728</SaleRecordID>
<ItemID>170001995923</ItemID>
<QuantitySold>3</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>StoresFixedPrice</ListingType>
<Relisted>false</Relisted>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>QaTest stagingUser</Name>
<PostalCode>95125</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="EUR">900.0</TotalAmount>
<TotalQuantity>3</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="EUR">900.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>GenericUser@Domain.com</BuyerEmail>
<SaleRecordID>287728</SaleRecordID>
<CreationTime>2019-10-20T18:16:21.000Z</CreationTime>
</SaleRecord>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>7426418007</TransactionID>
<SaleRecordID>287727</SaleRecordID>
<ItemID>170001995924</ItemID>
<QuantitySold>3</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>FixedPriceItem</ListingType>
<Relisted>false</Relisted>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>Vito De Niro</Name>
<PostalCode>93003</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="EUR">900.0</TotalAmount>
<TotalQuantity>3</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="EUR">900.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>SetPersonalInformation3@ebay.com</BuyerEmail>
<SaleRecordID>287727</SaleRecordID>
<CreationTime>2019-10-20T18:16:14.000Z</CreationTime>
</SaleRecord>
<SaleRecord>
<SellingManagerSoldTransaction>
<TransactionID>7426417007</TransactionID>
<SaleRecordID>287726</SaleRecordID>
<ItemID>170001995925</ItemID>
<QuantitySold>1</QuantitySold>
<ItemTitle>SDK item title</ItemTitle>
<ListingType>FixedPriceItem</ListingType>
<Relisted>false</Relisted>
<SecondChanceOfferSent>false</SecondChanceOfferSent>
<SoldOn>eBay</SoldOn>
<ListedOn>eBay</ListedOn>
<CharityListing>false</CharityListing>
</SellingManagerSoldTransaction>
<ShippingAddress>
<Name>Vito De Niro</Name>
<PostalCode>93003</PostalCode>
</ShippingAddress>
<ShippingDetails>
<ShippingType>NotSpecified</ShippingType>
</ShippingDetails>
<TotalAmount currencyID="EUR">300.0</TotalAmount>
<TotalQuantity>1</TotalQuantity>
<OrderStatus>
<CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
<PaidStatus>Unpaid</PaidStatus>
<ShippedStatus>Unshipped</ShippedStatus>
<PaymentMethodUsed>None</PaymentMethodUsed>
<FeedbackSent>false</FeedbackSent>
<TotalEmailsSent>0</TotalEmailsSent>
</OrderStatus>
<SalePrice currencyID="EUR">300.0</SalePrice>
<DaysSinceSale>0</DaysSinceSale>
<BuyerID>GenericUser</BuyerID>
<BuyerEmail>SetPersonalInformation3@ebay.com</BuyerEmail>
<SaleRecordID>287726</SaleRecordID>
<CreationTime>2019-10-20T18:16:13.000Z</CreationTime>
</SaleRecord>
<PaginationResult>
<TotalNumberOfPages>596</TotalNumberOfPages>
<TotalNumberOfEntries>5959</TotalNumberOfEntries>
</PaginationResult>
</GetSellingManagerSoldListingsResponse>
Input Output Detail Controls Samples |
Change Date | Description |
---|---|
1189 2021-01-15 |
|
1027 2017-08-04 |
|
0955 2016-02-12 |
|
0945 2015-10-15 |
|
0899 2014-11-04 |
|
0771 2012-04-25 |
|
0753 2011-12-21 |
|
0735 2011-08-17 |
|
0731 2011-07-20 |
|
0705 2011-01-19 |
|
0691 2010-10-14 |
|
0663 2010-03-31 |
|
0603 2009-02-04 |
|
0589 2008-10-29 |
|
Copyright © 2005–2021 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.