Retrieve a product (synchronous API)

Get an individual or base product's information

This method retrieves detailed information on the specific individual product or base product by including the ID in the {productId} URI path parameter. If the product is a base product, the response provides the product variation URLs for that base product instead of all the details for each product variation.

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

Authorization

SystemApiKey

Path parameters

productId*string

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

Query parameters

Header parameters

Response

200401403404

Successful response.

Body

application/json

productTypeenum

Indicates the type of product as either an individual or base product. A base product has one or more product variations such as different colors, sizes, or versions. An individual product a single item or many single items sold as a single product (such as a colection or box set.

BASEINDIVIDUAL

companyIdstring

The company identifier.

Example: "digitalriver"

siteIdsarray of string

The site identifier.

idstring

The individual product identifier or base product identifier for the product.

Example: "1234567800"

stateenum

The status of the product.

• Deployed: The current product setup is the same product setup that is available for sale on your store.
• Design: The current product setup (also called in the version) has not yet been deployed to your store.
• Retired: The version of the product cannot be purchased or seen on your store.
• Deployed: Pending Start: This state appears when a future Start Date is set for base, individual or variation product, and also the product is deployed. Meaning there is a version that is available for sale on your store. And there is another newer version will be available for sale on your store when the Start Date arrived.
• Deployed: Partially Started: This state appears when the base product is now ready for sale, but a future Start Date is set for any of its variations, and also the product is deployed.

DeployedDesignRetiredDeployed: Pending StartDeployed: Partially Started

lockedboolean

When the product is locked, the product is not editable.

Example: false

versioninteger

Version of the product.

Example: 1

deploymentRequiredChangesProductDeploymentChanges (object)

You must deploy the product to publish these changes.

liveChangesGetProductLiveChange (object)

These changes do not require a deployment.

localizationsarray of GetLocalization (object)

The locales supported by the product.

Request

JavaScriptCurlPython

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

Response

200401403404

[
  {
    "productType": "BASE",
    "companyId": "digitalriver",
    "siteIds": [
      "domoSite1",
      "domoSite2"
    ],
    "id": "1234567800",
    "state": "Deployed",
    "locked": false,
    "version": 1,
    "deploymentRequiredChanges": {
      "fulfillmentTypes": [
        "Download"
      ],
      "otherFulfillmentIntegration": {
        "fulfillerIds": [
          "digitalRiver"
        ]
      },
      "transferProduct": "2234567800",
      "upgradeProducts": [
        "3234567800"
      ],
      "downgradeProducts": [
        "4234567800"
      ]
    },
    "liveChanges": {
      "externalReferenceId": "sku-1234-5678-xyz",
      "catalogs": [
        {
          "catalogId": "123456000",
          "catalogName": "a catalog",
          "categories": [
            {
              "categoryId": "19000000",
              "categoryName": "a category"
            }
          ],
          "prices": [
            {
              "type": "listPrice",
              "priceListName": "Unit Price",
              "taxInclusive": false,
              "prices": [
                {
                  "currency": "USD",
                  "locale": "en_US",
                  "configuredPrice": 15.99,
                  "calculatedPrice": 0
                }
              ]
            }
          ]
        }
      ]
    },
    "localizations": [
      {
        "locale": "en_US",
        "isDefault": false,
        "groups": [
          {
            "groupId": "11000",
            "groupName": "Storefront Settings"
          }
        ]
      }
    ]
  }
]

Get the locale information for an individual or base product

Include the product ID and locale in the {productId} and {locale} URI path parameters to get locale information for an individual or base product.

GEThttps://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.

Query parameters

Header parameters

Response

200401403404

Successful response.

Body

application/json

productTypeenum

Indicates the type of product as either an individual or base product. A base product has one or more product variations such as different colors, sizes, or versions. An individual product a single item or many single items sold as a single product (such as a colection or box set.

BASEINDIVIDUAL

companyIdstring

The company identifier.

Example: "digitalriver"

siteIdsarray of string

The site identifier.

idstring

The individual product identifier or base product identifier for the product.

Example: "1234567800"

stateenum

The status of the product.

• Deployed: The current product setup is the same product setup that is available for sale on your store.
• Design: The current product setup (also called in the version) has not yet been deployed to your store.
• Retired: The version of the product cannot be purchased or seen on your store.
• Deployed: Pending Start: This state appears when a future Start Date is set for base, individual or variation product, and also the product is deployed. Meaning there is a version that is available for sale on your store. And there is another newer version will be available for sale on your store when the Start Date arrived.
• Deployed: Partially Started: This state appears when the base product is now ready for sale, but a future Start Date is set for any of its variations, and also the product is deployed.

DeployedDesignRetiredDeployed: Pending StartDeployed: Partially Started

lockedboolean

When the product is locked, the product is not editable.

Example: false

versioninteger

Version of the product.

Example: 1

deploymentRequiredChangesProductDeploymentChanges (object)

You must deploy the product to publish these changes.

liveChangesGetProductLiveChange (object)

These changes do not require a deployment.

localizationsarray of GetLocalization (object)

The locales supported by the product.

Request

JavaScriptCurlPython

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

Response

200401403404

[
  {
    "productType": "BASE",
    "companyId": "digitalriver",
    "siteIds": [
      "domoSite1",
      "domoSite2"
    ],
    "id": "1234567800",
    "state": "Deployed",
    "locked": false,
    "version": 1,
    "deploymentRequiredChanges": {
      "fulfillmentTypes": [
        "Download"
      ],
      "otherFulfillmentIntegration": {
        "fulfillerIds": [
          "digitalRiver"
        ]
      },
      "transferProduct": "2234567800",
      "upgradeProducts": [
        "3234567800"
      ],
      "downgradeProducts": [
        "4234567800"
      ]
    },
    "liveChanges": {
      "externalReferenceId": "sku-1234-5678-xyz",
      "catalogs": [
        {
          "catalogId": "123456000",
          "catalogName": "a catalog",
          "categories": [
            {
              "categoryId": "19000000",
              "categoryName": "a category"
            }
          ],
          "prices": [
            {
              "type": "listPrice",
              "priceListName": "Unit Price",
              "taxInclusive": false,
              "prices": [
                {
                  "currency": "USD",
                  "locale": "en_US",
                  "configuredPrice": 15.99,
                  "calculatedPrice": 0
                }
              ]
            }
          ]
        }
      ]
    },
    "localizations": [
      {
        "locale": "en_US",
        "isDefault": false,
        "groups": [
          {
            "groupId": "11000",
            "groupName": "Storefront Settings"
          }
        ]
      }
    ]
  }
]

Get the product variation information

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

GEThttps://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.

Query parameters

Header parameters

Response

200401403404

Successful response.

Body

application/json

productTypeenum

VARIATION

companyIdstring

The company identifier.

Example: "digitalriver"

siteIdsarray of string

The site identifier.

idstring

The product variation identifier.

Example: "1234567900"

stateenum

The status of the product.

• Deployed: The current product setup is the same product setup that is available for sale on your store.
• Design: The current product setup (also called in the version) has not yet been deployed to your store.
• Retired: The version of the product cannot be purchased or seen on your store.
• Deployed: Pending Start: This state appears when a future Start Date is set for base, individual or variation product, and also the product is deployed. Meaning there is a version that is available for sale on your store. And there is another newer version will be available for sale on your store when the Start Date arrived.
• Deployed: Partially Started: This state appears when the base product is now ready for sale, but a future Start Date is set for any of its variations, and also the product is deployed.

DeployedDesignRetiredDeployed: Pending StartDeployed: Partially Started

lockedboolean

When the product is locked, the product is not editable.

Example: false

versioninteger

Version of the product.

Example: 1

variationNamestring

The product variation name

Example: "Business, 1-year-license"

baseProductIdstring

The base product identifier for the variation.

Example: "1234567800"

varyingAttributesarray of VaryingAttribute (object)

deploymentRequiredChangesProductDeploymentChanges (object)

You must deploy the product to publish these changes.

liveChangesGetProductLiveChange (object)

These changes do not require a deployment.

localizationsarray of GetLocalization (object)

The locales supported by the product.

Request

JavaScriptCurlPython

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

Response

200401403404

[
  {
    "productType": "VARIATION",
    "companyId": "digitalriver",
    "siteIds": [
      "domoSite1",
      "domoSite2"
    ],
    "id": "1234567900",
    "state": "Deployed",
    "locked": false,
    "version": 1,
    "variationName": "Business, 1-year-license",
    "baseProductId": "1234567800",
    "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",
          "catalogName": "a catalog",
          "categories": [
            {
              "categoryId": "19000000",
              "categoryName": "a category"
            }
          ],
          "prices": [
            {
              "type": "listPrice",
              "priceListName": "Unit Price",
              "taxInclusive": false,
              "prices": [
                {
                  "currency": "USD",
                  "locale": "en_US",
                  "configuredPrice": 15.99,
                  "calculatedPrice": 0
                }
              ]
            }
          ]
        }
      ]
    },
    "localizations": [
      {
        "locale": "en_US",
        "isDefault": false,
        "groups": [
          {
            "groupId": "11000",
            "groupName": "Storefront Settings"
          }
        ]
      }
    ]
  }
]

