Retrieve offers

Get an offer by ID

Retrieve an offer by specifying the offer's ID in the {offerId} URI path parameter. This method returns the offer associated with the product identifier.

GEThttps://api.digitalriver.com/v1/shoppers/me/offers/{offerId}

Path parameters

offerId*string

Provide the offer's identifier.

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultOffer (object)ExpandedOffer (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/offers/{offerId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "offer": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
    "id": 154344709,
    "name": "Home Page Security & Backup Recovery Features",
    "policyName": "text",
    "type": "FeatureProducts",
    "image": "https://drh1.img.digitalriver.com/DRHM/Storefront/Site/demosft1/images/promo/security_header.gif",
    "trigger": "Always Triggered",
    "salesPitch": [
      "[\"Header Message\",\"Footer Message\",\"Sales Pitch Extra Info\",\"Sales Pitch Extra Info 2\"]"
    ],
    "productOffers": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers",
      "productOffer": [
        {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers/64358400",
          "id": 64358400,
          "product": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358400",
            "displayName": "Class III",
            "thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/Storefront/Company/demosft1/images/product/thumbnail/classIIIThumb_v2.jpg"
          },
          "pricing": {
            "listPrice": {
              "currency": "USD",
              "value": "19.99"
            },
            "salePriceWithQuantity": {
              "currency": "USD",
              "value": "19.99"
            },
            "formattedListPrice": "$39.99",
            "formattedSalePriceWithQuantity": "$38.99",
            "listPriceIncludesTax": "false"
          }
        }
      ]
    }
  }
}

Get the product for the offer

Retrieve an offer for a specific product by specifying the offer's ID in the {offerId} URI path parameter and product ID in {productOfferId}.

GEThttps://api.digitalriver.com/v1/shoppers/me/offers/{offerId}/product-offers/{productOfferId}

Path parameters

offerId*string

Provide the offer's identifier to limit the response to the products that are eligible for the offer.

productOfferId*string

Provide the product identifier. You must use the productId parameter with the offerId parameter. When you use these two parameters together, only the specified product appears in the response. You can only provide one product identifier. Multiple product identifiers are not supported.

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultProductOffer (object)ExpandedProductOffer (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/offers/{offerId}/product-offers/{productOfferId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "productOffer": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers/64358400",
    "id": 64358400,
    "product": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358400",
      "displayName": "Class III",
      "thumbnailImage": "https://drh-sys-ora.img.digitalriver.com/Storefront/Company/demosft1/images/product/thumbnail/classIIIThumb_v2.jpg"
    },
    "addProductToCart": {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=64578500&offerId=154344709",
      "cartUri": "https://api.digitalriver.com/v1/shoppers/me/carts/active?productId=64578500&offerId=154344709"
    },
    "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": "19.99"
      },
      "formattedListPrice": "$39.99",
      "formattedSalePriceWithQuantity": "$38.99",
      "listPriceIncludesTax": "false"
    }
  }
}

Retrieve all offers for a product

To get all the available deals for a specific product, you must provide the product ID in the {productId} URI path parameter. The response will include the following types of offers:

• All Always Triggered offers
• All Promotional URL or External Triggered Offers, whether they are triggered or not
• All Coupon Code Offers, whether they are triggered or not

GEThttps://api.digitalriver.com/v1/shoppers/me/products/{productId}/offers

Path parameters

productId*string

Provide the product identifier.

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultOffers (object)ExpandedOffers (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/products/{productId}/offers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "offers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/offers",
    "offer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
        "name": "Home Page Security & Backup Recovery Features",
        "trigger": "Always Triggered",
        "productOffers": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers"
        }
      }
    ],
    "totalResults": 1,
    "totalResultPages": 1
  }
}

Retrieve all offers for a given POP for a product

If you want to find all the offers available for a particular product during a specific point of promotion (POP), you can follow these steps:

1. Enter the product ID in the first {productId} URI path parameter.
2. Enter the name of the point-of-promotion (POP) in the second {popName} URI path parameter.

The offers you'll receive will include all Always Triggered offers and all Promotional URL / External Triggered Offers, whether they were triggered or not.

However, note that Coupon Code offers will not be included in the retrieved offers, even if they were triggered.

Note: You can also get all the offers for a product without providing a POP. For more information, see GET shoppers/me/offers.

GEThttps://api.digitalriver.com/v1/shoppers/me/products/{productId}/point-of-promotions/{popName}/offers

Path parameters

productId*string

Provide the product identifier.

popName*string

Provide the name of the point of promotion (POP).

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultOffers (object)ExpandedOffers (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/products/{productId}/point-of-promotions/{popName}/offers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "offers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/offers",
    "offer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
        "name": "Home Page Security & Backup Recovery Features",
        "trigger": "Always Triggered",
        "productOffers": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers"
        }
      }
    ],
    "totalResults": 1,
    "totalResultPages": 1
  }
}

Retrieve all offers of a specific POP

To access all offers associated with a particular point of promotion (POP), you need to enter the name of the POP in the {popName} URI path.

The retrieved offers will include the All Always Triggered offers and All Promotional URL/External Triggered Offers, even if they were not triggered.

However, note that Coupon Code offers will not be included in the retrieved offers, even if they were triggered.

Note: You can also get all offers for a product without providing a POP. For more information, see GET shoppers/me/offers.

GEThttps://api.digitalriver.com/v1/shoppers/me/point-of-promotions/{popName}/offers

Path parameters

popName*string

Provide the name of the point of Promotion (POP).

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultPOPOffers (object)ExpandedPOPOffers (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/{popName}/offers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "offers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/SiteMerchandising_HomePageStoreSpecials/offers",
    "offer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
        "name": "Home Page Security & Backup Recovery Features",
        "trigger": "Always Triggered",
        "productOffers": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers"
        }
      }
    ]
  }
}

Retrieve all offers

Retrieve all triggered offers, including Always Triggered offers, User Triggered (Promotional URL / External Triggered Offers), and User Triggered (Coupon Code).

GEThttps://api.digitalriver.com/v1/shoppers/me/offers

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultOffers (object)ExpandedOffers (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/offers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "offers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/offers",
    "offer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709",
        "name": "Home Page Security & Backup Recovery Features",
        "trigger": "Always Triggered",
        "productOffers": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers"
        }
      }
    ],
    "totalResults": 1,
    "totalResultPages": 1
  }
}

Get all products for the offer

To get all products for the specific offer, specify the ID of the offer in the {offerId} URI path parameter.

GEThttps://api.digitalriver.com/v1/shoppers/me/offers/{offerId}/product-offers

Path parameters

offerId*string

Provide the offer's identifier to limit the response to the products that are eligible for the offer.

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultProductOffers (object)ExpandedProductOffers (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/offers/{offerId}/product-offers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "productOffers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers",
    "productOffer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/offers/154344709/product-offers/64358400",
        "id": 64358400,
        "product": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/products/64358400",
          "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": "19.99"
          },
          "salePriceWithQuantity": {
            "currency": "USD",
            "value": "19.99"
          },
          "formattedListPrice": "$39.99",
          "formattedSalePriceWithQuantity": "$38.99",
          "listPriceIncludesTax": "false"
        }
      }
    ]
  }
}