Skip to main content

GET/store/tasks/{task_id}

This method retrieves the current status of a recent store operation. The unique identifier of the task is passed in as a path parameter.

Input

Resource URI

GET https://api.ebay.com/sell/stores/v1/store/tasks/{task_id}

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

URI parameters

ParameterTypeDescription
task_idstringThe unique identifier of an eBay Store async task. A taskId value is returned in the response of other successful calls. (e.g.addStoreCategory, moveStoreCategory, deleteStoreCategory).

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

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

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
taskStoreTaskType

This container provides detailed information about the status of the store task.

Occurrence: Conditional

task.idstring

The unique identifier of an eBay Store task.

Occurrence: Always

task.messagestring

This field provides a textual description on the status of the task, and could help user troubleshoot any issues if there is an issue with eBay creating the task.

Occurrence: Always

task.statusStoreTaskStatusEnum

The enumeration value here indicates the processing status of the task. See the StoreTaskStatusEnum type for more information on supported status values.

Occurrence: Always

task.typeStoreTaskTypeEnum

The enumeration value indicates the task type.

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.

StatusMeaning
200OK
400Bad Request
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
225000API_STORESAPPLICATIONInternal server error encountered. If this problem persists, contact the eBay Developers Program for support.
225001API_STORESREQUESTInput data for {param} is invalid or missing. Please check API documentation.
225002API_STORESREQUESTThe user must have an active store subscription.
226100API_STORESREQUESTThe provided task_id could not be matched to a store category request for the store.

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: Get the processing status of a specific async task.

The seller can retrieve information about the processing status of the store async task.

Input

This call does not use request payload.

GEThttps://api.ebay.com/sell/stores/v1/store/tasks/1*3

Output

If the call is successful, eBay returns an HTTP status code of 200 OK and processing status of the store async task.

Got thoughts? Click the feedback button – your insights help us improve!