Products
Learn how to retrieve product information.
Getting a product by identifier
You can retrieve products programmatically.
The GET /v1/shoppers/me/products/{productId} request retrieves a specific product by its product identifier (productId). If the product is a product combination, the combined product information appears under the lineItem object, and component information appears under the component object.
curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/products/{productId}' \
--header 'authorization: bearer ***\
...{
"product": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/8027217700",
"relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource",
"categories": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/8027217700/categories",
"relation": "https://api.digitalriver.com/v1/shoppers/CategoriesResource"
},
"familyAttributes": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/8027217700/family-attributes",
"relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
},
"id": 8027217700,
"name": "Combination Product",
"displayName": "Combination Product",
"shortDescription": null,
"longDescription": null,
"productType": "OTHER",
"sku": "Combination Product",
"externalReferenceId": null,
"companyId": "paytest",
"displayableProduct": "true",
"purchasable": "true",
"manufacturerName": null,
"manufacturerPartNumber": "1234567890",
"minimumQuantity": null,
"maximumQuantity": null,
"thumbnailImage": null,
"productImage": null,
"keywords": null,
"baseProduct": "false",
"pricing": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/8027217700/pricing",
"listPrice": {
"currency": "USD",
"value": 45
},
"salePriceWithQuantity": {
"currency": "USD",
"value": 36
},
"formattedListPrice": "$45.00",
"formattedSalePriceWithQuantity": "$36.00",
"listPriceIncludesTax": "false",
"msrpPrice": null,
"formattedMsrpPrice": null
},
"addProductToCart": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=8027217700",
"relation": "https://api.digitalriver.com/v1/shoppers/LineItemsResource",
"cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=8027217700"
},
"components": [
{
"product": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/257734900",
"relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
},
"categories": {
"uri": "https://api.digitalriver.com/api/v1/shoppers/me/products/257734900/categories",
"relation": "https://api.digitalriver.com/v1/shoppers/CategoriesResource"
},
"familyAttributes": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/257734900/family-attributes",
"relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
},
"id": 257734900,
"name": "Free trial product",
"displayName": "Free trial product",
"shortDescription": null,
"longDescription": null,
"productType": "DOWNLOAD",
"sku": "asdf",
"externalReferenceId": null,
"companyId": "paytest",
"displayableProduct": "true",
"purchasable": "true",
"manufacturerName": null,
"manufacturerPartNumber": "asdf",
"minimumQuantity": null,
"maximumQuantity": null,
"thumbnailImage": null,
"productImage": null,
"keywords": null,
"baseProduct": "false",
"pricing": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/257734900/pricing",
"listPrice": {
"currency": "USD",
"value": 9
},
"salePriceWithQuantity": {
"currency": "USD",
"value": 0
},
"formattedListPrice": "$9.00",
"formattedSalePriceWithQuantity": "$0.00",
"listPriceIncludesTax": "false",
"msrpPrice": null,
"formattedMsrpPrice": null
},
"addProductToCart": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=257734900",
"relation": "https://api.digitalriver.com/v1/shoppers/LineItemsResource",
"cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=257734900"
},
"recurringSubscriptionInfo": {
"autoRenewal": "true",
"termUnit": "WEEK",
"termLength": "1"
}
},
{
"product": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/5505627700",
"relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
},
"categories": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/5505627700/categories",
"relation": "https://api.digitalriver.com/v1/shoppers/CategoriesResource"
},
"familyAttributes": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/5505627700/family-attributes",
"relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
},
"id": 5505627700,
"name": "AK123_Physical",
"displayName": "AK123_Physical",
"shortDescription": null,
"longDescription": null,
"productType": "PHYSICAL",
"sku": "AK123_Physical",
"externalReferenceId": null,
"companyId": "paytest",
"displayableProduct": "true",
"purchasable": "true",
"manufacturerName": null,
"manufacturerPartNumber": "MSTS321",
"minimumQuantity": null,
"maximumQuantity": null,
"thumbnailImage": null,
"productImage": null,
"keywords": null,
"baseProduct": "false",
"pricing": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/5505627700/pricing",
"listPrice": {
"currency": "USD",
"value": 17
},
"salePriceWithQuantity": {
"currency": "USD",
"value": 17
},
"formattedListPrice": "$17.00",
"formattedSalePriceWithQuantity": "$17.00",
"listPriceIncludesTax": "false",
"msrpPrice": null,
"formattedMsrpPrice": null
},
"addProductToCart": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=5505627700",
"relation": "https://api.digitalriver.com/v1/shoppers/LineItemsResource",
"cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=5505627700"
}
},
{
"product": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/6686217700",
"relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
},
"categories": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/6686217700/categories",
"relation": "https://api.digitalriver.comm/v1/shoppers/CategoriesResource"
},
"familyAttributes": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/6686217700/family-attributes",
"relation": "https://api.digitalriver.com/v1/shoppers/ProductsResource"
},
"id": 6686217700,
"name": "Auto_Monthly_Sub",
"displayName": "Auto_Monthly_Sub",
"shortDescription": null,
"longDescription": null,
"productType": "DOWNLOAD",
"sku": "Auto_Monthly_Sub",
"externalReferenceId": null,
"companyId": "paytest",
"displayableProduct": "true",
"purchasable": "true",
"manufacturerName": null,
"manufacturerPartNumber": "12345678",
"minimumQuantity": null,
"maximumQuantity": null,
"thumbnailImage": null,
"productImage": null,
"keywords": null,
"baseProduct": "false",
"pricing": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/6686217700/pricing",
"listPrice": {
"currency": "USD",
"value": 19
},
"salePriceWithQuantity": {
"currency": "USD",
"value": 19
},
"formattedListPrice": "$19.00",
"formattedSalePriceWithQuantity": "$19.00",
"listPriceIncludesTax": "false",
"msrpPrice": null,
"formattedMsrpPrice": null
},
"addProductToCart": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=6686217700",
"relation": "https://api.digitalriver.com/v1/shoppers/LineItemsResource",
"cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=6686217700"
},
"recurringSubscriptionInfo": {
"autoRenewal": "true",
"termUnit": "MONTH",
"termLength": "1"
}
}
]
}
}Getting volume pricing for a specific product
The GET /v1/shoppers/me/products/{productId}/pricing/volume-pricing request retrieves volume pricing for a specific product by its product identifier (productId).
curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/products/{productId}/pricing/volume-pricing' \
--header 'authorization: bearer ***\
...{
"volumePricing": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/73248500/pricing/volume-pricing",
"tier": [
{
"from": 1,
"to": 1,
"pricing": {
"listPrice": {
"currency": "USD",
"value": "19.99"
},
"listPriceWithQuantity": {
"currency": "USD",
"value": "19.99"
},
"salePriceWithQuantity": {
"currency": "USD",
"value": "19.99"
},
"formattedListPrice": "$8.00",
"formattedListPriceWithQuantity": "$8.00",
"formattedSalePriceWithQuantity": "$8.00",
"totalDiscountWithQuantity": {
"currency": "USD",
"value": "19.99"
},
"formattedTotalDiscountWithQuantity": "$0.00",
"discountDescription": "string",
"feePricing": {
"salePriceWithFeesAndQuantity": {
"currency": "USD",
"value": "19.99"
},
"formattedSalePriceWithFeesAndQuantity": "$8.00"
},
"listPriceIncludesTax": "false",
"msrpPrice": {
"currency": "USD",
"value": "19.99"
},
"formattedMsrpPrice": "string"
}
}
],
"formattedSalesPriceRange": "$5.00-$8.00"
}
}Getting all products from the product catalog
The GET /v1/shoppers/me/products request retrieves all products from the catalog.
curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/products' \
--header 'authorization: bearer ***\
...{
"products": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products",
"nextPage": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products?pageNumber=11&pageSize=1"
},
"previousPage": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products?pageNumber=9&pageSize=1"
},
"product": [
{
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/73248400",
"displayName": "Class VI",
"thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft3/images/product/thumbnail/classVIThumb.jpg",
"pricing": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/73248400/pricing",
"formattedListPrice": "$79.99",
"formattedSalePriceWithQuantity": "$79.99"
},
"addProductToCart": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=73248400",
"cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=73248400"
}
}
],
"totalResults": 11,
"totalResultPages": 11
}
}Getting all products for a specified category
The GET /v1/shoppers/me/categories/{categoryId}/products request retrieves all products for a specified category (categoryId).
curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/categories/{categoryId}/products' \
--header 'authorization: bearer ***\
...{
"products": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products",
"product": [
{
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200",
"displayName": "Class I",
"thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIThumb_v2.jpg",
"pricing": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200/pricing",
"formattedListPrice": "$19.99",
"formattedSalePriceWithQuantity": "$18.99"
},
"variations": {
"uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358200/variations"
}
}
],
"totalResults": 1,
"totalResultPages": 1
}
}Getting a base product, individual product, or product combinations
The following GET /v1/products/{productId, ERID, productCombinationId, productCombinationERID, baseProductId, or baseProductERID} request retrieves data for an individual product, base product, or product combination. All product variations (if any) for a base product for a product combination will appear as a URL in the response. All components for a product combination appear as a lineItem under the components object.
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.
The following example gets a specific base or individual product with a productId.
curl --location --request GET 'https://api.digitalriver.com/v1/products/{productId, combinationProductId, 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' \
...The request returns the product information for the specified productId in the synchronous response.
[
{
"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": true,
"prices": [
{
"currency": "USD",
"locale": "en_US",
"configuredPrice": 15.99,
"calculatedPrice": 0
}
]
}
]
}
]
},
"localizations": [
{
"locale": "en_US",
"isDefault": true,
"groups": [
{
"groupId": 11000,
"groupName": "Storefront Settings",
"attributes": {
"property1": "string",
"property2": "string"
}
}
]
}
]
}
]The request returns the product information for the specified externalReferenceId in the synchronous response.
[
{
"productType": "INDIVIDUAL",
"companyId": "acme",
"siteIds": [
"acme"
],
"id": "51954990080",
"state": "DESIGN",
"locked": false,
"version": 1,
"deploymentRequiredChanges": {
"fulfillmentTypes": [],
"otherFulfillmentIntegration": {
"fulfillerIds": []
},
"upgradeProducts": [],
"downgradeProducts": []
},
"liveChanges": {
"externalReferenceId": "external-reference-id-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"catalogs": [
{
"catalogId": "4783669800",
"catalogName": "acme",
"categories": [],
"pricing": [
{
"type": "listPrice",
"priceListName": "acme",
"taxInclusive": false,
"prices": [
{
"currency": "CAD",
"locale": "en_CA"
},
{
"currency": "CAD",
"locale": "en_US"
},
{
"currency": "USD",
"locale": "en_US",
"configuredPrice": 10.00
},
{
"currency": "CAD",
"locale": "fr_CA"
},
{
"currency": "ARS"
},
{
"currency": "AUD"
},
{
"currency": "BRL"
},
{
"currency": "CAD"
},
{
"currency": "CHF"
},
{
"currency": "CLP"
},
{
"currency": "CNY"
},
{
"currency": "COP"
},
{
"currency": "CZK"
},
{
"currency": "DKK"
},
{
"currency": "EGP"
},
{
"currency": "EUR"
},
{
"currency": "GBP"
},
{
"currency": "HKD"
},
{
"currency": "HUF"
},
{
"currency": "IDR"
},
{
"currency": "ILS"
},
{
"currency": "INR"
},
{
"currency": "JPY"
},
{
"currency": "KRW"
},
{
"currency": "MXN"
},
{
"currency": "MYR"
},
{
"currency": "NOK"
},
{
"currency": "NZD"
},
{
"currency": "OMR"
},
{
"currency": "PEN"
},
{
"currency": "PLN"
},
{
"currency": "RUB"
},
{
"currency": "SEK"
},
{
"currency": "SGD"
},
{
"currency": "THB"
},
{
"currency": "TRY"
},
{
"currency": "TWD"
},
{
"currency": "USD"
},
{
"currency": "VEF"
},
{
"currency": "ZAR"
}
]
},
{
"type": "subscriptionRenewalPrice",
"priceListName": "Subscription Renewal Price list",
"taxInclusive": false,
"prices": [
{
"currency": "ARS"
},
{
"currency": "EUR"
},
{
"currency": "GBP"
},
{
"currency": "USD"
}
]
}
]
}
]
},
"localizations": [
{
"locale": "en_US",
"isDefault": true,
"groups": [
{
"groupId": "2",
"groupName": "Storefront Settings",
"attributes": {
"longDescription": "longDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"nonSolr": true,
"keywords": "keywords-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"displayName": "demo-display-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"taxableUnspscCode": "43230000",
"confirmAddlInfo": "confirmAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"shortDescription": "shortDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"isViewable": true,
"taxableProductCode": "4323.320_D",
"isOrderable": true,
"returnMethod": "LOD",
"emailAddlInfoText": "emailAddlInfoText-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"name": "demo-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"emailAddlInfo": "emailAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"minOrderQuantity": 0,
"privateStoreOnly": false,
"productReturnMethod": "ByAgentAndSelfService",
"sku": "demo-sku-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"maxOrderQuantity": 0
}
},
{
"groupId": "10",
"groupName": "Subscription",
"attributes": {
"freeExtension": "2_WEEK",
"timeIntervalForTrialReminderNotifications": [
"30",
"15",
"7",
"2"
],
"gracePeriod": "1_WEEK",
"timeIntervalForUpgradeReminderNotificationsPostCreation": [
"7",
"15",
"30",
"90"
],
"timeIntervalForReminderNotifications": [
"90",
"30",
"15",
"7"
],
"suppressOFIInQuantityIncrease": false,
"suppressDRMInUpgradeDowngrade": false,
"suppressOFIInUpgradeDowngrade": false,
"suppressDRMInQuantityIncrease": false,
"timeIntervalForReminderNotificationsPostExpiration": [
"7",
"15",
"30",
"90"
],
"autoRenewalDateBasis": "PurchaseDate",
"timeIntervalForUpgradeReminderNotificationsPreExpiration": [
"97",
"37",
"22",
"14"
],
"isFreeTrial": true,
"combinedRenewalPeriod": 1,
"timeIntervalForCCExpirationReminderNotifications": [
"30",
"15",
"7"
],
"duration": "TWO_MONTH",
"timeIntervalForManualReminderNotifications": [
"90",
"30",
"15",
"7"
],
"isDistinctScheduleTurnedOn": false,
"isCombinedRenewal": true,
"suppressDRMInRenewal": false,
"paymentSchedule": "matchRecurrence",
"isAutomatic": true,
"numOfDaysPriorExpirationForRenewalPreFirst": 30,
"isChangeProductAsRenewal": false,
"freeTrialPeriod": 45,
"includeRenewalProductInUpgradeList": true,
"numOfDaysPriorExpirationForRenewal": 4,
"suppressOFIInTrialConversion": true,
"numOfDaysPriorExpirationForRenewalFirst": 15,
"timeIntervalForUpgradeReminderNotificationsPostExpiration": [
"97",
"37",
"22",
"14"
],
"postExpirationBillingAttemptIntervalInDays": 7,
"suppressOFIInRenewal": true,
"suppressDRMInTrialConversion": false,
"trialPostExpirationBillingAttemptIntervalInDays": 7,
"trialGracePeriod": "1_MONTH",
"timeIntervalForTrialManualReminderNotifications": [
"30",
"15",
"7",
"2"
]
}
},
{
"groupId": "16",
"groupName": "Export Controls",
"attributes": {
"manufactureCountry": "US",
"eccn": "3A992"
}
}
]
}
]
}
]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.
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' \
...The request returns the product information for the specified productId in the synchronous response.
[
{
"productType": "INDIVIDUAL",
"companyId": "acme",
"siteIds": [
"acme"
],
"id": "51954990080",
"state": "RETIRED",
"locked": false,
"version": 1,
"deploymentRequiredChanges": {
"fulfillmentTypes": [],
"otherFulfillmentIntegration": {
"fulfillerIds": []
},
"upgradeProducts": [],
"downgradeProducts": []
},
"liveChanges": {
"externalReferenceId": "external-reference-id-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"catalogs": [
{
"catalogId": "4783669800",
"catalogName": "acme",
"categories": [],
"pricing": [
{
"type": "listPrice",
"priceListName": "acme",
"taxInclusive": false,
"prices": [
{
"currency": "CAD",
"locale": "en_CA"
},
{
"currency": "CAD",
"locale": "en_US"
},
{
"currency": "USD",
"locale": "en_US",
"configuredPrice": 10.00
},
{
"currency": "CAD",
"locale": "fr_CA"
},
{
"currency": "ARS"
},
{
"currency": "AUD"
},
{
"currency": "BRL"
},
{
"currency": "CAD"
},
{
"currency": "CHF"
},
{
"currency": "CLP"
},
{
"currency": "CNY"
},
{
"currency": "COP"
},
{
"currency": "CZK"
},
{
"currency": "DKK"
},
{
"currency": "EGP"
},
{
"currency": "EUR"
},
{
"currency": "GBP"
},
{
"currency": "HKD"
},
{
"currency": "HUF"
},
{
"currency": "IDR"
},
{
"currency": "ILS"
},
{
"currency": "INR"
},
{
"currency": "JPY"
},
{
"currency": "KRW"
},
{
"currency": "MXN"
},
{
"currency": "MYR"
},
{
"currency": "NOK"
},
{
"currency": "NZD"
},
{
"currency": "OMR"
},
{
"currency": "PEN"
},
{
"currency": "PLN"
},
{
"currency": "RUB"
},
{
"currency": "SEK"
},
{
"currency": "SGD"
},
{
"currency": "THB"
},
{
"currency": "TRY"
},
{
"currency": "TWD"
},
{
"currency": "USD"
},
{
"currency": "VEF"
},
{
"currency": "ZAR"
}
]
},
{
"type": "subscriptionRenewalPrice",
"priceListName": "Subscription Renewal Price list",
"taxInclusive": false,
"prices": [
{
"currency": "ARS"
},
{
"currency": "EUR"
},
{
"currency": "GBP"
},
{
"currency": "USD"
}
]
}
]
}
]
},
"localizations": [
{
"locale": "en_US",
"isDefault": true,
"groups": [
{
"groupId": "2",
"groupName": "Storefront Settings",
"attributes": {
"longDescription": "longDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"nonSolr": true,
"keywords": "keywords-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"displayName": "demo-display-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"taxableUnspscCode": "43230000",
"confirmAddlInfo": "confirmAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"shortDescription": "shortDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"isViewable": true,
"taxableProductCode": "4323.320_D",
"isOrderable": true,
"returnMethod": "LOD",
"emailAddlInfoText": "emailAddlInfoText-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"name": "demo-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"emailAddlInfo": "emailAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"minOrderQuantity": 0,
"privateStoreOnly": false,
"productReturnMethod": "ByAgentAndSelfService",
"sku": "demo-sku-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"maxOrderQuantity": 0
}
},
{
"groupId": "10",
"groupName": "Subscription",
"attributes": {
"freeExtension": "2_WEEK",
"timeIntervalForTrialReminderNotifications": [
"30",
"15",
"7",
"2"
],
"gracePeriod": "1_WEEK",
"timeIntervalForUpgradeReminderNotificationsPostCreation": [
"7",
"15",
"30",
"90"
],
"timeIntervalForReminderNotifications": [
"90",
"30",
"15",
"7"
],
"suppressOFIInQuantityIncrease": false,
"suppressDRMInUpgradeDowngrade": false,
"suppressOFIInUpgradeDowngrade": false,
"suppressDRMInQuantityIncrease": false,
"timeIntervalForReminderNotificationsPostExpiration": [
"7",
"15",
"30",
"90"
],
"autoRenewalDateBasis": "PurchaseDate",
"timeIntervalForUpgradeReminderNotificationsPreExpiration": [
"97",
"37",
"22",
"14"
],
"isFreeTrial": true,
"combinedRenewalPeriod": 1,
"timeIntervalForCCExpirationReminderNotifications": [
"30",
"15",
"7"
],
"duration": "TWO_MONTH",
"timeIntervalForManualReminderNotifications": [
"90",
"30",
"15",
"7"
],
"isDistinctScheduleTurnedOn": false,
"isCombinedRenewal": true,
"suppressDRMInRenewal": false,
"paymentSchedule": "matchRecurrence",
"isAutomatic": true,
"numOfDaysPriorExpirationForRenewalPreFirst": 30,
"isChangeProductAsRenewal": false,
"freeTrialPeriod": 45,
"includeRenewalProductInUpgradeList": true,
"numOfDaysPriorExpirationForRenewal": 4,
"suppressOFIInTrialConversion": true,
"numOfDaysPriorExpirationForRenewalFirst": 15,
"timeIntervalForUpgradeReminderNotificationsPostExpiration": [
"97",
"37",
"22",
"14"
],
"postExpirationBillingAttemptIntervalInDays": 7,
"suppressOFIInRenewal": true,
"suppressDRMInTrialConversion": false,
"trialPostExpirationBillingAttemptIntervalInDays": 7,
"trialGracePeriod": "1_MONTH",
"timeIntervalForTrialManualReminderNotifications": [
"30",
"15",
"7",
"2"
]
}
},
{
"groupId": "16",
"groupName": "Export Controls",
"attributes": {
"manufactureCountry": "US",
"eccn": "3A992"
}
}
]
}
]
}
]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' \
...The response displays the deployed version of the product.
[
{
"productType": "INDIVIDUAL",
"companyId": "acme",
"siteIds": [
"acme"
],
"id": "51954990080",
"state": "DEPLOYED",
"locked": false,
"version": 1,
"deploymentRequiredChanges": {
"fulfillmentTypes": [],
"otherFulfillmentIntegration": {
"fulfillerIds": []
},
"upgradeProducts": [],
"downgradeProducts": []
},
"liveChanges": {
"externalReferenceId": "external-reference-id-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"catalogs": [
{
"catalogId": "4783669800",
"catalogName": "acme",
"categories": [],
"pricing": [
{
"type": "listPrice",
"priceListName": "acme",
"taxInclusive": false,
"prices": [
{
"currency": "CAD",
"locale": "en_CA"
},
{
"currency": "CAD",
"locale": "en_US"
},
{
"currency": "USD",
"locale": "en_US",
"configuredPrice": 10.00
},
{
"currency": "CAD",
"locale": "fr_CA"
},
{
"currency": "ARS"
},
{
"currency": "AUD"
},
{
"currency": "BRL"
},
{
"currency": "CAD"
},
{
"currency": "CHF"
},
{
"currency": "CLP"
},
{
"currency": "CNY"
},
{
"currency": "COP"
},
{
"currency": "CZK"
},
{
"currency": "DKK"
},
{
"currency": "EGP"
},
{
"currency": "EUR"
},
{
"currency": "GBP"
},
{
"currency": "HKD"
},
{
"currency": "HUF"
},
{
"currency": "IDR"
},
{
"currency": "ILS"
},
{
"currency": "INR"
},
{
"currency": "JPY"
},
{
"currency": "KRW"
},
{
"currency": "MXN"
},
{
"currency": "MYR"
},
{
"currency": "NOK"
},
{
"currency": "NZD"
},
{
"currency": "OMR"
},
{
"currency": "PEN"
},
{
"currency": "PLN"
},
{
"currency": "RUB"
},
{
"currency": "SEK"
},
{
"currency": "SGD"
},
{
"currency": "THB"
},
{
"currency": "TRY"
},
{
"currency": "TWD"
},
{
"currency": "USD"
},
{
"currency": "VEF"
},
{
"currency": "ZAR"
}
]
},
{
"type": "subscriptionRenewalPrice",
"priceListName": "Subscription Renewal Price list",
"taxInclusive": false,
"prices": [
{
"currency": "ARS"
},
{
"currency": "EUR"
},
{
"currency": "GBP"
},
{
"currency": "USD"
}
]
}
]
}
]
},
"localizations": [
{
"locale": "en_US",
"isDefault": true,
"groups": [
{
"groupId": "2",
"groupName": "Storefront Settings",
"attributes": {
"longDescription": "longDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"nonSolr": true,
"keywords": "keywords-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"displayName": "demo-display-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"taxableUnspscCode": "43230000",
"confirmAddlInfo": "confirmAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"shortDescription": "shortDescription-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"isViewable": true,
"taxableProductCode": "4323.320_D",
"isOrderable": true,
"returnMethod": "LOD",
"emailAddlInfoText": "emailAddlInfoText-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"name": "demo-name-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"emailAddlInfo": "emailAddlInfo-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"minOrderQuantity": 0,
"privateStoreOnly": false,
"productReturnMethod": "ByAgentAndSelfService",
"sku": "demo-sku-f7f6dcdc-a9dd-47c6-97fd-ffb340bcd399",
"maxOrderQuantity": 0
}
},
{
"groupId": "10",
"groupName": "Subscription",
"attributes": {
"freeExtension": "2_WEEK",
"timeIntervalForTrialReminderNotifications": [
"30",
"15",
"7",
"2"
],
"gracePeriod": "1_WEEK",
"timeIntervalForUpgradeReminderNotificationsPostCreation": [
"7",
"15",
"30",
"90"
],
"timeIntervalForReminderNotifications": [
"90",
"30",
"15",
"7"
],
"suppressOFIInQuantityIncrease": false,
"suppressDRMInUpgradeDowngrade": false,
"suppressOFIInUpgradeDowngrade": false,
"suppressDRMInQuantityIncrease": false,
"timeIntervalForReminderNotificationsPostExpiration": [
"7",
"15",
"30",
"90"
],
"autoRenewalDateBasis": "PurchaseDate",
"timeIntervalForUpgradeReminderNotificationsPreExpiration": [
"97",
"37",
"22",
"14"
],
"isFreeTrial": true,
"combinedRenewalPeriod": 1,
"timeIntervalForCCExpirationReminderNotifications": [
"30",
"15",
"7"
],
"duration": "TWO_MONTH",
"timeIntervalForManualReminderNotifications": [
"90",
"30",
"15",
"7"
],
"isDistinctScheduleTurnedOn": false,
"isCombinedRenewal": true,
"suppressDRMInRenewal": false,
"paymentSchedule": "matchRecurrence",
"isAutomatic": true,
"numOfDaysPriorExpirationForRenewalPreFirst": 30,
"isChangeProductAsRenewal": false,
"freeTrialPeriod": 45,
"includeRenewalProductInUpgradeList": true,
"numOfDaysPriorExpirationForRenewal": 4,
"suppressOFIInTrialConversion": true,
"numOfDaysPriorExpirationForRenewalFirst": 15,
"timeIntervalForUpgradeReminderNotificationsPostExpiration": [
"97",
"37",
"22",
"14"
],
"postExpirationBillingAttemptIntervalInDays": 7,
"suppressOFIInRenewal": true,
"suppressDRMInTrialConversion": false,
"trialPostExpirationBillingAttemptIntervalInDays": 7,
"trialGracePeriod": "1_MONTH",
"timeIntervalForTrialManualReminderNotifications": [
"30",
"15",
"7",
"2"
]
}
},
{
"groupId": "16",
"groupName": "Export Controls",
"attributes": {
"manufactureCountry": "US",
"eccn": "3A992"
}
}
]
}
]
}
]Last updated