How to use point of promotions (POPs)

Understand how to use POPs.

The document describes configuring Points of Promotion (POP) using the Commerce APIs to display promotional offers on an online store. POPs can appear as interstitial pages, banners, homepage images, or pop-up windows. Offers such as shipping discounts, bundles, and buy-one-get-one-free deals can be automatically applied to a cart. An example provided demonstrates fetching offers from a specific promotion point (Home_topSeller) using a GET request, detailing the response structure, which includes multiple offers with URLs for additional product information. It facilitates a dynamic and efficient display of relevant offers to shoppers.

You can configure the offer's POP when you configure the offer in Global Commerce or programmatically. Offers retrieved for a cart using the Offers resource must be POP-driven. Providing a POP when getting offers for a shopper or products is now optional. The system automatically applies the following offers to a cart:

• Certain offers without POPs, such as shipping offers

• Discounts

• Bundles.

• Buy M, Get N

The example below demonstrates how to use the Commerce APIs to retrieve offers for a shopper based on their current point of promotion (POP). In this case, the GET request fetches offers from the Home_topSeller promotion point. The 200 OK response includes multiple offers, each containing a name and a URI for product offers, allowing you to fetch further details if needed. It helps dynamically display relevant offers to the shopper without requiring additional API calls when they add items to the cart.

cURL

curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers' \
--header 'authorization: bearer ***\
...

200 OK response

{
	"offers": {
		"offer": [
			{
				"name": "Home_topSeller_1",
				"productOffers": {
					"_uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID/product-offers"
				},
				"_uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID"
			},
			{
				"name": "Home_topSeller_2",
				"productOffers": {
					"_uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID/product-offers"
				},
				"_uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID"
			},
			{
				"name": "Home_topSeller_3",
				"productOffers": {
					"_uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID/product-offers"
				},
				"_uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID"
			},
			{
				"name": "Home_topSeller_4",
				"productOffers": {
					"_uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID/product-offers"
				},
				"_uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers/offer_ID"
			}
		],
		"_uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Home_topSeller/offers"
	}
}

You do not need to send additional API calls to get these offers when a shopper adds products to a cart.

You cannot use the Offers resource to retrieve coupon-related offers. However, you can apply a coupon or promo coupon to a cart using the POST shoppers/me/carts/active resource method in the Carts API. When you update your cart, the coupon discount will be applied automatically. If you want to know what coupon offer the shopper applied to the cart, you can easily find it.

The Offers resource returns the configured attributes for an offer. The product offer contains offer-specific information on the product, including the offer-specific price of the product. You can apply the Offers and Product Offers resources to a product, cart, or shopper. Feature product offers, such as banners, are specific to a shopper. Shipping and candy rack offers are particular to a cart, and bundled parent-child product offers are specific to a product.

To retrieve all available offers for a shopper, product, or cart resource respectively, use the following resources:

• GET v1/shoppers/me/point-of-promotions/{popName}/offers

• GET v1/shoppers/me/products/{productId}/point-of-promotions/{popName}/offers

• GET v1/shoppers/me/carts/active/point-of-promotions/{popName}/offers

• GET v1/shoppers/me/carts/active/applied-offers

The popName and ID originates in Digital River.

The system applies offers to a cart—it does not apply offers to a shopper. The API applies offers to the line items within a cart. Coupon code limits may apply to a shopper if you configure a coupon code offer in Digital River to limit the code to one per shopper.

When you configure multiple offers for a product, the offer that provides the greatest discount (the lowest price) for an order takes precedence. Also, you can apply an order discount to a product discount for a line item. For more information on configuring offers and offer precedence, refer to the online help in Global Commerce.

Global Commerce automatically applies shipping offers to products added to a cart when they meet the offer criteria and do not require API calls. It also automatically applies discounts, bundles, and "buy M, get N" offers.

See POP offers for more information.