Product Offers

The Product Offers API provides access to product offer information. A product offer promotes or provides a discount for one or more products in a store. Use this API to get a specific product offer or all product offers, including list price and sale price of a product associated with an offer. For more information about offer types and behaviors with respect to the Digital River APIs, see the Understanding Offers.

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
			
					{"productOffers": {
   "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/offers/offer_ID/product-offers",
   "productOffer":    [
            {
         "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/offers/offer_ID/product-offers/product_ID",
         "id": product_ID,
         "product":          {
            "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/products/product_ID",
            "displayName": "Class III",
            "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIIIThumb_v2.jpg"
         },
         "pricing":          {
            "listPrice":             {
               "currency": "USD",
               "value": 39.99
            },
            "salePriceWithQuantity":             {
               "currency": "USD",
               "value": 38.99
            },
            "formattedListPrice": "$39.99",
            "formattedSalePriceWithQuantity": "$38.99"
         }
      },
            {
         "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/offers/offer_ID/product-offers/product_ID",
         "id": product_ID,
         "product":          {
            "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/products/product_ID",
            "displayName": "Class VI",
            "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classVIThumb_v2.jpg"
         },
         "pricing":          {
            "listPrice":             {
               "currency": "USD",
               "value": 79.99
            },
            "salePriceWithQuantity":             {
               "currency": "USD",
               "value": 78.99
            },
            "formattedListPrice": "$79.99",
            "formattedSalePriceWithQuantity": "$78.99"
         }
      },
            {
         "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/offers/offer_ID/product-offers/product_ID",
         "id": 64578500,
         "product":          {
            "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/products/product_ID",
            "displayName": "Class I",
            "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIThumb.jpg"
         },
         "pricing":          {
            "listPrice":             {
               "currency": "USD",
               "value": 19.99
            },
            "salePriceWithQuantity":             {
               "currency": "USD",
               "value": 17.99
            },
            "formattedListPrice": "$19.99",
            "formattedSalePriceWithQuantity": "$17.99"
         }
      }
   ]
}}
			
					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
			
					{"productOffer": {
   "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/offers/offer_ID/product-offers/product_ID",
   "id": product_ID,
   "product":    {
      "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/products/product_UD",
      "displayName": "Class I",
      "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIThumb.jpg"
   },
   "addProductToCart":    {
      "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=product_ID&offerId=154344709",
      "cartUri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active?productId=product_ID&offerId=offer_ID"
   },
   "salesPitch": "For testing purposes",
   "image": "https://drh-sys-ora.img.digitalriver.com/Storefront/Site/demosft1/images/promo/business_header.gif",
   "pricing":    {
      "listPrice":       {
         "currency": "USD",
         "value": 19.99
      },
      "salePriceWithQuantity":       {
         "currency": "USD",
         "value": 17.99
      },
      "formattedListPrice": "$19.99",
      "formattedSalePriceWithQuantity": "$17.99"
   }
}}
			

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.
id
string
default
The product offer ID. The ID is assigned automatically when the product offer is created.
image
uri
default
The product offer image displayed to a shopper.
pricing
structured
default
The pricing information for the order. See the Pricing API for more information.
product
resource
default
The product for the product offer. See the Product API for more information.
product.displayName string default The displayed name of the product.
product.thumnailImage link default A URI to the thumbnail image of the product.
salesPitch
string
default
The sales pitch of the product offer displayed to the shopper.