Sign in
latestOpenAPI 3.0.02026-08-101013821017.9 KB

4b69392f93b9

Cart Offers

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.

Response

Successful response.

Example response

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