LogoLogo
System status
Admin APIs reference
Admin APIs reference
  • Admin APIs reference
  • Order management
    • Refunds
    • Retrieve an order (synchronous API)
    • Retrieve an invoice (synchronous API)
    • Manage orders (synchronous API)
  • Customer management
    • Retrieve a customer (synchronous API)
    • Manage a customer (synchronous API)
  • Subscription mangement
    • Manage a subscription
    • Renew a subscription
    • Apply an immediate midterm change
    • Manage subscription payments
    • Modify the subscription's external reference ID
    • Manage the subscription's address
    • Get all orders
    • Retrieve subscriptions with pending actions
    • Retrieve subscriptions
    • Manage a perpetual price
    • Update a subscription's email address
  • Site management
    • Get authorized countries
  • Product management
    • Manage products (asynchronous API)
    • Retrieve a product (synchronous API)
    • Retrieve the product task status (synchronous API)
  • Offer Management
    • Manage offers (synchronous API)
    • Retrieve an offer (synchronous API)
  • Webhook management
    • Manage webhook events
  • Payment source
    • Source management
  • File management
    • Retrieve a file
Powered by GitBook
On this page
  1. Product management

Retrieve the product task status (synchronous API)

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

Last updated 1 year ago

Get the latest information for a product task

get

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.

Authorizations
Path parameters
taskIdstringRequired

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

Responses
200
Successful response.
application/json
401
* The API key is invalid if you are using HTTP Basic Authentication.
application/json
403
* The token is invalid if you are using Bearer Token Authentication.
application/json
404
* The task was not found.
application/json
get
GET /v1/products/tasks/{taskId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Accept: */*
{
  "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"
    }
  ]
}

Retrieve the tasks for Product Admin API requests

get

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

Authorizations
Query parameters
productIdstringOptional

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

Default: null
taskStatusstringOptional

comma separated status

Default: PUBLISHED,PROCESSING,COMPLETED,FAILEDExample: PUBLISHED
beginReceivedTimestringOptional

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

Default: The current system date time minus 30 days.Example: 2022-05-01T23:00:21.123Z
endReceivedTimestringOptional

The date and time when the task ended.

Default: The current system date time.Example: 2022-05-30T23:00:21.123Z
limitinteger · min: 1 · max: 50Optional

The maximum number of tasks returned with this request.

Default: 50Example: 50
startingAfterstringOptional

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.

Default: null
endingBeforestringOptional

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.

Default: null
Responses
200
Successful response.
application/json
400
* The query parameter is invalid
application/json
401
* The API key is invalid if you are using HTTP Basic Authentication.
application/json
403
* The token is invalid if you are using Bearer Token Authentication.
application/json
get
GET /v1/products/tasks/ HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Accept: */*
{
  "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": 1,
  "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"
  }
}
  • GETGet the latest information for a product task
  • GETRetrieve the tasks for Product Admin API requests