Point-of-Promotions (PoPs)

A PoP (Point-of-Promotion) determines where an offer appears in an online store. Offers use a PoP to visually display an offer. For instance, a PoP can be an interstitial page, banner, or a pop-up window. The PoPs API provides links to the offers associated with a PoP that can be stored with an application for retrieval later. The PoP links can dynamically display offers on a product details page or cart, rather than hard-coding URLs into an application.

Offer Type Filtering

The PoPs API filters the offer types by default. Specifying the offerType=all query parameter in tandem with the expand=all query parameter for a GET shoppers/me/point-of-promotions request returns all pops configured for a site.

The offer types returned by default are as follows:

Related APIs
PoPs APIs
Offer Filter Defaults
Shoppers
shoppers/me/point-of-promotions:
  • Custom bundle
  • Banner
  • Default
  • Feature products
  • Bundling
Products
shoppers/me/products/{id}/pops:
  • Shipping
  • Up-sell
  • Cross-sell
  • Bundling
Carts
shoppers/me/carts/active/pops:
  • All products bundle
  • Cross-sell


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
			
					<pointOfPromotions uri="https://api.digitalriver.com/v1/shoppers/me/carts/active/point-of-promotions">
   <pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/carts/active/point-of-promotions/Interstitial_CrossSell">
      <id>Interstitial_CrossSell</id>
      <offerTypes>Cross-sell</offerTypes>
      <offers uri="https://api.digitalriver.com/v1/shoppers/me/carts/active/point-of-promotions/Interstitial_CrossSell/offers"/>
   </pointOfPromotion>
</pointOfPromotions>
			
					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
			
					<pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/carts/active/point-of-promotions/SiteMerchandising_HomePageStoreSpecials/offers/SiteMerchandising_HomePageStoreSpecials">
   <id>SiteMerchandising_HomePageStoreSpecials</id>
   <offerTypes>FeatureProducts</offerTypes>
   <offers uri="https://api.digitalriver.com/v1/shoppers/me/carts/active/point-of-promotions/SiteMerchandising_HomePageStoreSpecials/offers"/>
</pointOfPromotion>
			
					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
			
					<pointOfPromotions uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions">
   <pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Banner_ShoppingCartLocal">
      <id>Banner_ShoppingCartLocal</id>
      <offerTypes>Default</offerTypes>
      <offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Banner_ShoppingCartLocal/offers"/>
   </pointOfPromotion>
   <pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/PopUp_FirstTimeVisitor">
      <id>PopUp_FirstTimeVisitor</id>
      <offerTypes>Default</offerTypes>
      <offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/PopUp_FirstTimeVisitor/offers"/>
   </pointOfPromotion>
   <pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/PopUp_WaitDontLeave">
      <id>PopUp_WaitDontLeave</id>
      <offerTypes>Default</offerTypes>
      <offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/PopUp_WaitDontLeave/offers"/>
   </pointOfPromotion>
   <pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/SiteMerchandising_HomePageStoreSpecials">
      <id>SiteMerchandising_HomePageStoreSpecials</id>
      <offerTypes>FeatureProducts</offerTypes>
      <offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/SiteMerchandising_HomePageStoreSpecials/offers"/>
   </pointOfPromotion>
   <pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/SiteMerchandising_HomePageTopSellers">
      <id>SiteMerchandising_HomePageTopSellers</id>
      <offerTypes>FeatureProducts</offerTypes>
      <offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/SiteMerchandising_HomePageTopSellers/offers"/>
   </pointOfPromotion>
   <pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Banner_HomePageLocal">
      <id>Banner_HomePageLocal</id>
      <offerTypes>FeatureProducts</offerTypes>
      <offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Banner_HomePageLocal/offers"/>
   </pointOfPromotion>
   <pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/CustomBundle_Eligibility_Promotion">
      <id>CustomBundle_Eligibility_Promotion</id>
      <offerTypes>Custom Bundle</offerTypes>
      <offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/CustomBundle_Eligibility_Promotion/offers"/>
   </pointOfPromotion>
</pointOfPromotions>
			
					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
			
					<pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/SiteMerchandising_HomePageStoreSpecials">
   <id>SiteMerchandising_HomePageStoreSpecials</id>
   <offerTypes>FeatureProducts</offerTypes>
   <offers uri="https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/SiteMerchandising_HomePageStoreSpecials/offers"/>
</pointOfPromotion>
			
					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
			
					<pointOfPromotion uri="https://api.digitalriver.com/v1/shoppers/me/products/99999999/point-of-promotions/SiteMerchandising_HomePageStoreSpecials">
   <id>SiteMerchandising_HomePageStoreSpecials</id>
   <offerTypes>FeatureProducts</offerTypes>
   <offers uri="https://api.digitalriver.com/v1/shoppers/me/products/99999999/point-of-promotions/SiteMerchandising_HomePageStoreSpecials/offers"/>
</pointOfPromotion>
			

Response Body Parameters

Field
Data Type
Visibility
Description
id
string
default
The point-of-promotion ID. The ID is assigned automatically when the point-of-promotion is created.
offerTypes
string expand The offer types available for this point-of-promotion. The following offer types are possible:
  • Bundling
  • Cross-sell
  • Custom Bundle
  • Default
  • FeatureProducts
  • Shipping Individual Product
  • Up-sell
offers
link
default
The offers available for this point-of-promotion. See the Offers API for more information.
pointOfPromotion
link
default
A link to the promotion.
pointOfPromotions
structured
default
The point-of-promotions configured for a site.

Related APIs

The following table lists methods for related APIs that provide point-of-promotions information.

Related APIs
Methods
Offers
GET /shoppers/me/carts/active/point-of-promotions/{popName}/offers
GET /shoppers/me/point-of-promotions/{popName}/offers
GET /shoppers/me/products/{id}/point-of-promotions/{popName}/offers