Retrieve the product task status (synchronous API)

Get the latest information for a product task

Get the latest product information for an asynchronous task by including its ID in the {taskId} URI path parameter. You can find the taskId in the response when you send a request to create or update a product.

GEThttps://api.digitalriver.com/v1/products/tasks/{taskId}

Authorization

SystemApiKey

Path parameters

taskId*string

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

Response

200401403404

Successful response.

Body

application/json

taskIdstring

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

Example: "d8a81162-aaaa-bbbb-cccc-ea513d1afa82"

receivedTimestring

The date and time when Global Commerce received the task.

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

finishedTimestring

The date and time when the Global Commerce task finished.

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

taskStatusstring

The status of the task.

Example: "PUBLISHED"

requestTypestring

The request type for this task.

Example: "CREATE_PRODUCT"

productsarray of ProductAdminApiTaskProducts (object)

errorsarray of one of

The errors caused the task to fail.

deploymentErrorsarray of ProductAdminApiTaskErrors (object)

A list of one or more deployment errors. The errors did not cause the current task to fail. However, you should correct these errors before deployment. You cannot deploy products with deployment errors until all errors are fixed.

deploymentWarningsarray of ProductAdminApiTaskErrors (object)

A list of one or more deployment warnings. You can still deploy products with warnings. However, we recommend that you fix all warnings before deploying the product because the product may not appear or function as expected.

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/products/tasks/{taskId}', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200401403404

{
  "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"
    }
  ],
  "errors": [
    {
      "errorCode": "text",
      "description": "text"
    }
  ],
  "deploymentErrors": [
    {
      "errorCode": "text",
      "description": "text"
    }
  ],
  "deploymentWarnings": [
    {
      "errorCode": "text",
      "description": "text"
    }
  ]
}

Get the tasks for Product Admin API requests

Retrieve all tasks related to Product Admin API requests using query parameters for filtering.

GEThttps://api.digitalriver.com/v1/products/tasks/

Authorization

SystemApiKey

Query parameters

Response

200400401403

Successful response.

Body

application/json

tasksarray of ProductAdminApiTask (object)

totalSizeinteger

previousPageobject

The key and value of the query parameter used to fetch the previous page if there is a previous page.

nextPageobject

The key and value of the query parameter used to fetch the previous page if there is a previous page.

searchCriteriaobject

criteria used to get the search result. Some criteria have default values even if they were not provided in request.

paginationobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/products/tasks/', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200400401403

{
  "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",
      "products": [
        {
          "productId": "text",
          "externalReferenceId": "text",
          "productType": "text"
        }
      ],
      "uri": "https://api.digitalriver.com/v1/products/tasks/d8a81162-aaaa-bbbb-cccc-ea513d1afa82"
    }
  ],
  "totalSize": 0,
  "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",
    "taskStatus": [
      "PUBLISHED"
    ],
    "productId": "1234567800"
  },
  "pagination": {
    "limit": 50,
    "startingAfter": "aaaaaaaa-aaaa-bbbb-cccc-ea513d1afa82",
    "endingBefore": "zzzzzzzz-aaaa-bbbb-cccc-ea513d1afa82"
  }
}