Product Variations

Use the Product Variations API to get variations for a product.

Methods


					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_102)
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
date: Tue, 20 Sep 2016 12:53:07 GMT
x-dr-requestid: x_dr_request_ID
server: Apache
expires: Wed, 31 Dec 1969 18:00:00 CST
x_request_id: TIME=1474375987003:NODE=gcapp01_gcappsys022010.c022:THREAD=181
x-server-name: server_name
x-varnish: varnish_ID
access-control-allow-origin: *
x-session-tag: session_tag
connection: keep-alive
accept-ranges: bytes
cache-control: no-cache
age: 0
Content-Length: 9471
			
					{"variations": {
   "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/variations",
   "product":    [
            {
         "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID",
         "parentProduct":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID",
         },
         "categories":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/categories",
            "relation": "https://developers.digitalriver.com/v1/shoppers/CategoriesResource"
         },
         "familyAttributes":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/family-attributes",
         },
         "id": 64578500,
         "name": "Class I",
         "displayName": "Class I",
         "shortDescription": "Class I is the perfect GPS waypoint and route manager for the beginning or occasional GPS user.",
         "longDescription": "Class I is the fast and easy way to create, edit, and transfer waypoints and routes between your computer and your Garmin, Magellan, or Lowrance GPS. Using Class I, you can manage all of your waypoints and routes, and display them in lists sorted by name, elevation, or distance. Class I connects your GPS to the best mapping and information sites on the Internet, giving you one-click access to street and topo maps, aerial photos, weather forecasts, and nearby attractions.",
         "productType": "DOWNLOAD",
         "sku": "Class I",
         "externalReferenceId": "Test External Reference Number",
         "companyId": "demosft1",
         "displayableProduct": "true",
         "purchasable": "true",
         "manufacturerName": "Test Manufacturer Name",
         "manufacturerPartNumber": "Test Manufacturer Part Number",
         "minimumQuantity": null,
         "maximumQuantity": null,
         "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIThumb.jpg",
         "productImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/detail/classIBox.jpg",
         "keywords": "testKeyword",
         "baseProduct": "false",
         "customAttributes": {"attribute":          [
                        {
               "name": "nonSolr",
               "type": "Boolean",
               "value": "false"
            },
                        {
               "name": "numberOfDownloads",
               "type": "Integer",
               "value": "5"
            },
                        {
               "name": "originalIsOrderable",
               "type": "Boolean",
               "value": "true"
            },
                        {
               "name": "downloadDisplayed",
               "type": "Boolean",
               "value": "true"
            },
                        {
               "name": "downloadDisplayName",
               "type": "String",
               "value": "WaterLilies.jpg"
            },
                        {
               "name": "downloadDisplayNames",
               "type": "List",
               "value": "[]"
            },
                        {
               "name": "eula",
               "type": "String",
               "value": "test"
            },
                        {
               "name": "applicationFile",
               "type": "String",
               "value": "WaterLilies.jpg"
            },
                        {
               "name": "numberOfIPAddresses",
               "type": "Integer",
               "value": "10"
            },
                        {
               "name": "platform",
               "type": "String",
               "value": "1 User License"
            },
                        {
               "name": "timeFrame",
               "type": "Integer",
               "value": "30"
            },
                        {
               "name": "fileSize",
               "type": "Integer",
               "value": "82"
            },
                        {
               "name": "downloadType",
               "type": "String",
               "value": "HTTP"
            },
                        {
               "name": "fileSizeValidatedDate",
               "type": "Date",
               "value": "Tue Sep 25 11:00:19 CDT 2007"
            },
                        {
               "name": "fileOnBackupMedia",
               "type": "Boolean",
               "value": "true"
            },
                        {
               "name": "originalIsViewable",
               "type": "Boolean",
               "value": "true"
            },
                        {
               "name": "downloadAdapter",
               "type": "String",
               "value": "com.digitalriver.downloads.adapters.DRHDownloadAdapter"
            }
         ]},
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "listPrice":             {
               "currency": "USD",
               "value": 19.99
            },
            "listPriceWithQuantity":             {
               "currency": "USD",
               "value": 19.99
            },
            "salePriceWithQuantity":             {
               "currency": "USD",
               "value": 17.99
            },
            "formattedListPrice": "$19.99",
            "formattedListPriceWithQuantity": "$19.99",
            "formattedSalePriceWithQuantity": "$17.99",
            "totalDiscountWithQuantity":             {
               "currency": "USD",
               "value": 2
            },
            "formattedTotalDiscountWithQuantity": "$2.00",
            "discountDescription": "10%",
            "tax": {"vatPercentage": 0},
            "feePricing":             {
               "salePriceWithFeesAndQuantity":                {
                  "currency": "USD",
                  "value": 17.99
               },
               "formattedSalePriceWithFeesAndQuantity": "$17.99"
            },
            "listPriceIncludesTax": "false",
            "msrpPrice": null,
            "formattedMsrpPrice": null
         },
         "inventoryStatus":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/inventory-status",
            "availableQuantity": 2147483647,
            "availableQuantityIsEstimated": "false",
            "productIsInStock": "true",
            "productIsAllowsBackorders": "true",
            "productIsTracked": "false",
            "requestedQuantityAvailable": "true",
            "status": "PRODUCT_INVENTORY_IN_STOCK",
            "statusIsEstimated": "false",
            "expectedInStockDate": null,
            "customStockMessage": null
         },
         "addProductToCart":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=product_ID",
            "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=product_ID"
         },
         "purchaseProduct":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/purchase",
         },
         "addProductToWishList": {"uri": "https://api.digitalriver.com/v1/shoppers/me/wish-lists/default?productId=product_ID"}
      },
            {
         "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID",
         "parentProduct":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID",
         },
         "categories":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/categories",
         },
         "familyAttributes":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/family-attributes",
         },
         "id": product_ID,
         "name": "Class I",
         "displayName": "Class I",
         "shortDescription": "Class I is the perfect GPS waypoint and route manager for the beginning or occasional GPS user.",
         "longDescription": "Class I is the fast and easy way to create, edit, and transfer waypoints and routes between your computer and your Garmin, Magellan, or Lowrance GPS. Using Class I, you can manage all of your waypoints and routes, and display them in lists sorted by name, elevation, or distance. Class I connects your GPS to the best mapping and information sites on the Internet, giving you one-click access to street and topo maps, aerial photos, weather forecasts, and nearby attractions.",
         "productType": "PHYSICAL",
         "sku": "Class I",
         "externalReferenceId": null,
         "companyId": "demosft1",
         "displayableProduct": "true",
         "purchasable": "true",
         "manufacturerName": null,
         "manufacturerPartNumber": null,
         "minimumQuantity": null,
         "maximumQuantity": null,
         "thumbnailImage": "https://domain_ID.digitalriver.com/Storefront/path/images/product/thumbnail/classIThumb.jpg",
         "productImage": "https://domain_ID.digitalriver.com/Storefront/path/images/product/detail/classIBox.jpg",
         "keywords": null,
         "baseProduct": "false",
         "customAttributes": {"attribute":          [
                        {
               "name": "needsRestrictedShippingOption",
               "type": "Boolean",
               "value": "false"
            },
                        {
               "name": "originalIsOrderable",
               "type": "Boolean",
               "value": "true"
            },
                        {
               "name": "weight",
               "type": "Quantity",
               "value": "2.000 lb"
            },
                        {
               "name": "platform",
               "type": "String",
               "value": "1 User License"
            },
                        {
               "name": "originalIsViewable",
               "type": "Boolean",
               "value": "true"
            },
                        {
               "name": "shipsInTimeFrameOverrideMessage",
               "type": "String",
               "value": "testCustomMessage"
            },
                        {
               "name": "shipsInTimeFrameOverrideEnabled",
               "type": "Boolean",
               "value": "true"
            }
         ]},
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "listPrice":             {
               "currency": "USD",
               "value": 19.99
            },
            "listPriceWithQuantity":             {
               "currency": "USD",
               "value": 19.99
            },
            "salePriceWithQuantity":             {
               "currency": "USD",
               "value": 18.99
            },
            "formattedListPrice": "$19.99",
            "formattedListPriceWithQuantity": "$19.99",
            "formattedSalePriceWithQuantity": "$18.99",
            "totalDiscountWithQuantity":             {
               "currency": "USD",
               "value": 1
            },
            "formattedTotalDiscountWithQuantity": "$1.00",
            "discountDescription": "$1.00",
            "tax": {"vatPercentage": 0},
            "feePricing":             {
               "salePriceWithFeesAndQuantity":                {
                  "currency": "USD",
                  "value": 18.99
               },
               "formattedSalePriceWithFeesAndQuantity": "$18.99"
            },
            "listPriceIncludesTax": "false",
            "msrpPrice": null,
            "formattedMsrpPrice": null
         },
         "inventoryStatus":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/inventory-status",
            "availableQuantity": 0,
            "availableQuantityIsEstimated": "false",
            "productIsInStock": "false",
            "productIsAllowsBackorders": "true",
            "productIsTracked": "true",
            "requestedQuantityAvailable": "false",
            "status": "PRODUCT_INVENTORY_BACKORDERED",
            "statusIsEstimated": "false",
            "expectedInStockDate": null,
            "customStockMessage": "testCustomMessage"
         },
         "addProductToCart":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=product_ID",
            "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=product_ID"
         },
         "purchaseProduct":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/purchase",
         },
         "addProductToWishList": {"uri": "https://api.digitalriver.com/v1/shoppers/me/wish-lists/default?productId=product_ID"}
      }
   ]
}}
			

