Offers 

An offer is a promotion or discount intended to entice shoppers to purchase from a store.The Offers API provides access to offers. Use the Offers API to get a specific offer by its identifier or retrieve all offers for a shopper, product, or cart. For more information about offer types and behaviors with respect to the Digital River APIs, see the Understanding Offers. If you want to retrieve all product offers, use the Product Offers API.

Methods


					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: */*
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/CandyRack_ShoppingCart/offers">
   <offer uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/CandyRack_ShoppingCart/offers/offers_ID">
       <id>offers_ID</id>
     <productOffers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/CandyRack_ShoppingCart/offers/offers_ID/product-offers"/>
   </offer>
</offers>
			
					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
			
					{"offer": {
   "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/offers/999999999",
   "id": 999999999,
   "name": "Home Page Security & Backup Recovery Features",
   "policyName": null,
   "type": "FeatureProducts",
   "image": "https://drh1.img.digitalriver.com/DRHM/Storefront/Site/demosft1/images/promo/security_header.gif",
   "salesPitch":    [
      "Les dispositifs de ce mois",
      "<a href=\"http://store.digitalriver.com/store/demosft1/DisplayCategoryProductListPage/categoryID.6912800\" class=\"seeAllLink\">See All Security downlads<\/a><br />\n<a href=\"http://store.digitalriver.com/store/demosft1/DisplayCategoryProductListPage/categoryID.6912600\" class=\"seeAllLink\">See All Backup Recovery downloads<\/a><br />",
      "",
      ""
   ],
   "productOffers":    {
      "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/offers/999999999/product-offers",
      "productOffer":       [
                  {
            "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/offers/999999999/product-offers/product_ID",
            "id": product_ID,
            "product":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID",
               "displayName": "Class III",
               "thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/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.digitalriver.com/v1/shoppers/me/offers/999999999/product-offers/product_ID",
            "id": product_ID,
            "product":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID",
               "relation": "https://developers.digitalriver.com/v1/shoppers/ProductsResource",
               "displayName": "Class VI",
               "thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/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.digitalriver.com/v1/shoppers/me/offers/999999999/product-offers/product_ID",
            "id": product_ID,
            "product":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID",
               "displayName": "Class I",
               "thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/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"
            }
         }
      ]
   },
   "categoryOffers": {},
   "offerBundleGroups": {}
}}
			
					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: */*
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers">
   <offer uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID">
      <name>Home_topSeller_1</name>
      <productOffers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID/product-offers"/>
   </offer>
   <offer uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID">
      <name>Home_topSeller_2</name>
      <productOffers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID/product-offers"/>
   </offer>
   <offer uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID">
      <name>Home_topSeller_3</name>
      <productOffers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID/product-offers"/>
   </offer>
   <offer uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID">
      <name>Home_topSeller_4</name>
      <productOffers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID/product-offers"/>
   </offer>
</offers>
			
					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: */*
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/CandyRack_ShoppingCart/offers">
   <offer uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/CandyRack_ShoppingCart/offers/offer_ID">
      <productOffers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/CandyRack_ShoppingCart/offers/offer_ID/product-offers"/>
   </offer>
</offers>
			

Response Body Parameters

Field
Data Type
Visibility
Description
categoryOffers
collection
default
A collection of category offers. See the Categories API for more information.
id
string
default
The offer ID. The ID is assigned automatically when the offer is created. The ID may appear to a shopper who is redeeming an offer by clicking a link, banner ad, or other mechanisms that trigger an offer.
image
uri
default
The image of the offer to display to the shopper.
name
string
default
The name of the offer. Offer names are not seen by shoppers.
productOffers
collection
default
A collection of product offers. See the Product Offers API for more information.
offer
collection
default
A specific offer for a product.
offers
collection
default
A collection of offers for a specific product.
offerBundleGroups
collection
default
A collection of offer bundle groups.
policyName
string
default
The name of the policy.
salesPitch
string
default
The offer sales pitch displayed to the shopper, such as "Buy one, get one free."
type
string
default
The type of the offer.

Related APIs

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

Related APIs
Methods
Category Offers
GET /shoppers/me/offers/{id}/category-offers
Product Offers GET /shoppers/me/offers/{id}/product-offers
GET /shoppers/me/offers/{id}/product-offers/{id}