Get the locale information for a product variation

Get the locale information for a product variation by including its base product ID, variation ID, and locale in the {baseProductId}, {variationId}, and {locale} URI path parameters.

GEThttps://api.digitalriver.com/v1/products/{baseProductId}/variations/{variationId}/locales/{locale}

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.

locale*string

The locale for the product.

Query parameters

Header parameters

Response

200401403404

Successful response.

Body

application/json

productTypeenum

VARIATION

companyIdstring

The company identifier.

Example: "digitalriver"

siteIdsarray of string

The site identifier.

idstring

The product variation identifier.

Example: "1234567900"

stateenum

The status of the product.

• Deployed: The current product setup is the same product setup that is available for sale on your store.
• Design: The current product setup (also called in the version) has not yet been deployed to your store.
• Retired: The version of the product cannot be purchased or seen on your store.
• Deployed: Pending Start: This state appears when a future Start Date is set for base, individual or variation product, and also the product is deployed. Meaning there is a version that is available for sale on your store. And there is another newer version will be available for sale on your store when the Start Date arrived.
• Deployed: Partially Started: This state appears when the base product is now ready for sale, but a future Start Date is set for any of its variations, and also the product is deployed.

DeployedDesignRetiredDeployed: Pending StartDeployed: Partially Started

lockedboolean