Response Body Parameters

Field
Data Type
Visibility
Description
addProductToCart link default A link to add a product to a shopping cart. The link is only available for individual products. Th ebaseProduct flag must be set to false. Use the link in a subsequent POST to add the product to the cart. See the Line Items API for more information. 
addProductToWishList link default A link to add a product to a wish list. See the Wish Lists API for more information.
baseProduct
Boolean
default
When true, the product is a base product with (multiple) variations. If true, the product is a base product. You cannot add a base product cannot to a cart; you must get the product's variations. If false, the product is an individual product and an add product to cart link is available in the response body for that product. The baseProduct resource field is also available when expanding the Product Offers API.
categories
link
default
A link to the Categories API.
category
string
default
A class of products. A catalog typically has multiple categories. See Categories API for more information.
companyId
string
default
The company's ID.
customAttributes
collection default
A collection of the custom attributes configured for the resource. Custom attributes are not included with the resource by default. Expanding the customAttributes returns all of the configured attributes.
customAttributes.attribute
string
expand
A specific custom attribute configured for the resource. The attribute consists of a name, type, and their values. Use expand customAttributes.{name} to retrieve a specific custom attribute.
displayableProduct
Boolean
default
When true, the site displays the product.
displayName string default The displayed name of the product.
externalReferenceId
string
default
A unique reference ID for a product on the remote system. See externalReferenceID for more information.  
familyAttributes link default A link to the Products API
id
string
default
The product ID. The ID is assigned automatically when the product is created.
inventoryStatus structured default The inventory information for the product. See the Inventory Status API for more information.
keywords
string
default
A word or phrase that describes the product.
longDescription
string
default
A detailed description of the product.
manufacturerName
string
expand
The name of the product's manufacturer.
manufacturerPartNumber
string
expand
The part number defined by the product's manufacturer.
maximumQuantity
int
expand
Maximum quantity of a product that a shopper can purchase. Quantities are enforced on a per-order basis. Zero or blank indicates no restriction. When getting a product by its ID, the maximumQuantity is returned by default.
minimumQuantity
int
expand
Minimum quantity of a product that a shopper can purchase. Quantities are enforced on a per-order basis. Zero or blank indicates no restriction. When getting a product by its ID, the minimumQuantity is returned by default.
name
string
default
The name of the product.
parentProduct link default A link to the parent Products API. 
pricing structured default The pricing information for the product. See the Pricing API for more information.
productImage
uri
expand
A URI to the image of the product.
productType
string
default
The type of product. The possible values are as follows:
  • PHYSICAL
  • DOWNLOAD
  • OTHER
purchasable
Boolean
default
When true, the shopper can purchase a product. When set to true, products with a false value are not included in product search results.
purchaseProduct link default A link to the Products API.
shortDescription
string
default
A brief description of the product.
sku
string
default
The product stock keeping unit (sku).
thumbnailImage
uri
default
A URI to the thumbnail image of the product.
variations
link
default
A link to a variation of a product in the Products API.