Products

The Products API provides access to products and product data. This API returns products across all categories. Use the Products API to:

  • Retrieve all products for a specified category
  • Retrieve all products from the default catalog configured for a site
  • Get a product by ID

For more detailed information about products, including the differences between individual products and base products with variations, see the Understanding Products. To view a diagram and more information about the hierarchical relationship between site, catalogs, categories, and products, see Company Hierarchy Overview.

Methods


					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: application/xml
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<products uri="https://api.digitalriver.com/v1/shoppers/me/products">
   <nextPage uri="https://api.digitalriver.com/v1/shoppers/me/categories/9999999999/products?pageNumber=4&pageSize=1"/>
   <previousPage uri="https://api.digitalriver.com/v1/shoppers/me/categories/9999999999/products?pageNumber=2&pageSize=1"/>
   <product uri="https://api.digitalriver.com/v1/shoppers/me/products/product_ID">
      <displayName>Class VIII Weekly Auto Renewal Subscription</displayName>
      <thumbnailImage>.../images/product/thumbnail/ClassVIIImini.jpg</thumbnailImage>
      <pricing>
         <formattedListPrice>$79.99</formattedListPrice>
         <formattedSalePriceWithQuantity>$0.00</formattedSalePriceWithQuantity>
      </pricing>
      <addProductToCart cartUri="https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=product_ID" uri="https://dispatch-test.digitalriver.com/v1-ci/shoppers/me/carts/active/line-items?productId=product_ID"/>
   </product>
   <totalResults>6</totalResults>
   <totalResultPages>6</totalResultPages>
</products>
			
					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: Mon, 19 Sep 2016 21:41:33 GMT
