eBay Merchant Data API
|
A report that contains price and quantity information for all of the active listings for a specific seller. A seller can use this information to maintain their inventory on eBay.
The eBay servers read the token information passed in by the seller's application to determine which seller's data to retrieve.
Note: ActiveInventoryReport cannot be issued on its own like an ordinary API call, using an endpoint. This Large Merchant Services call must be invoked as a parameter in a Bulk Data Exchange API call, which will produce a report that can be downloaded using a File Transfer API call. This call has no request type.
See also the reference documentation for these calls (in the Trading API API Reference):
| Samples Change History 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"?>
<ActiveInventoryReportResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Call-specific Output Fields -->
<SKUDetails> SKUDetailsType
<BidCount> int </BidCount>
<ItemID> ItemIDType (string) </ItemID>
<Price> AmountType (double) </Price>
<Quantity> int </Quantity>
<ReserveMet> boolean </ReserveMet>
<SKU> SKUType (string) </SKU>
<Variations> MerchantDataVariationsType
<Variation> MerchantDataVariationType
<Price> AmountType (double) </Price>
<Quantity> int </Quantity>
<SKU> SKUType (string) </SKU>
<VariationSpecifics> NameValueListArrayType
<NameValueList> NameValueListType
<Name> string </Name>
<Value> string </Value>
<!-- ... more Value values allowed here ... -->
</NameValueList>
<!-- ... more NameValueList nodes allowed here ... -->
</VariationSpecifics>
</Variation>
<!-- ... more Variation nodes allowed here ... -->
</Variations>
</SKUDetails>
<!-- ... more SKUDetails 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>
</ActiveInventoryReportResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Call-specific Output Fields [Jump to standard fields] |
| SKUDetails | SKUDetailsType | Always,
repeatable: [1..*] |
Describes or includes keywords associated with the SKU. |
| SKUDetails.BidCount | int | Conditionally |
Number of bids placed so far for the item. Returned only for auction-style listings if auctionItemDetails.includeBidCount has a value of true in the activeInventoryReportFilter of a Bulk Data Exchange Service startDownloadJob request. See activeInventoryReportFilter |
| SKUDetails.ItemID | ItemIDType (string) | Always |
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. |
| SKUDetails.Price | AmountType (double) | Conditionally |
The price that the seller assigns to the item. If this value changes when the item is revised, the new value becomes the price. For a multi-variation listing, price is only returned at the variation level. You can revise this value using ReviseFixedPriceItem or ReviseInventoryStatus in the Trading API. |
| SKUDetails.Quantity | int | Always |
The total number of items available for sale in the listing. For a multi-variation listing, the item quantity for each variation is returned at the variation level. You can revise this value using ReviseFixedPriceItem or ReviseInventoryStatus in the Trading API. |
| SKUDetails.ReserveMet | boolean | Conditionally |
Indicates whether the Reserve Price has been met for the listing. Returned only for auction-style listings if auctionItemDetails.includeReservePrice has a value of true in the activeInventoryReportFilter of a Bulk Data Exchange Service startDownloadJob request. See activeInventoryReportFilter |
| SKUDetails.SKU | SKUType (string) | Conditionally |
Stock Keeping Unit that serves as a unique identifier for an item. Many merchants assign a SKU number to an item of a specific type, size, and color. This way, they can keep track of how many products of each type, size, and color are selling, and they can re-stock their shelves according to customer demand. You can include a SKU when you list any item, and then use the SKU instead of (or in addition to) using the ItemID to track your inventory on eBay. For fixed-price items, if you set Item.InventoryTrackingmethod to SKU, you can use the SKU instead of ItemID as a unique ID when you revise the listing. Only returned when the listing included a SKU. Max length: 70. |
| SKUDetails.Variations | MerchantDataVariationsType | Conditionally | Variations are multiple similar (but not identical) items in one fixed-price listing. For example, a clothing listing can contain items of the same brand that vary by color and size. Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. |
|
SKUDetails.Variations .Variation |
MerchantDataVariationType | 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. Always returned when variations are present. |
|
SKUDetails.Variations .Variation.Price |
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. |
|
SKUDetails.Variations .Variation.Quantity |
int | Always |
For ActiveInventoryReport: The number of items available for sale that are associated with this variation. For SoldReport: The total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract the variation's QuantitySold from this value. |
|
SKUDetails.Variations .Variation.SKU |
SKUType (string) | Conditionally |
Stock Keeping Unit that serves as the seller's unique identifier for items within the same variation. You can use the variation's SKU instead of the variation specifics to revise a variation and to keep track of your eBay inventory. Many merchants assign a SKU to an item of a specific type, size, and color. This way, they can keep track of how many products of each type, size, and color are selling, and they can re-stock their shelves or update the variation quantity on eBay according to customer demand. Only returned if the seller specified a SKU for the variation. |
|
SKUDetails.Variations .Variation.VariationSpecifics |
NameValueListArrayType | Conditionally |
A list of name/value pairs that uniquely identify the variation within the listing. All variations specify the same set of names, and each variation provides a unique combination of values for those names. For example, if the items vary by color and size, then every variation specifies Color and Size as names, and no two variations specify the same combination of color and size values. If a variation has no SKU, use the variation specifics as a unique ID to revise the variation and to keep track of your eBay inventory. |
|
SKUDetails.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. |
|
SKUDetails.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. |
|
SKUDetails.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. |
| 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 Ack.
Applicable values: • CustomCode Reserved for internal or future use. • Failure Request processing failed • Success Request processing succeeded • Warning Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.) |
| Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
| CorrelationID | string | Conditionally |
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: • CustomCode Reserved for internal or future use. • RequestError An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. |
| Errors.ErrorCode | token | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. |
| Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
| Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | The index of the parameter in the list of parameter types returned within the error type. |
| Errors.ErrorParameters.Value | string | Conditionally | The value of the variable (e.g., the attribute set ID) |
| Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
| Errors.SeverityCode | SeverityCodeType | Conditionally |
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
Applicable values: • CustomCode Reserved for internal or future use • Error Application-level error • Warning Warning or informational error |
| Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
| HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
| Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories 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 "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response. |
| Output Change History User Notes |
New to making API calls? Please see Making an API Call.
Note: Some data in these samples might no longer be active. If necessary, you can substitute current data in your requests.
Lists the active inventory for a specific seller ID (ID associated with the auth token). This sample represents a data file that you will download using the Bulk Data Exchange Service and File Transfer Service.
Description
User megaonlinemerchant wants to see a list of her active inventory on the eBay site. She sends a Bulk Data Exchange startDownloadJob request with the ActiveInventoryReport parameter, uses a Bulk Data Exchange getJobStatus request to see if her report is ready to download, and then sends a File Transfer Service downloadJob request to retrieve the report data.
Input
Since a Large Merchant Services report returns a pre-determined set of elements, there is no input request for a report. Instead, the report type is specified as a parameter of a Bulk Data Exchange startDownloadJob call.
XML format (HTTP POST). Also available is the .txt version of this XML. Do not send a request file for reports. See description above.
Output
The response returns the SKU Details, which include: ItemID and/or SKU, Price,Quantity, and SiteID.
If you need to change the price and quantity data that you see in this report, you can use the ReviseInventoryStatus call in eBay's Trading API, which lets you change the price and quantity of currently active fixed-price listings.
XML format. Also available is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <BulkDataExchangeResponsesxmlns="urn:ebay:apis:eBLBaseComponents"> <ActiveInventoryReport> <SKUDetails> <SKU></SKU> <Price currencyID="USD">50.00</Price> <Quantity>6</Quantity> <ItemID>110035808064</ItemID> </SKUDetails> <SKUDetails> <SKU></SKU> <Price currencyID="USD">50.00</Price> <Quantity>6</Quantity> <ItemID>110035808166</ItemID> </SKUDetails> <SKUDetails> <SKU></SKU> <Price currencyID="USD">50.00</Price> <Quantity>5</Quantity> <ItemID>110035808177</ItemID> </SKUDetails> <SKUDetails> <SKU></SKU> <Price currencyID="USD">50.00</Price> <Quantity>1</Quantity> <ItemID>110035808425</ItemID> </SKUDetails> <SKUDetails> <SKU></SKU> <Price currencyID="USD">50.00</Price> <Quantity>4</Quantity> <ItemID>110035808513</ItemID> </SKUDetails> <SKUDetails> <SKU></SKU> <Price currencyID="USD">65.00</Price> <Quantity>5</Quantity> <ItemID>110035817827</ItemID> </SKUDetails> <SKUDetails> <SKU></SKU> <Price currencyID="USD">5.00</Price> <Quantity>11</Quantity> <ItemID>110035817828</ItemID> </SKUDetails> <SKUDetails> <SKU></SKU> <Price currencyID="USD">50.00</Price> <Quantity>6</Quantity> <ItemID>110035817937</ItemID> </SKUDetails> <SKUDetails> <SKU></SKU> <Price currencyID="USD">55.00</Price> <Quantity>4</Quantity> <ItemID>110035817938</ItemID> </SKUDetails> <!-- Items just added with AddFixedPriceItem data file upload (using AddFixedPriceItem sample) have a SoldReport with data similar to this --> <SKUDetails> <SKU></SKU> <Price currencyID="USD">40.00</Price> <Quantity>6</Quantity> <ItemID>110036776036</ItemID> </SKUDetails> <SKUDetails> <SKU></SKU> <Price currencyID="USD">55.00</Price> <Quantity>4</Quantity> <ItemID>110036776039</ItemID> </SKUDetails> </ActiveInventoryReport> </BulkDataExchangeResponses>
| Output Samples User Notes |
| Version | Description |
|---|---|
| 657 2010-2-17 |
|
| 589 2008-11-29 |
|
| Output Samples Change History User Notes |
Copyright © 2008–2013 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.