Skip to main content

GET/inventory_task/{task_id}

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

Input

Resource URI (production)

GET https://api.ebay.com/sell/feed/v1/inventory_task/{task_id}

URI parameters

ParameterTypeDescription
task_idstringThe ID of the task. This ID was generated when the task was created by the createInventoryTask method

Occurrence: Required

HTTP request headers

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

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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):

https://api.ebay.com/oauth/api_scope/sell.inventory

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
taskIdstring

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

Occurrence: Always

statusFeedStatusEnum

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

feedTypestring

The feed type associated with the inventory task.

Occurrence: Always

creationDatestring

The date the task was created.

Occurrence: Always

completionDatestring

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

schemaVersionstring

The schema version number associated with the task.

Occurrence: Always

detailHrefstring

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

Occurrence: Always

uploadSummaryUploadSummary

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

Occurrence: Conditional

uploadSummary.failureCountinteger

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

uploadSummary.successCountinteger

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

Occurrence: Conditional

filterCriteriaInventoryFilterCriteria

This container is used to set the filter criteria for the ActiveInventoryReport. A seller can set date range filters and/or can retrieve listings in a specific state, date, or format.

Occurrence: Conditional

filterCriteria.creationDateRangeDateRange

The creation date range of the listings you want returned. Set the date range so it contains less than 10 days (maximum). If you do not specify a creationDateRange, results from the last 10 days will be returned in ActiveInventoryReport by default.

Occurrence: Conditional

filterCriteria.creationDateRange.fromstring

The beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required.

Format: UTC yyyy-MM-ddThh:mm:ss.SSSZ

For example: Tasks within a range
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

Tasks created on March 31, 2021
2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z

Occurrence: Conditional

filterCriteria.creationDateRange.tostring

The end date for the date range, which is inclusive. If the parent type is included, both the from and/or the to fields become conditionally required.

For example:

Tasks within a range
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

Tasks created on March 31, 2021
2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z

Occurrence: Conditional

filterCriteria.modifiedDateRangeDateRange

The modified date range of the listings you want returned.

Occurrence: Conditional

filterCriteria.modifiedDateRange.fromstring

The beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required.

Format: UTC yyyy-MM-ddThh:mm:ss.SSSZ

For example: Tasks within a range
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

Tasks created on March 31, 2021
2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z

Occurrence: Conditional

filterCriteria.modifiedDateRange.tostring

The end date for the date range, which is inclusive. If the parent type is included, both the from and/or the to fields become conditionally required.

For example:

Tasks within a range
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

Tasks created on March 31, 2021
2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z

Occurrence: Conditional

filterCriteria.listingFormatListingFormatEnum

The type of buying option for the order. Supports LMS_ACTIVE_INVENTORY_REPORT.

Occurrence: Conditional

filterCriteria.listingStatusListingStatusEnum

The status of the listing (whether the listing was unsold or is active). The UNSOLD value does not apply to LMS_ACTIVE_INVENTORY_REPORT feed types.

Occurrence: Conditional

inventoryFileTemplateInventoryFileTemplateEnum

The inventory file template used to return specific types of inventory tasks, if set in the createInventoryTask method. This field does not apply to LMS_ACTIVE_INVENTORY_REPORT feed types.

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.

StatusMeaning
200Success
403Forbidden
404Not Found
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
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.

Warnings

This call has no warnings.

Samples

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.

Input

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

GEThttps://api.ebay.com/sell/feed/v1/inventory_task/task-1*-1*****4

Output

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