Manage products (asynchronous API)

PreviousGet authorized countries NextRetrieve a product (synchronous API)

Last updated 10 months ago

Update an individual or base product

Update an existing individual product, or base product asynchronously. The product identifier should be an individual or base product.

post

/v1/products/{productId}

Authorizations

Path parameters

productIdstringrequired

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

Header parameters

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Body

deploymentRequiredChangesobject

You must deploy the product to publish these changes.

localizationsobject[]

The locales supported by the product.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/products/{productId}' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"deploymentRequiredChanges":{"transferProduct":"2234567800","upgradeProducts":["3234567800"],"downgradeProducts":["4234567800"],"fulfillmentTypes":["Download"],"otherFulfillmentIntegration":{"fulfillerIds":["digitalRiver"]}},"localizations":[{"locale":"en_US","groups":[{"attributes":{}}]}]}'

202

401

403

404

409

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

Successful response.

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.

post

/v1/products/{productId}/retire

Authorizations

Path parameters

productIdstringrequired

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

Header parameters

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/products/{productId}/retire' \
  --header 'Authorization: Basic username:password'

202

401

403

404

409

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

Successful response.

Delete a locale from the product

Delete a locale from an existing product asynchronously. The available locales for a product variation are based on the base product. 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.

delete

/v1/products/{productId}/locales/{locale}

Authorizations

Path parameters

productIdstringrequired

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

localestringrequired

The locale for the product.

Header parameters

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/v1/products/{productId}/locales/{locale}' \
  --header 'Authorization: Basic username:password'

202

401

403

404

409

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

Successful response.

Deploy a product

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

post

/v1/products/{productId}/deploy

Authorizations

Path parameters

productIdstringrequired

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

Header parameters

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/products/{productId}/deploy' \
  --header 'Authorization: Basic username:password'

202

401

403

404

409

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

Successful response.

Create a new individual or base product with variations

Create a new product asynchronously. You can create either an individual product or base product with variations.

post

/v1/products

Authorizations

Body

deploymentRequiredChangesobject

You must deploy the product to publish these changes.

liveChangesobject

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.

localizationsobject[]

The locales supported by the product.

variationsobject[]

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/products' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"deploymentRequiredChanges":{"transferProduct":"2234567800","upgradeProducts":["3234567800"],"downgradeProducts":["4234567800"],"fulfillmentTypes":["Download"],"otherFulfillmentIntegration":{"fulfillerIds":["digitalRiver"]}},"liveChanges":{"externalReferenceId":"sku-1234-5678-xyz","catalogs":[{"catalogId":"123456000","categories":[{"categoryId":"19000000"}],"prices":[{"type":"listPrice","prices":[{"currency":"USD","locale":"en_US","configuredPrice":15.99}]}]}]},"localizations":[{"locale":"en_US","groups":[{"attributes":{}}]}],"variations":[{"deploymentRequiredChanges":{"transferProduct":"2234567800","upgradeProducts":["3234567800"],"downgradeProducts":["4234567800"],"fulfillmentTypes":["Download"],"otherFulfillmentIntegration":{"fulfillerIds":["digitalRiver"]}},"liveChanges":{"externalReferenceId":"sku-1234-5678-xyz","catalogs":[{"catalogId":"123456000","categories":[{"categoryId":"19000000"}],"prices":[{"type":"listPrice","prices":[{"currency":"USD","locale":"en_US","configuredPrice":15.99}]}]}]},"varyingAttributes":[{"attributeName":"fulfillmentType","attributeValue":"Download"}],"localizations":[{"locale":"en_US","groups":[{"attributes":{}}]}]}]}'

202

401

403

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

Successful response.

Update a product variation

Update an existing product variation asynchronously.

post

/v1/products/{baseProductId}/variations/{variationId}

Authorizations

Path parameters

baseProductIdstringrequired

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

Example: product

variationIdstringrequired

The product variation identifier.

