Skip to main content


This method retrieves the task details and status of the specified inventory-related task. The input is task_id.


Resource URI


This method is supported in Sandbox environment. To access the endpoint, just replace the root URI with

URI parameters

task_idstringThis path parameter is the unique identifier of the inventory task being retrieved.

Use the getInventoryTasks method to retrieve inventory task IDs.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.


HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription

The ID of the task. This ID is generated when the task was created by the createInventoryTask method.

Occurrence: Always


The status of the task. Users must wait until status is complete before moving on to the next step (such as uploading/downloading a file).

Occurrence: Always


The feed type associated with the inventory task.

Occurrence: Always


The date the task was created.

Occurrence: Always


The timestamp when the task status went into the COMPLETED, COMPLETED_WITH_ERROR, or PARTIALLY_PROCESSED state. This field is only returned if the status is one of the three completed values.

Occurrence: Conditional


The schema version number associated with the task.

Occurrence: Always


The path to the call URI used to retrieve the task. This field points to the getInventoryTask URI.

Occurrence: Always


This container provides summary information on an upload feed (not applicable for download feed types).

Occurrence: Conditional


The number of records, such as the number of listings created or the number of pictures uploaded to a listing, that failed to process during the upload feed. Check the response file and correct any issues mentioned. If the feed fails before processing, no response file is provided. In this case check the REST output response.

Occurrence: Conditional


The number of records that were successfully processed during the upload feed.

Occurrence: Conditional


This container is used to set the filter criteria for the ActiveInventoryReport. A seller can retrieve listings for a specified format.

Occurrence: Conditional


The listing format for the ActiveInventoryReport being created. Supported types are:


Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

160001API_FEEDAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
160002API_FEEDREQUESTThe authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
160003API_FEEDREQUESTTask {taskID} does not exist.


This call has no warnings.


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

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Retrieve an Inventory Task

This call retrieves the details and status of the specified inventory task. When the status is COMPLETED, use the getResultFile method to return the report file. See ActiveInventoryReport for the definitions and a sample of the fields contained in the returned file.


The input is the task_id URI parameter specifying the inventory task.



If the call is successful, the details and status of the inventory task that matches the specified task ID are returned.