x-dr-requestid: a7cadde5-d0cd-499e-b6dc-8953fea28099
server: Apache
expires: Wed, 31 Dec 1969 18:00:00 CST
x_request_id: TIME=1474321293502:NODE=gcapp01_gcappsys022009.c022:THREAD=172
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: 20316
			
					{"products": {
   "uri": "https://api.digitalriver.com/v1/shoppers/me/products",
   "product":    [
            {
         "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID",
         "displayName": "$0 Weekly Manual Renewal Subscription",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/ClassVIIImini.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$0.00",
            "formattedSalePriceWithQuantity": "$0.00"
         },
         "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",
         "displayName": "Class I",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/classIThumb_v2.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$19.99",
            "formattedSalePriceWithQuantity": "$18.99"
         },
         "variations":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/variations",
         }
      },
            {
         "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID",
         "displayName": "Class III",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/classIIIThumb_v2.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$39.99",
            "formattedSalePriceWithQuantity": "$38.99"
         },
         "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",
         "displayName": "Class IV",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/classIVThumb_v2.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$49.99",
            "formattedSalePriceWithQuantity": "$48.99"
         },
         "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",
         "displayName": "Class V",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/classVThumb_v2.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$59.99",
            "formattedSalePriceWithQuantity": "$58.99"
         },
         "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",
         "displayName": "Class VI",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/classVIThumb_v2.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$79.99",
            "formattedSalePriceWithQuantity": "$69.99"
         },
         "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",
         "displayName": "Class VIII - Bronze 2011 - Weekly Auto Renewal Subscription",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/ClassVIIImini.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$79.99",
            "formattedSalePriceWithQuantity": "$78.99"
         },
         "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",
         "displayName": "Class VIII - Gold 2011 - Weekly Auto Renewal Subscription",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/ClassVIIImini.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$149.99",
            "formattedSalePriceWithQuantity": "$148.99"
         },
         "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",
         "displayName": "Class VIII - Silver 2011 -  Weekly Auto Renewal Subscription",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/ClassVIIImini.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$99.99",
            "formattedSalePriceWithQuantity": "$98.99"
         },
         "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",
         "displayName": "Class VIII Weekly Auto Renewal Subscription",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/ClassVIIImini.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$79.99",
            "formattedSalePriceWithQuantity": "$0.00"
         },
         "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",
         "displayName": "Class VIII Yearly Manual Renewal Subscription",
         "thumbnailImage": "https://domain_ID.digitalriver.com/path/images/product/thumbnail/ClassVIIImini.jpg",
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$99.99",
            "formattedSalePriceWithQuantity": "$98.99"
         },
         "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",
         "displayName": "Copy of Digital123",
         "thumbnailImage": null,
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$250.00",
            "formattedSalePriceWithQuantity": "$249.00"
         },
         "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/v",
         "displayName": "Gym Subscription gift card",
         "thumbnailImage": null,
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$150.00",
            "formattedSalePriceWithQuantity": "$149.00"
         },
         "addProductToCart":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=product_ID",
            "relation": "https://developers.digitalriver.com/v1/shoppers/LineItemsResource",
         },
         "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",
         "displayName": "Harry Potter book subscription",
         "thumbnailImage": null,
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$100.00",
            "formattedSalePriceWithQuantity": "$99.00"
         },
         "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",
         "displayName": "Monthly subscription fitness book",
         "thumbnailImage": null,
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$10.00",
            "formattedSalePriceWithQuantity": "$9.00"
         },
         "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",
         "displayName": "test pre-order",
         "thumbnailImage": null,
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$29.95",
            "formattedSalePriceWithQuantity": "$28.95"
         },
         "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/250571100/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",
         "displayName": "Test Sub",
         "thumbnailImage": null,
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$1.00",
            "formattedSalePriceWithQuantity": "$0.00"
         },
         "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=274831300"}
      },
            {
         "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID",
         "displayName": "weight gainer",
         "thumbnailImage": null,
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$10.00",
            "formattedSalePriceWithQuantity": "$9.00"
         },
         "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",
         "displayName": "Writer license subscription",
         "thumbnailImage": null,
         "pricing":          {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/product_ID/pricing",
            "formattedListPrice": "$5.00",
            "formattedSalePriceWithQuantity": "$4.00"
         },
         "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"}
      }
   ],
   "totalResults": 19,
   "totalResultPages": 1
}}
			
					Host: api.digitalriver.com
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Accept: application/json
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					{"product": {
   "uri": "https://api.digitalriver.com/v1/shoppers/me/products/55555555",
   "relation": "https://developers.digitalriver.com/v1/shoppers/ProductsResource",
   "parentProduct":    {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/88888888",
      "relation": "https://developers.digitalriver.com/v1/shoppers/ProductsResource"
   },
   "categories":    {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/55555555/categories",
      "relation": "https://developers.digitalriver.com/v1/shoppers/CategoriesResource"
   },
   "familyAttributes":    {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/55555555/family-attributes",
      "relation": "https://developers.digitalriver.com/v1/shoppers/ProductsResource"
   },
   "id": 55555555,
   "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": null,
   "companyId": "demosft3",
   "displayableProduct": "true",
   "purchasable": "true",
   "manufacturerName": null,
   "manufacturerPartNumber": null,
   "minimumQuantity": null,
   "maximumQuantity": null,
   "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft3/images/product/thumbnail/classIThumb.jpg",
   "productImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft3/images/product/detail/classIBox.jpg",
   "keywords": null,
   "baseProduct": "false",
   "customAttributes": {"attribute":    [
            {
         "name": "displayFinancePricing",
         "type": "Boolean",
         "value": "false"
      },
            {
         "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": "applicationFile",
         "type": "String",
         "value": "WaterLilies.jpg"
      },
            {
         "name": "numberOfIPAddresses",
         "type": "Integer",
         "value": "10"
      },
            {
         "name": "timeFrame",
         "type": "Integer",
         "value": "30"
      },
            {
         "name": "points",
         "type": "Integer",
         "value": "1"
      },
            {
         "name": "financeLenderID",
         "type": "String",
         "value": "API1"
      },
            {
         "name": "fileSize",
         "type": "Integer",
         "value": "82"
      },
            {
         "name": "downloadType",
         "type": "String",
         "value": "HTTP"
      },
            {
         "name": "fileSizeValidatedDate",
         "type": "Date",
         "value": "Thu Sep 13 14:49:28 CDT 2007"
      },
            {
         "name": "fileOnBackupMedia",
         "type": "Boolean",
         "value": "true"
      },
            {
         "name": "originalIsViewable",
         "type": "Boolean",
         "value": "true"
      },
            {
         "name": "downloadAdapter",
         "type": "String",
         "value": "com.digitalriver.downloads.adapters.DRHDownloadAdapter"
      },
            {
         "name": "financeTermCode",
         "type": "String",
         "value": "FAFB0CC6D-EAA1-7E77-4675-1F8E040B2CFB"
      }
   ]},
   "financing":    {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/55555555/financing",
      "financingTerm": [      {
         "id": 50010080,
         "totalRepayable":          {
            "currency": "USD",
            "value": 7.6
         },
         "formattedTotalRepayable": "$7.60",
         "creditAmount":          {
            "currency": "USD",
            "value": 7.2
         },
         "formattedCreditAmount": "$7.20",
         "monthlyPaymentAmount":          {
            "currency": "USD",
            "value": 0.64
         },
         "formattedMonthlyPaymentAmount": "$0.64",
         "durationInMonths": 12,
         "interestRatePct": 0.099,
         "interestRatePctForDisplay": 9.9,
         "description": "9.9% for 12 months"
      }]
   },
   "pricing":    {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/55555555/pricing",
      "listPrice":       {
         "currency": "USD",
         "value": 8
      },
      "listPriceWithQuantity":       {
         "currency": "USD",
         "value": 8
      },
      "salePriceWithQuantity":       {
         "currency": "USD",
         "value": 7.2
      },
      "formattedListPrice": "$8.00",
      "formattedListPriceWithQuantity": "$8.00",
      "formattedSalePriceWithQuantity": "$7.20",
      "totalDiscountWithQuantity":       {
         "currency": "USD",
         "value": 0.8
      },
      "formattedTotalDiscountWithQuantity": "$0.80",
      "discountDescription": "10%",
      "tax": {"vatPercentage": 0},
      "feePricing":       {
         "salePriceWithFeesAndQuantity":          {
            "currency": "USD",
            "value": 7.2
         },
         "formattedSalePriceWithFeesAndQuantity": "$7.20"
      },
      "listPriceIncludesTax": "false",
      "msrpPrice": null,
      "formattedMsrpPrice": null,
      "volumePricing":       {
         "uri": "https://api.digitalriver.com/v1/shoppers/me/products/55555555/pricing/volume-pricing",
         "tier":          [
                        {
               "from": 1,
               "to": 5,
               "pricing":                {
                  "listPrice":                   {
                     "currency": "USD",
                     "value": 8
                  },
                  "listPriceWithQuantity":                   {
                     "currency": "USD",
                     "value": 8
                  },
                  "salePriceWithQuantity":                   {
                     "currency": "USD",
                     "value": 8
                  },
                  "formattedListPrice": "$8.00",
                  "formattedListPriceWithQuantity": "$8.00",
                  "formattedSalePriceWithQuantity": "$8.00",
                  "totalDiscountWithQuantity":                   {
                     "currency": "USD",
                     "value": 0
                  },
                  "formattedTotalDiscountWithQuantity": "$0.00",
                  "discountDescription": null,
                  "feePricing":                   {
                     "salePriceWithFeesAndQuantity":                      {
                        "currency": "USD",
                        "value": 8
                     },
                     "formattedSalePriceWithFeesAndQuantity": "$8.00"
                  },
                  "listPriceIncludesTax": "false",
                  "msrpPrice": null,
                  "formattedMsrpPrice": null
               }
            },
                        {
               "from": 6,
               "to": 10,
               "pricing":                {
                  "listPrice":                   {
                     "currency": "USD",
                     "value": 7
                  },
                  "listPriceWithQuantity":                   {
                     "currency": "USD",
                     "value": 7
                  },
                  "salePriceWithQuantity":                   {
                     "currency": "USD",
                     "value": 7
                  },
                  "formattedListPrice": "$7.00",
                  "formattedListPriceWithQuantity": "$7.00",
                  "formattedSalePriceWithQuantity": "$7.00",
                  "totalDiscountWithQuantity":                   {
                     "currency": "USD",
                     "value": 0
                  },
                  "formattedTotalDiscountWithQuantity": "$0.00",
                  "discountDescription": null,
                  "feePricing":                   {
                     "salePriceWithFeesAndQuantity":                      {
                        "currency": "USD",
                        "value": 7
                     },
                     "formattedSalePriceWithFeesAndQuantity": "$7.00"
                  },
                  "listPriceIncludesTax": "false",
                  "msrpPrice": null,
                  "formattedMsrpPrice": null
               }
            },
                        {
               "from": 11,
               "to": 15,
               "pricing":                {
                  "listPrice":                   {
                     "currency": "USD",
                     "value": 6
                  },
                  "listPriceWithQuantity":                   {
                     "currency": "USD",
                     "value": 6
                  },
                  "salePriceWithQuantity":                   {
                     "currency": "USD",
                     "value": 6
                  },
                  "formattedListPrice": "$6.00",
                  "formattedListPriceWithQuantity": "$6.00",
                  "formattedSalePriceWithQuantity": "$6.00",
                  "totalDiscountWithQuantity":                   {
                     "currency": "USD",
                     "value": 0
                  },
                  "formattedTotalDiscountWithQuantity": "$0.00",
                  "discountDescription": null,
                  "feePricing":                   {
                     "salePriceWithFeesAndQuantity":                      {
                        "currency": "USD",
                        "value": 6
                     },
                     "formattedSalePriceWithFeesAndQuantity": "$6.00"
                  },
                  "listPriceIncludesTax": "false",
                  "msrpPrice": null,
                  "formattedMsrpPrice": null
               }
            },
                        {
               "from": 16,
               "to": null,
               "pricing":                {
                  "listPrice":                   {
                     "currency": "USD",
                     "value": 5
                  },
                  "listPriceWithQuantity":                   {
                     "currency": "USD",
                     "value": 5
                  },
                  "salePriceWithQuantity":                   {
                     "currency": "USD",
                     "value": 5
                  },
                  "formattedListPrice": "$5.00",
                  "formattedListPriceWithQuantity": "$5.00",
                  "formattedSalePriceWithQuantity": "$5.00",
                  "totalDiscountWithQuantity":                   {
                     "currency": "USD",
                     "value": 0
                  },
                  "formattedTotalDiscountWithQuantity": "$0.00",
                  "discountDescription": null,
                  "feePricing":                   {
                     "salePriceWithFeesAndQuantity":                      {
                        "currency": "USD",
                        "value": 5
                     },
                     "formattedSalePriceWithFeesAndQuantity": "$5.00"
                  },
                  "listPriceIncludesTax": "false",
                  "msrpPrice": null,
                  "formattedMsrpPrice": null
               }
            }
         ],
         "formattedSalesPriceRange": "$5.00-$8.00"
      }
   },
   "inventoryStatus":    {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/55555555/inventory-status",
      "relation": "https://developers.digitalriver.com/v1/shoppers/InventoryStatusResource",
      "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=55555555",
      "relation": "https://developers.digitalriver.com/v1/shoppers/LineItemsResource",
      "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=55555555"
   }
}}
			

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. The baseProduct flag must be set to false. Use the link in a subsequent POST to add the product to the cart. For more information, see the Line Items API.
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.You cannot add a base product cannot to a cart; you must get the product's variations. When 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.
billingAddress
link
default
The billing address for the order. See the Addresses API and Fields Used as Keys for more information.
categories
link
default
A link to the Categories API.
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.  
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.
financing
structured
expand
The financing information for the order. See the Financing API for more information.
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
expand
The pricing information for the order. 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 sku (stock keeping unit).
thumbnailImage
uri
default
A URI to the thumbnail image of the product.

Related APIs

The following table lists methods for related APIs that provide product information.

Related APIs
Methods
Categories
GET /shoppers/me/products/{id}/categories 
Financing GET /shoppers/me/product/{id}/financing
Inventory Status
GET /shoppers/me/products/inventory-status 
GET /shoppers/me/products/{id}/inventory-status 
Offers
GET /shoppers/me/products/{id{/point-of-promotions/{popName}/offers 
Point-of-Promotions (PoPs)
GET /shoppers/me/products/{id}/point-of-promotions 
GET /shoppers/me/products/{id}/point-of-promotions/{popName} 
Pricing
GET /shoppers/me/products/{id}/pricing 
Product Variations
GET /shoppers/me/products/{id}/variations 
Purchase
POST /shoppers/me/products/{id}/purchase 
Volume Pricing
GET /shoppers/me/products/{id}/pricing/volume-pricing