latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Get Product Task Status (Synchronous API)

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/

Query parameters

productIdstring

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

taskStatusstring

comma separated status

Example:PUBLISHED

The status of the task.

beginReceivedTimestring

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

endReceivedTimestring

The date and time when the task ended.

limitinteger

The maximum number of tasks returned with this request.

startingAfterstring

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

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.

Response

Successful response.

totalSizeinteger

Example response

{
  "tasks": [
    {
      "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",
      "uri": "https://api.digitalriver.com/v1/products/tasks/d8a81162-aaaa-bbbb-cccc-ea513d1afa82"
    }
  ],
  "previousPage": {
    "endingBefore": "zzzzzzzz-aaaa-bbbb-cccc-ea513d1afa82"
  },
  "nextPage": {
    "startingAfter": "aaaaaaaa-aaaa-bbbb-cccc-ea513d1afa82"
  },
  "searchCriteria": {
    "beginReceivedTime": "2022-05-01T23:00:21.123Z",
    "endReceivedTime": "2022-05-31T23:00:21.123Z",
    "productId": "1234567800"
  },
  "pagination": {
    "limit": 50,
    "startingAfter": "aaaaaaaa-aaaa-bbbb-cccc-ea513d1afa82",
    "endingBefore": "zzzzzzzz-aaaa-bbbb-cccc-ea513d1afa82"
  }
}