Retrieve the product task status (synchronous API)

PreviousRetrieve a product (synchronous API)NextManage offers (synchronous API)

Last updated 10 months ago

Get the latest information for a product task

Get the latest product information for an asynchronous task. You can find the taskId in the response when you send a request to create or update product.

get

/v1/products/tasks/{taskId}

Authorizations

Path parameters

taskIdstringrequired

The task identifier received in the response when you create or update a product (synchronous API).

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/v1/products/tasks/{taskId}' \
  --header 'Authorization: Basic username:password'

200

401

403

404

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "finishedTime": "2022-05-01T23:05:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT",
  "products": [
    {
      "productId": "text",
      "externalReferenceId": "text",
      "productType": "text"
    }
  ],
  "deploymentErrors": [
    {
      "errorCode": "text",
      "description": "text"
    }
  ],
  "deploymentWarnings": [
    {
      "errorCode": "text",
      "description": "text"
    }
  ],
  "errors": [
    {
      "errorCode": "text",
      "description": "text"
    }
  ]
}

Successful response.

Retrieve the tasks for Product Admin API requests

Retrieve the tasks for Product Admin API requests. Specify the conditions using the query parameters to filter your query.

get

/v1/products/tasks/

Authorizations

Query parameters

productIdstring · default: null

The product identifier or external reference identifier associated with the related tasks.

taskStatusstring · default: PUBLISHED,PROCESSING,COMPLETED,FAILED

comma separated status

Example: PUBLISHED

beginReceivedTimestring · default: The current system date time minus 30 days.

The date and time when the the task received time began.

Example: 2022-05-01T23:00:21.123Z

endReceivedTimestring · default: The current system date time.

The date and time when the task ended.

Example: 2022-05-30T23:00:21.123Z

limitinteger · min: 1 · max: 50 · default: 50

The maximum number of tasks returned with this request.

Example: 50

startingAfterstring · default: null

When you specify a task identifier, the system will fetch the tasks that started later than the current task. Use either startingAfter or endingBefore. Do not use them togehter.

endingBeforestring · default: null

When you specify a task identifier, system will fetch the tasks that started earlier than current the task. Use either startingAfter or endingBefore. Do not use them togehter.