Manage products (asynchronous API)

Update an individual or base product

This method updates a specific product asynchronously by including its ID in the {productId} URI path parameter. The identifier should be for an individual or base product.

POSThttps://api.digitalriver.com/v1/products/{productId}

Authorization

SystemApiKey

Path parameters

productId*string

The product identifier of either an individual product or a base product.

Header parameters

Body

application/json

Provide information about necessary data attributes that you can apply to the product.

deploymentRequiredChangesProductDeploymentChanges (object)

You must deploy the product to publish these changes.

localizationsarray of UpdateLocalization (object)

The locales supported by the product.

Response

202401403404409

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/products/{productId}', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202401403404409

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Retire a product

Retire an existing product asynchronously. The product variations will be retired along with the base product. Therefore, the provided product identifier must be for an individual or base product.

POSThttps://api.digitalriver.com/v1/products/{productId}/retire

Authorization

SystemApiKey

Path parameters

productId*string

The product identifier of either an individual product or a base product.

Header parameters

Response

202401403404409

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

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

Response

202401403404409

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Delete a locale from the product

This method deletes a locale from an existing product asynchronously by including its product ID and locale in the {productId} and {locale} URI path parameters. The base product determines the locales available for a product variation. Therefore, the provided product identifier must be the identifier for an individual or base product. The change will go live immediately. You do not need to deploy the change.

DELETEhttps://api.digitalriver.com/v1/products/{productId}/locales/{locale}

Authorization

SystemApiKey

Path parameters

productId*string

The product identifier of either an individual product or a base product.

locale*string

The locale for the product.

Header parameters

Response

202401403404409

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

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

Response

202401403404409

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Deploy a product

This method deploys an existing product asynchronously by including its ID in the {productID} URI path parameter. If the specified product is a base product, this method also deploys the product variations along with the base product. Therefore, the product ID must be for an individual or base product.

POSThttps://api.digitalriver.com/v1/products/{productId}/deploy

Authorization

SystemApiKey

Path parameters

productId*string

The product identifier of either an individual product or a base product.

Header parameters

Response

202401403404409

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

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

Response

202401403404409

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Create a new individual or base product with variations

This method creates a new product asynchronously. You can create either an individual product or a base product with variations.

POSThttps://api.digitalriver.com/v1/products

Authorization

SystemApiKey

Body

application/json

You can apply the data attributes to the product in the request body.

deploymentRequiredChangesProductDeploymentChanges (object)

You must deploy the product to publish these changes.

liveChangesUpdateProductLiveChange (object)

The changed attributes under this object will go live immediately. You do not need to deploy these changes. You can use these attributes to insert live changes when creating a product. After creating the product, the fields are read-only. You can apply live changes by using the POST /v1/products/{productId}/live-changes API.

localizationsarray of UpdateLocalization (object)

The locales supported by the product.

variationsarray of object

Different variations of the product. Only required for a base product.

Response

202401403

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/products', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202401403

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Update a product variation

This method updates a specific product variation by including its base product ID and variation ID in the {baseProductId} and {variationId} URI path parameters.

POSThttps://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}

Authorization

SystemApiKey

Path parameters

baseProductId*string

The base product identifier must be for the base product for the product variation, or simply use 'product' instead.

Example: "product"

variationId*string

The product variation identifier.

Header parameters

Body

application/json

You can apply the data attributes to the product variation in the request body.

deploymentRequiredChangesProductDeploymentChanges (object)

You must deploy the product to publish these changes.

localizationsarray of UpdateLocalization (object)

The locales supported by the product.

Response

202400401403404409

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202400401403404409

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Delete a product variation

This method deletes an existing product variation asynchronously by including its base product ID and variation ID in the {baseProductId} and {variationId} URI path parameters. The changes go live immediately. You do not need to deploy these changes. If the request cannot find the product variation, the response will return 200 OK.

DELETEhttps://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}

Authorization

SystemApiKey

Path parameters

baseProductId*string

The base product identifier must be for the base product for the product variation, or simply use 'product' instead.

Example: "product"

variationId*string

The product variation identifier.

Header parameters

Response

202400401403409

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

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

Response

202400401403409

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Apply live changes to an individual or base product

This method asynchronously applies live changes to an individual or base product by including its product ID in the {productId} URI path parameter. The changes will go live immediately. You do not need to deploy these changes. Live changes for individual or base products include catalog, category, and price.

POSThttps://api.digitalriver.com/v1/products/{productId}/live-changes

Authorization

SystemApiKey

Path parameters

productId*string

The product identifier of either an individual product or a base product.

Header parameters

Body

application/json

You can apply the data attributes to the product in the request body.

externalReferenceIdstring

The external reference identifier. A unique identifier for the product from the Digital River client.

Example: "sku-1234-5678-xyz"

catalogsarray of object

The collection of products for sale on your site. A catalog contains categories to organize your products.

Response

202401403404409

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/products/{productId}/live-changes', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202401403404409

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Apply live changes (like price) to a product variation

This method asynchronously applies live changes to product variation by including its variation ID in the {variationId} URI path parameter. The changes will go live immediately. You do not need to deploy these changes. Live changes for a product variation include the price.

POSThttps://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}/live-changes

Authorization

SystemApiKey

Path parameters

baseProductId*string

The base product identifier must be for the base product for the product variation, or simply use 'product' instead.

Example: "product"

variationId*string

The product variation identifier.

Header parameters

Body

application/json

You can apply the data attributes to the product variation in the request body.

externalReferenceIdstring

The external reference identifier. A unique ID for the product from the Digital River client.

Example: "sku-1234-5678-xyz"

catalogsarray of object

The collection of products for sale on your site. A catalog contains categories to organize your products.

Response

202400401403404409

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}/live-changes', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202400401403404409

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Create a new product variation for an existing base product

This method creates a new product variation for an existing base product asynchronously.

POSThttps://api.digitalriver.com/v1/products/{baseProductId}/variations

Authorization

SystemApiKey

Path parameters

baseProductId*string

Provide the base product identifier or external reference identifier.

Header parameters

Body

application/json

You can apply the data attributes to the product variation in the request body.

varyingAttributesarray of VaryingAttribute (object)

deploymentRequiredChangesProductDeploymentChanges (object)

You must deploy the product to publish these changes.

liveChangesUpdateProductLiveChange (object)

The changed attributes under this object will go live immediately. You do not need to deploy these changes. You can use these attributes to insert live changes when creating a product. After creating the product, the fields are read-only. You can apply live changes by using the POST /v1/products/{productId}/live-changes API.

localizationsarray of UpdateLocalization (object)

The locales supported by the product.

Response

202401403404409

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"

taskStatusenum

The status of the task.

Example: "PUBLISHED"

PUBLISHEDPROCESSINGCOMPLETEDFAILED

requestTypeenum

The request type for this task.

Example: "CREATE_PRODUCT"

CREATE_PRODUCTCREATE_VARIATIONUPDATE_PRODUCTUPDATE_VARIATIONDELETE_VARIATIONDELETE_LOCALEDEPLOY_PRODUCTRETIRE_PRODUCTUPDATE_PRODUCT_LIVE_CHANGEUPDATE_VARIATION_LIVE_CHANGE

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/products/{baseProductId}/variations', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202401403404409

{
  "taskId": "d8a81162-aaaa-bbbb-cccc-ea513d1afa82",
  "receivedTime": "2022-05-01T23:00:21.123Z",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}