Getting a base or individual product

Learn how to get the information for a base or individual product.

Getting a base or individual product

The following GET /v1/products/{productId, ERID, baseProductId, or baseProductERID} request retrieves data for an individual or base product. All product variations (if any) for a base product will appear as a URL in the response.

To get a specific product, you must provide either a productId or ERID. If the request finds multiple products associated with the ERID, the response will return all of them.

Duplicate ERIDs are not allowed. To prevent duplicate ERIDs, enable the Enforce Unique Value when configuring company settings in Global Commerce. This ensures that you won't accidentally provide an ERID that would result in duplicate products in the response if you searched for a product by ERID.

productId cURL

The following example gets a specific base or individual product with a productId.

curl --location --request GET 'https://api.digitalriver.com/v1/products/{productId or baseProductId}' \
--header 'Authorization: Basic <API_key>' \
...

An ERID request requires the x-erid-as-pid=true header.

curl --location --request GET 'https://api.digitalriver.com/v1/products/{ERID or baseProductERID}' \
--header 'Authorization: Basic <API_key>' \
--header 'header x-erid-as-pid=true' \
...

productId 200 OK response

ERID 200 OK response

Getting the deployed or retired versions of a product

To retrieve a filtered list of deployed or retired products, specify the version query parameter. The version values are DEPLOYED and RETIRED. The request returns products with the specified values. See the version query parameter for more information.

cURL with RETIRED query parameter

The following example gets retired versions of a specific product with a productId.

curl --location --request GET 'https://api.digitalriver.com/v1/products/{productId}?version=RETIRED' \
--header 'Authorization: Basic <API_key>' \
...

An ERID request requires the x-erid-as-pid=true header.

curl --location --request GET 'https://api.digitalriver.com/v1/products/{ERID}?version=RETIRED' \
--header 'Authorization: Basic <API_key>' \
--header 'header x-erid-as-pid=true' \
...

200 OK response

cURL with DEPLOYED query parameter

The following example gets deployed versions of a specified product with a productId.

curl --location --request GET 
'https://api.digitalriver.com/v1/products/[productId}?version=DEPLOYED' \
--header 'Authorization: Basic <API_key>' \
...

An ERID request requires the x-erid-as-pid=true header.

curl --location --request POST 'https://api.digitalriver.com/v1/products/{ERID}?version=DEPLOYED' \
--header 'Authorization: Basic <API_key>' \
--header 'header x-erid-as-pid=true' \
...

200 OK response