Overriding a promotional URL offer discount

Learn how to override a promotional URL offer discount.

This feature allows you to trigger the Promotional URL Offer type using a Commerce API and override the discount pass-in through an API from Global Commerce Merchandising offers when the Skip Offer Arbitration flag is enabled.

High-level workflow use case

The user applies an offer ID or O-ERID to a cart to trigger Global Commerce's preconfigured offer behavior.
The client sets up a Promotional URL triggered offer in Global Commerce. A call to the Cart resource triggers the offer and applies the discount offer with the offer ID or ERID included in the call.
The system triggers this offer, then applies the new override discount to it. The term "Override or Overriden" specified here indicates the replacement of Global Commerce's Offer Discount setting.
The shopper can see the correct discount applied to the cart.
The shopper successfully submits the order.
The user triggers the Get Order resource (GET /v1/shoppers/me/orders/[orderId]).
The user can see the override description.

The schema for skip offer arbitration via the Purchase resource

This schema applies to a skip offer arbitration.

POST /shoppers/me/carts/active/line-items
POST /shoppers/me/carts/active/line-items/{id}

{
   "lineItems": {
      "lineItem": {
         "quantity": "1",
         "product": {
            "id": "4878374"
         }
      },
       "appliedProductOffers": {
          "offer": {
             "offerId": "23456",
             "customDescription": "Exclusive on our shop!!!",
             "overrideDiscount": [
                {
                   "externalReferenceId": "123",
                   "discount": 50,
                   "discountType": "amountOff"
                },
                {
                   "productId": "456",
                   "discount": 60,
                   "discountType": "amountOff"
                }
             ]
          },
          "shippingOffer": {
             "externalReferenceId": "23001",
             "customDescription": "Our prices are cheapest~~",
             "overrideDiscount": [
                {
                   "productId": "123",
                   "discount": 50,
                   "discountType": "amountOff"
                },
                {
                   "externalReferenceId": "456",
                   "discount": 60,
                   "discountType": "amountOff"
                }
             ]
          }
       }
   }
}

The schema for a trigger offer or override discount via the Cart resource

This schema applies to a trigger offer or an override discount.

POST /shoppers/me/carts/active?skipOfferArbitration=true&offerId=12345&pid=1234

{
   "cart": {
      "lineItems": {
         "lineItem": [
            {
               "quantity": "1",
               "product": {
                  "id": "4878374"
               },
               "pricing": {
                  "salePrice": {
                     "currency": "USD",
                     "value": 8.99
                  }
               }
            }
         ],         
         "appliedProductOffers": {
            "offer": {
               "offerId": "23456",
               "customDescription": "Exclusive on our shop!!!",
               "overrideDiscount": [
                  {
                     "productId": "123",
                     "discount": 50,
                     "discountType": "amountOff"
                  },
                  {
                     "externalReferenceId": "456",
                     "discount": 60,
                     "discountType": "amountOff"
                  }
               ]
            },
            "shippingOffer": {
               "externalReferenceId": "23001",
               "customDescription": "Our prices are cheapest~~",
               "overrideDiscount": [
                  {
                     "productId": "123",
                     "discount": 50,
                     "discountType": "amountOff"
                  },
                  {
                     "externalReferenceId": "456",
                     "discount": 60,
                     "discountType": "amountOff"
                  }
               ]
            }
         }
      },
      "appliedOrderOffers": {
         "offer": {
            "offerId": "12345",
            "customDescription": "This is the finest offer you can get!!",
            "overrideDiscount": {
               "discount": 50,
               "discountType": "amountOff"
            }
         },
         "shippingOffer": {
            "externalReferenceId": "23000",
            "customDescription": "You earned a big money!",
            "overrideDiscount": {
               "discount": 10,
               "discountType": "percentOff"
            }
         }
      }      
   }
}

{
   "cart": {
      "lineItems": {
         "lineItem": [
            {
               "quantity": "1",
               "product": {
                  "id": "4878374"
               },
               "pricing": {
                  "salePrice": {
                     "currency": "USD",
                     "value": 8.99
                  }
               }
            }
         ],         
         "appliedProductOffers": {
            "offer": {
               "offerId": "23456",
               "customDescription": "Exclusive on our shop!!!",
               "overrideDiscount": [
                  {
                     "productId": "123",
                     "discount": 50,
                     "discountType": "amountOff"
                  },
                  {
                     "externalReferenceId": "456",
                     "discount": 60,
                     "discountType": "amountOff"
                  }
               ]
            },
            "shippingOffer": {
               "externalReferenceId": "23001",
               "customDescription": "Our prices are cheapest~~",
               "overrideDiscount": [
                  {
                     "productId": "123",
                     "discount": 50,
                     "discountType": "amountOff"
                  },
                  {
                     "externalReferenceId": "456",
                     "discount": 60,
                     "discountType": "amountOff"
                  }
               ]
            }
         }
      },
      "appliedOrderOffers": {
         "offer": {
            "offerId": "12345",
            "customDescription": "This is the finest offer you can get!!",
            "overrideDiscount": {
               "discount": 50,
               "discountType": "amountOff"
            }
         },
         "shippingOffer": {
            "externalReferenceId": "23000",
            "customDescription": "You earned a big money!",
            "overrideDiscount": {
               "discount": 10,
               "discountType": "percentOff"
            }
         }
      }      
   }
}

