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, specify a popName "CandyRack_ShoppingCart", a 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 does not include:

• Coupon Code offers, even the coupon code offer has been triggered

get

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

Path parameters

popNamestringrequired

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

Query parameters

tokenstring

Provide the authorized or anonymous token for a shopper.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

formatstring

Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.digitalriver.com/v1/shoppers/me/carts/active/point-of-promotions/{popName}/offers'

200

401

200

{
  "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"
        }
      }
    ]
  }
}

Successful response.

Retrieve cart applied offers

Retrieve all offers applied to the cart. A cart can have below offers be applied:

• Order Level Discount – Discounts the total costs for an order. When the cart has multiple Order Level Discount offers, only the one that provide the best discount to the shopper is used.
• Order Level Shipping Discount – Discounts shipping costs for an entire order. When the cart has multiple Order Level Shipping Discount offers, only the one that provide the best discount to the shopper is used.
• Item Level Discount – Discounts costs associated with a single line item (product). When the item has multiple Item Level Discount offers, 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 offers.
• 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.

get

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

Query parameters

apiKeystring

The client identifier used to authorize the request. You must specify either an apiKey or token.

tokenstring

The customer's ID. You must specify either an apiKey or token.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.digitalriver.com/v1/shoppers/me/carts/active/applied-offers'

200

200

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

Successful response.

Delete specific cart applied offer

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.

delete

/v1/shoppers/me/carts/active/applied-offers/{offerId}

Path parameters

offerIdstringrequired

Offer ID.

Query parameters

tokenstring

Authorized or anonymous token for a customer.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/v1/shoppers/me/carts/active/applied-offers/{offerId}'

204

404

409

204

No body

Successful response.

Delete cart 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

delete

/v1/shoppers/me/carts/active/eligible-offers

Query parameters

tokenstring

Authorized or anonymous token for a customer.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/v1/shoppers/me/carts/active/eligible-offers'

204

204

No body

Successful response.