When the product is locked, the product is not editable.

Example: false

versioninteger

Version of the product.

Example: 1

variationNamestring

The product variation name

Example: "Business, 1-year-license"

baseProductIdstring

The base product identifier for the variation.

Example: "1234567800"

varyingAttributesarray of VaryingAttribute (object)

deploymentRequiredChangesProductDeploymentChanges (object)

You must deploy the product to publish these changes.

liveChangesGetProductLiveChange (object)

These changes do not require a deployment.

localizationsarray of GetLocalization (object)

The locales supported by the product.

Request

JavaScriptCurlPython

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

Response

200401403404

[
  {
    "productType": "VARIATION",
    "companyId": "digitalriver",
    "siteIds": [
      "domoSite1",
      "domoSite2"
    ],
    "id": "1234567900",
    "state": "Deployed",
    "locked": false,
    "version": 1,
    "variationName": "Business, 1-year-license",
    "baseProductId": "1234567800",
    "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",
          "catalogName": "a catalog",
          "categories": [
            {
              "categoryId": "19000000",
              "categoryName": "a category"
            }
          ],
          "prices": [
            {
              "type": "listPrice",
              "priceListName": "Unit Price",
              "taxInclusive": false,
              "prices": [
                {
                  "currency": "USD",
                  "locale": "en_US",
                  "configuredPrice": 15.99,
                  "calculatedPrice": 0
                }
              ]
            }
          ]
        }
      ]
    },
    "localizations": [
      {
        "locale": "en_US",
        "isDefault": false,
        "groups": [
          {
            "groupId": "11000",
            "groupName": "Storefront Settings"
          }
        ]
      }
    ]
  }
]