Header parameters

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Body

deploymentRequiredChangesobject

You must deploy the product to publish these changes.

localizationsobject[]

The locales supported by the product.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"deploymentRequiredChanges":{"transferProduct":"2234567800","upgradeProducts":["3234567800"],"downgradeProducts":["4234567800"],"fulfillmentTypes":["Download"],"otherFulfillmentIntegration":{"fulfillerIds":["digitalRiver"]}},"localizations":[{"locale":"en_US","groups":[{"attributes":{}}]}]}'

202

400

401

403

404

409

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

Successful response.

Delete a product variation

Delete an existing product variation asynchronously. The changes go live immediately. You do not need to deploy these changes. If the request cannot find the product variation the response returns 200 OK.

delete

/v1/products/{baseProductId}/variations/{variationId}

Authorizations

Path parameters

baseProductIdstringrequired

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

Example: product

variationIdstringrequired

The product variation identifier.

Header parameters

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}' \
  --header 'Authorization: Basic username:password'

202

400

401

403

409

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

Successful response.

Update the live changes of an individual or base product

Update the live changes to an existing individual product or base product asynchronously. The changes will go live immediately. You do not need to deploy these changes. Live changes for individual or base product includes catalog, category, price.

post

/v1/products/{productId}/live-changes

Authorizations

Path parameters

productIdstringrequired

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

Header parameters

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Body

externalReferenceIdstring

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

Example: sku-1234-5678-xyz

catalogsobject[]

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/products/{productId}/live-changes' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"externalReferenceId":"sku-1234-5678-xyz","catalogs":[{"catalogId":"123456000","categories":[{"categoryId":"19000000"}],"prices":[{"type":"listPrice","prices":[{"currency":"USD","locale":"en_US","configuredPrice":15.99}]}]}]}'

202

401

403

404

409

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

Successful response.

Update the live changes (like price) of a product variation

Update the live changes to an existing product variation asynchronously. The changes will go live immediately. You do not need to deploy these changes. Live changes for product variation include the price.

post

/v1/products/{baseProductId}/variations/{variationId}/live-changes

Authorizations

Path parameters

baseProductIdstringrequired

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

Example: product

variationIdstringrequired

The product variation identifier.

Header parameters

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Body

externalReferenceIdstring

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

Example: sku-1234-5678-xyz

catalogsobject[]

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}/live-changes' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"externalReferenceId":"sku-1234-5678-xyz","catalogs":[{"catalogId":"123456000","prices":[{"type":"listPrice","prices":[{"currency":"USD","locale":"en_US","configuredPrice":15.99}]}]}]}'

202

400

401

403

404

409

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

Successful response.

Create a new product variation for an existing base product

Create a new product variation for existing base product asynchronously.

post

/v1/products/{baseProductId}/variations

Authorizations

Path parameters

baseProductIdstringrequired

The base product identifier or external reference identifier.

Header parameters

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Body

deploymentRequiredChangesobject

You must deploy the product to publish these changes.

liveChangesobject

varyingAttributesobject[]

localizationsobject[]

The locales supported by the product.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/products/{baseProductId}/variations' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"deploymentRequiredChanges":{"transferProduct":"2234567800","upgradeProducts":["3234567800"],"downgradeProducts":["4234567800"],"fulfillmentTypes":["Download"],"otherFulfillmentIntegration":{"fulfillerIds":["digitalRiver"]}},"liveChanges":{"externalReferenceId":"sku-1234-5678-xyz","catalogs":[{"catalogId":"123456000","categories":[{"categoryId":"19000000"}],"prices":[{"type":"listPrice","prices":[{"currency":"USD","locale":"en_US","configuredPrice":15.99}]}]}]},"varyingAttributes":[{"attributeName":"fulfillmentType","attributeValue":"Download"}],"localizations":[{"locale":"en_US","groups":[{"attributes":{}}]}]}'

202

401

403

404

409

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

Successful response.