Active query parameters

Skip Offer Arbitration flag

Specify this flag in a query parameter at the cart level.

skipOfferArbitration=TRUE—Disables the Global Commerce Merchandising Offer arbitration logic to find the best price for a product. Example: Displays the Base Price. Note: If you pass the override discount offer on the same call, this offer will compete with other Global Commerce merchandising offers in the arbitration logic.
skipOfferArbitration=FALSE—Enables the Global Commerce Merchandising Offer arbitration logic to find the best price for a product. Note: If you pass the override discount offer on the same call, this offer will compete with other Global Commerce merchandising offers in the arbitration logic. The best offer wins.

O-ERID

Offer-external reference ID. A unique external reference identifier for a specific offer. The client manages all associated business logic that defines when to apply the offer. You must specify this value at the site level to use it in Commerce API calls.

Override or Overridden offer

When specified in this situation, it indicates there is a replacement for Global Commerce's Offer Discount setting. Don't confuse this term with Skip Offer Arbitration logic. When used, the system proceeds with offer arbitration after there is an override with the promotional URL type discount.

Offer Description

Overrides the offer's description in the cart AFTER adding the applicable products into the current requisition.

PreviousTriggering a promotional URL offer NextPricing

Last updated 1 year ago

{ "cart": { "lineItems": { "lineItem": [ { "quantity": "1", "product": { "id": "4878374" }, "pricing": { "salePrice": { "currency": "USD", "value": 8.99 } } } ], "appliedProductOffers": { "offer": { "offerId": "23456", "customDescription": "Exclusive on our shop!!!", "overrideDiscount": [ { "productId": "123", "discount": 50, "discountType": "amountOff" }, { "externalReferenceId": "456", "discount": 60, "discountType": "amountOff" } ] }, "shippingOffer": { "externalReferenceId": "23001", "customDescription": "Our prices are cheapest~~", "overrideDiscount": [ { "productId": "123", "discount": 50, "discountType": "amountOff" }, { "externalReferenceId": "456", "discount": 60, "discountType": "amountOff" } ] } } }, "appliedOrderOffers": { "offer": { "offerId": "12345", "customDescription": "This is the finest offer you can get!!", "overrideDiscount": { "discount": 50, "discountType": "amountOff" } }, "shippingOffer": { "externalReferenceId": "23000", "customDescription": "You earned a big money!", "overrideDiscount": { "discount": 10, "discountType": "percentOff" } } } } } { "cart": { "lineItems": { "lineItem": [ { "quantity": "1", "product": { "id": "4878374" }, "pricing": { "salePrice": { "currency": "USD", "value": 8.99 } } } ], "appliedProductOffers": { "offer": { "offerId": "23456", "customDescription": "Exclusive on our shop!!!", "overrideDiscount": [ { "productId": "123", "discount": 50, "discountType": "amountOff" }, { "externalReferenceId": "456", "discount": 60, "discountType": "amountOff" } ] }, "shippingOffer": { "externalReferenceId": "23001", "customDescription": "Our prices are cheapest~~", "overrideDiscount": [ { "productId": "123", "discount": 50, "discountType": "amountOff" }, { "externalReferenceId": "456", "discount": 60, "discountType": "amountOff" } ] } } }, "appliedOrderOffers": { "offer": { "offerId": "12345", "customDescription": "This is the finest offer you can get!!", "overrideDiscount": { "discount": 50, "discountType": "amountOff" } }, "shippingOffer": { "externalReferenceId": "23000", "customDescription": "You earned a big money!", "overrideDiscount": { "discount": 10, "discountType": "percentOff" } } } } }

hashtagHigh-level workflow use case

hashtagThe schema for skip offer arbitration via the Purchase resource

hashtagThe schema for a trigger offer or override discount via the Cart resource

hashtagActive query parameters

hashtagSkip Offer Arbitration flag

hashtagO-ERID

hashtagOverride or Overridden offer

hashtagOffer Description