Manage products (asynchronous API)

PreviousGet authorized countries NextRetrieve a product (synchronous API)

Last updated 12 months ago

Delete a locale from the product

delete

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.

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-pidbooleanOptional

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

objectOptional

application/json

delete

DELETE /v1/products/{productId}/locales/{locale} 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",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Deploy a product

post

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

Authorizations

Path parameters

productIdstringRequired

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

Header parameters

x-erid-as-pidbooleanOptional

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

objectOptional

application/json

post

POST /v1/products/{productId}/deploy 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",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Delete a product variation

delete

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.

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-pidbooleanOptional

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

objectOptional

application/json

delete

DELETE /v1/products/{baseProductId}/variations/{variationId} 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",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Retire a product

post

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.

Authorizations

Path parameters

productIdstringRequired

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

Header parameters

x-erid-as-pidbooleanOptional

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

objectOptional

application/json

post

POST /v1/products/{productId}/retire 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",
  "taskStatus": "PUBLISHED",
  "requestType": "CREATE_PRODUCT"
}

Update an individual or base product

post

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

Authorizations

Path parameters

productIdstringRequired

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

Header parameters

x-erid-as-pidbooleanOptional

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

Body

deploymentRequiredChangesobjectOptional

You must deploy the product to publish these changes.

localizationsobject[]Optional

The locales supported by the product.

Responses

application/json

objectOptional

application/json

post

POST /v1/products/{productId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 341

{
  "deploymentRequiredChanges": {
    "fulfillmentTypes": [
      "Download"
    ],
    "otherFulfillmentIntegration": {
      "fulfillerIds": [
        "digitalRiver"
      ]
    },
    "transferProduct": "2234567800",
    "upgradeProducts": [
      "3234567800"
    ],
    "downgradeProducts": [
      "4234567800"
    ]
  },
  "localizations": [
    {
      "locale": "en_US",
      "isDefault": true,
      "groups": [
        {
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    }
  ]
}

{
  "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

post

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

Authorizations

Body

deploymentRequiredChangesobjectOptional

You must deploy the product to publish these changes.

liveChangesobjectOptional

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[]Optional

The locales supported by the product.

variationsobject[]Optional

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

Responses

application/json

objectOptional

application/json

post

POST /v1/products HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1266

{
  "deploymentRequiredChanges": {
    "fulfillmentTypes": [
      "Download"
    ],
    "otherFulfillmentIntegration": {
      "fulfillerIds": [
        "digitalRiver"
      ]
    },
    "transferProduct": "2234567800",
    "upgradeProducts": [
      "3234567800"
    ],
    "downgradeProducts": [
      "4234567800"
    ]
  },
  "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",
      "isDefault": true,
      "groups": [
        {
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    }
  ],
  "variations": [
    {
      "varyingAttributes": [
        {
          "attributeName": "fulfillmentType",
          "attributeValue": "Download"
        }
      ],
      "deploymentRequiredChanges": {
        "fulfillmentTypes": [
          "Download"
        ],
        "otherFulfillmentIntegration": {
          "fulfillerIds": [
            "digitalRiver"
          ]
        },
        "transferProduct": "2234567800",
        "upgradeProducts": [
          "3234567800"
        ],
        "downgradeProducts": [
          "4234567800"
        ]
      },
      "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",
          "isDefault": true,
          "groups": [
            {
              "attributes": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          ]
        }
      ]
    }
  ]
}

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

Update a product variation

post

Update an existing product variation asynchronously.

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-pidbooleanOptional

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

Body

deploymentRequiredChangesobjectOptional

You must deploy the product to publish these changes.

localizationsobject[]Optional

The locales supported by the product.

Responses

application/json

objectOptional

application/json

post

POST /v1/products/{baseProductId}/variations/{variationId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 341

{
  "deploymentRequiredChanges": {
    "fulfillmentTypes": [
      "Download"
    ],
    "otherFulfillmentIntegration": {
      "fulfillerIds": [
        "digitalRiver"
      ]
    },
    "transferProduct": "2234567800",
    "upgradeProducts": [
      "3234567800"
    ],
    "downgradeProducts": [
      "4234567800"
    ]
  },
  "localizations": [
    {
      "locale": "en_US",
      "isDefault": true,
      "groups": [
        {
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    }
  ]
}

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

Update the live changes of an individual or base product

post

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.

Authorizations

Path parameters

productIdstringRequired

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

Header parameters

x-erid-as-pidbooleanOptional

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

Body

externalReferenceIdstringOptional

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

Example: sku-1234-5678-xyz

catalogsobject[]Optional

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

Responses

application/json

objectOptional

application/json

post

POST /v1/products/{productId}/live-changes HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "externalReferenceId": "sku-1234-5678-xyz",
  "catalogs": [
    {
      "catalogId": "123456000",
      "categories": [
        {
          "categoryId": "19000000"
        }
      ],
      "prices": [
        {
          "type": "listPrice",
          "prices": [
            {
              "currency": "USD",
              "locale": "en_US",
              "configuredPrice": 15.99
            }
          ]
        }
      ]
    }
  ]
}

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

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

post

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.

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-pidbooleanOptional

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

Body

externalReferenceIdstringOptional

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

Example: sku-1234-5678-xyz

catalogsobject[]Optional

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

Responses

application/json

objectOptional

application/json

post

POST /v1/products/{baseProductId}/variations/{variationId}/live-changes HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "externalReferenceId": "sku-1234-5678-xyz",
  "catalogs": [
    {
      "catalogId": "123456000",
      "prices": [
        {
          "type": "listPrice",
          "prices": [
            {
              "currency": "USD",
              "locale": "en_US",
              "configuredPrice": 15.99
            }
          ]
        }
      ]
    }
  ]
}

{
  "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

post

Create a new product variation for existing base product asynchronously.

Authorizations

Path parameters

baseProductIdstringRequired

The base product identifier or external reference identifier.

Header parameters

x-erid-as-pidbooleanOptional

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

Body

varyingAttributesobject[]Optional

deploymentRequiredChangesobjectOptional

You must deploy the product to publish these changes.

liveChangesobjectOptional

localizationsobject[]Optional

The locales supported by the product.

Responses

application/json

objectOptional

application/json

post

POST /v1/products/{baseProductId}/variations HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 668

{
  "varyingAttributes": [
    {
      "attributeName": "fulfillmentType",
      "attributeValue": "Download"
    }
  ],
  "deploymentRequiredChanges": {
    "fulfillmentTypes": [
      "Download"
    ],
    "otherFulfillmentIntegration": {
      "fulfillerIds": [
        "digitalRiver"
      ]
    },
    "transferProduct": "2234567800",
    "upgradeProducts": [
      "3234567800"
    ],
    "downgradeProducts": [
      "4234567800"
    ]
  },
  "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",
      "isDefault": true,
      "groups": [
        {
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    }
  ]
}

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