ActiveInventoryReport

A report that contains all of the active listings for a specific seller. The eBay servers read the token information passed in by the seller's application to determine which seller's data to retrieve.



Back to top

Output Samples Change History
ActiveInventoryReport Output

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.

<?xml version="1.0" encoding="utf-8"?>
<ActiveInventoryReport xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <SKUDetails> SKUDetailsType 
    <ItemID> ItemIDType (string) </ItemID>
    <Price> AmountType (double) </Price>
    <Quantity> int </Quantity>
    <SKU> SKUType (string) </SKU>
  </SKUDetails>
  <!-- ... more SKUDetails nodes here ... -->
</ActiveInventoryReport>
Return Value Type Occurrence Meaning
Standard Output Fields   [Jump to call-specific fields]
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failure

(out) Request processing failed

•   Success

(out) Request processing succeeded

•   Warning

(out) Request processing completed with warning information being included in the response message


(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]		 A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]		 This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]		 string Conditionally The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   Error

(out) Application-level error

•   Warning

(out) Warning or informational error
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
SKUDetails SKUDetailsType Always,
repeatable: [1..*]		 Describes or includes keywords associated with the SKU.
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. If item is a multi-variation listing, price is only returned at the variation level.
SKUDetails.Quantity int Always The number of items in the listing.
You can revise this value using the ReviseFixedPriceItem or ReviseInventoryStatus calls.
SKUDetails.SKU SKUType (string) Always 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 use SKU numbers to add Fixed Price Items and to keep track of your eBay inventory, instead of (or in addition to) the Item ID.



Back to top

Output Samples Change History
ActiveInventoryReport Samples

New to making API calls? Please see Making an API Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

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>



Back to top

Output Samples Change History
ActiveInventoryReport Change History
Version Description
589
2008-11-29
  • (added) New call.

This document was generated with a customized version of the apireferencedocs tool.

© 2008–2009 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.