Manage cart offers

Retrieve all POP offers for a cart

Retrieve all offers for a cart with the specified point-of-promotion in the {popName} URI path parameter. For example, provide "CandyRack_ShoppingCart" as the popName. The cart-specific offer returned by this method is a candy rack offer.

The retrieved offers include:

• Trigger type is Always Triggered offers
• Trigger type is User Triggered (Promotional URL / External Triggered Offers) and has been triggered

The retrieved offers do not include Coupon Code offers, even if the request triggered a coupon code offer.

GEThttps://api.digitalriver.com/v1/shoppers/me/carts/active/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

offersobject

Request

JavaScriptCurlPython

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

Response

200401

{
  "offers": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/point-of-promotions/Interstitial_CrossSell/offers",
    "offer": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Interstitial_CrossSell/offers/19351557308",
        "id": 19351557308,
        "productOffers": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/point-of-promotions/Interstitial_CrossSell/offers/19351557308/product-offers"
        }
      }
    ]
  }
}

Retrieve the cart's applied offers

Retrieve all offers applied to the cart. You can apply the following offers to the cart:

• Order Level Discount – This offer is designed to efficiently discount the total costs for an order. When the cart has multiple Order Level Discount offers, only the one that provides the best discount to the shopper is used, ensuring optimal savings.
• Order Level Shipping Discount – Discounts shipping costs for an entire order. When the cart has multiple Order Level Shipping Discounts, the system determines the best discount based on factors such as the discount amount, the order's total weight, and the shopper's location. The request only uses the one that provides the best discount to the shopper.
• Item Level Discount – Discounts costs associated with a single line item (product). When the item has multiple Item Level Discounts, only the one that provide the best discount to the shopper is used. If there are multiple line items in the cart, every line item can have its own best Item Level Discount.
• Product Level Shipping Discount – Discounts shipping costs for a specific product in the order. When the product has multiple Product Level Shipping Discount offers, only the one that provide the best discount to the shopper is used. If there are multiple products in the cart, every product can have its own best Product Level Shipping Discount offers.

GEThttps://api.digitalriver.com/v1/shoppers/me/carts/active/applied-offers

Query parameters

Response

200

Successful response.

Body

application/json

appliedOffersarray of AppliedOffer (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "appliedOffers": [
    {
      "id": "19383398500",
      "cartDescription": "Description of the cart",
      "appliedCouponCode": "CouponCodeExample",
      "appliedTo": {
        "appliedLevel": "Product(s) (Line Item)",
        "cartId": "33478770190",
        "lineItemId": "15217540193"
      },
      "type": "Discount"
    }
  ]
}

Delete a specific cart applied offer from the cart

Delete the specific offer applied to the customer's cart. If the offer type of the specific offer is bundle, the line item group will be break and the line item may be removed base on the bundle type.

DELETEhttps://api.digitalriver.com/v1/shoppers/me/carts/active/applied-offers/{offerId}

Path parameters

offerId*string

Offer ID.

Query parameters

Response

204404409

Successful response.

Request

JavaScriptCurlPython

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

Response

404409

{
  "errors": [
    {
      "code": "resource-not-found",
      "subcode": "offer-not-found",
      "description": "Provided offer not applied to the cart."
    }
  ]
}

Delete the cart's eligible offers

Reset the promotions of the cart, clear all discounts and offers, including:

• Always Trigger Offers (Site Level)
• Promotional URL / External Trigger offers (User Level)
• Coupon code (User Level)
• Bundle offers, all product bundle offers, cross-sell offers and custom bundle offers

DELETEhttps://api.digitalriver.com/v1/shoppers/me/carts/active/eligible-offers

Query parameters

Response

204

Successful response.

Request

JavaScriptCurlPython

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