Sign in
latestOpenAPI 3.0.02026-08-101013821017.9 KB

4b69392f93b9

API Trigger Offer

Trigger offer by cart

Use API to trigger the Order Level or Product Level offer(s). <br> <br> <b>Note</b>: The offer type must be “Promotional URL / External Triggered Offer”.

post/v1/shoppers/me/carts/active (API Trigger Offer)

Query parameters

skipOfferArbitrationstring

Bypass offer arbitration for eligible Always Trigger Offers and Coupon Code offers of the cart. Global Commerce default behavior is to apply best Global Commerce Merchandising offer for shopper. So if there is an offer better than the one you specified, the best offer will be applied. In case unfortunately the best offer is not the one you want, set this parameter True could help you to bypass them. Below are more details the parameter can bypass or not.

  • Always Trigger Offers (Site Level): Bypassed

  • Promotional URL / External Trigger offers (User Level): NOT bypassed (So you can feed in Promotional URL offer ID together with this parameter, to skip the eixsting offers and then apply the one you would like to applied offer in one call.

  • Coupon code (User Level): Bypassed

  • Bundle offers, all product bundle offer, cross-sell offer and custom bundle offer: NOT affected

If you would like to simply bypass all eligible offers to get a clean cart without any discounts, please refer to this API: https://www.digitalriver.com/docs/commerce-api-reference/#tag/Cart-Offers/paths/~1v1~1shoppers~1me~1carts~1active~1eligible-offers/delete

Request body

Example request

{
  "cart": {
    "lineItems": {
      "lineItem": [
        {
          "quantity": 1,
          "product": {
            "id": "5181808200"
          }
        }
      ],
      "appliedProductOffers": {
        "offer": {
          "offerId": "882920011",
          "externalReferenceId": "unique-id",
          "customDescription": "Exclusive on our shop!!!"
        },
        "shippingOffer": {
          "offerId": "882920011",
          "externalReferenceId": "unique-id",
          "customDescription": "Exclusive on our shop!!!"
        }
      }
    },
    "appliedOrderOffers": {
      "offer": {
        "offerId": "100029992",
        "externalReferenceId": "unique-id",
        "customDescription": "Exclusive on our shop!!!"
      },
      "shippingOffer": {
        "offerId": "123111333",
        "externalReferenceId": "unique-id",
        "customDescription": "Exclusive on our shop!!!"
      }
    }
  }
}

Response

Successful response.

OR