Skip to main content


This method searches for multiple tasks of a specific feed type, and includes date filters and pagination.


Resource URI


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

URI parameters

feed_typestringThe feed type associated with the inventory tasks being retrieved. Presently, only one feed type is available:
See Report value feed types for more information.

Occurrence: Required

schedule_idstringNote: Schedule functionality for ActiveInventoryReport is currently unavailable, so this field is not usable.

Occurrence: Optional

look_back_daysintegerThe number of previous days in which to search for tasks. Do not use with the date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used.

Default: 7

Range: 1-90 (inclusive)

Occurrence: Optional

date_rangestringSpecifies the range of task creation dates used to filter the results. The results are filtered to include only tasks with a creation date that is equal to this date or is within specified range.

Note: Maximum date range window size is 90 days.

Valid Format (UTC): yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

For example: Tasks created on March 31, 2021

Occurrence: Optional

limitintegerThe maximum number of tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.

If this parameter is omitted, the default value is used.

Default: 10

Maximum: 500

Occurrence: Optional

offsetintegerThe number of tasks to skip in the result set before returning the first task in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.

Default: 0

Occurrence: Optional

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 path to the call URI that produced the current page of results.

Occurrence: Always


The value of the limit parameter submitted in the request, which is the maximum number of inventory tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method.

Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted. Additionally, if this is the last or only page of the result set, the page may contain fewer tasks than the limit value submitted in the request.

To determine the number of pages in a result set, divide the total value (total number of tasks matching the input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getInventoryTasks calls to view all tasks matching the input criteria.

Occurrence: Always


The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.

Occurrence: Conditional


The number of results skipped in the result set before listing the first returned result. This value can be specified in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list, where the first item in the list has an offset of 0.

Occurrence: Always


The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.

Occurrence: Conditional

tasksarray of InventoryTask

An array of the inventory tasks on this page. The tasks are sorted by creation date.

Note: An empty array is returned if the filter criteria excludes all tasks.

Occurrence: Always


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


The total number of inventory tasks that match the input criteria.

Occurrence: Always

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.

400Bad Request
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.
160004API_FEEDREQUESTYou must submit either a 'feed_type' or 'schedule_id'.
160005API_FEEDREQUESTBoth 'feed_type' and 'schedule_id' were provided. Please remove one of them.
160006API_FEEDREQUESTThe 'feed_type' {feedTypeValue} is invalid.
160007API_FEEDREQUESTThe 'schedule_id' {scheduleID} is invalid.
160008API_FEEDREQUESTBoth 'look_back_days' and 'date_range' were provided. Please remove one of them.
160009API_FEEDREQUESTThe format of the 'date_range' is invalid. The format for a date range is yyyy-MM-ddThh:mm:ss.sssZ..yyyy-MM-ddThh:mm:ss.sssZ.
160010API_FEEDREQUESTThe 'date_range' must be less than or equal to 90 days.
160011API_FEEDREQUESTThe 'look_back_days' value must be greater than zero and less than or equal to 90.
160012API_FEEDREQUESTThe 'limit' value must be greater than zero and less than or equal to 500.
160013API_FEEDREQUESTThe 'offset' value cannot be less than zero.
160029API_FEEDREQUESTThe 'offset' value must be a multiple of the 'limit' value.


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: Get Inventory Tasks

This call retrieves the details and statuses for a group of inventory tasks based on the specified criteria.


The inputs are the feed_type, date_range, limit, and offset URI parameters.



If the call is successful, an array of tasks matching the specified criteria are returned.