LogoLogo
System Status
  • Commerce API
    • Test and use cases
    • Roles and permissions
    • Sending API calls
  • Shopper APIs
    • Shopper basics
      • Common use cases
        • Creating a customer
        • Applying store credit
        • Private store workflow
        • Guest checkout
    • OAuth
      • Authentication
      • OAuth 2.0 APIs
      • Token
      • Access tokens
      • Session-aware access tokens
      • Authorizing a shopper
    • Shoppers
      • Managing shoppers
        • User management
        • Single sign-on (SSO)
        • Data validation
        • Bulk user management
        • Bulk user account export
      • Managing a shopper's account
      • Managing a shopper's address
      • Managing payment options
    • Product discovery
      • Categories
      • Products
      • Product variations
      • Pricing
      • Inventory status
      • Financing
      • Offers
        • Understanding offers
        • How to use point of promotions (POPs)
          • Retrieving all point of promotion offers for a specific product
          • Retrieving all offers for a specific point of promotion
        • How to use offers
      • Private stores
        • Managing private stores
        • Submitting an order for a private store
        • Useful APIs
      • Fulfillment
        • Electronic Fulfillment Service (OFI)
        • Digital rights
        • Digital rights revocation
        • Physical fulfillment
          • EDI X12 832 definition data elements
          • EDI X12 846 definition data elements
          • EDI X12 850 definition data elements
          • EDI X12 855 definition data elements
          • EDI X12 856 definition data elements
          • EDI X12 180-1 definition data elements
          • EDI X12 180-2 definition of data elements
          • EDI X12 180-3 definition of data elements
    • Cart
      • Applying a shopper to a cart
      • Getting the current cart
      • Creating or updating a cart
        • Adding a product to a cart
          • Gifting
        • Capturing the customer's IP address
        • Providing address information
        • Managing the shipping or billing address
        • Providing subscription information
        • Managing payment methods
        • Capturing the Terms of Sale (TOS) acceptance
      • Managing offers in a cart
        • Applying an offer
        • Applying a coupon or promo code
        • Getting all applied offers
        • Removing an applied offer
        • Removing eligible offers
        • Reconciling conflicting offers
        • Dynamic offers/personalization
          • Skipping Global Commerce merchandising offer arbitration
          • Triggering a promotional URL offer
          • Overriding a promotional URL offer discount
      • Pricing
        • Landed cost
          • Mixed cart support
          • Tax-included pretty price
      • Redirecting to a Digital River-hosted cart
      • Configuring taxes
        • Managing tax identifiers
      • Managing shipping options
        • Getting shipping options
        • Providing a shipping discount
      • Managing line items
      • Applying a price override
      • Managing payment sessions
      • Managing web checkout
      • Submitting a cart
        • Initiating a charge
        • Authorization declines
      • Resuming cart submission
      • HGOP2
    • Orders
      • Getting orders
      • Selling entities
      • Retrieving addresses from an order
      • Retrieving line items from an order
      • Order lookup
      • Returns
        • Initiate an authenticated session
        • Setting up returns in Global Commerce
        • Managing returns
    • Subscriptions
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Updating the subscription's shipping address
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
      • Immediately apply a midterm subscription change
        • Reducing the subscription renewal quantity
  • Admin APIs
    • Admin basics
      • Available Admin API calls
    • Order management
      • Getting the order's details
      • Downloading the invoice
    • Offer management
    • Refund management
      • Authorization
      • Refund reason codes
      • Creating a satisfaction refund
      • Getting the available refunds for a specific order
      • Getting refunds for a specific order
      • Getting refunds available for a shopper's order
      • Getting the JSON schema for an order refund
      • Managing a refund for a delayed payment method
      • Refund error scenarios
    • Subscription management
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update the subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal product
        • Changing the subscription renewal price
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Activating a subscription
        • Changing the subscription's external reference identifier
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
        • Updating the subscription's expiration date
      • Immediately apply a midterm subscription change
        • Applying a midterm change with price override
        • Reducing the subscription renewal quantity
      • Subscription notifications
        • Updating the subscriber's email address
        • Card Account Updater
        • Sending a payment information change notification
        • Sending an expired credit card notification
        • Sending an invalid payment account notification
        • Sending a payment failure notification
        • Sending a subscription renewal reminder notification
        • Setting up subscription renewal reminders
        • Setting up trial subscription renewal reminders
        • Setting up marketing reminders
      • Using the Expired Card Optimizer
    • Customer management
      • Retrieving customer details
      • Requesting PII removal for a customer
    • Site management
      • Configuring authorized shipping and billing countries
      • Getting a site's authorized billing countries
      • Getting a site's authorized shipping countries
    • Product management
      • Getting started
      • Manage products (asynchronous API)
        • Creating or updating a product
        • Adding or updating a product variation
        • Deploying a product
        • Applying live changes
        • Retiring a product
        • Deleting a product variation
        • Deleting a base or individual product's locale
      • Retrieve products (synchronous API)
        • Getting a product by locale
        • Getting a product variation
        • Getting a product variation by locale
      • Get the task status for a product (synchronous API)
        • Getting the latest information on a product task
        • Retrieving the tasks for a specific product
        • Retrieving the tasks for products
      • Bulk operation
        • Asynchronous bulk operations
          • Creating products in bulk
          • Updating products in bulk
          • Deploying products in bulk
          • Deleting product variations in bulk
        • Bulk product upload (BPU)
        • Bulk Product Export (BPE)
          • Line-item level satisfaction refund
          • Order-level satisfaction refund
          • Auto-created line-item level return product
          • Line-item level return product
    • File management
      • Downloading a file
  • Payments
    • Payments solutions
      • Drop-in payments
        • How Drop-in payments work
        • Drop-in payments integration guide
      • DigitalRiver.js with Elements
        • Elements integration guide
        • Configuring payment methods
          • Configuring Afterpay
          • Configuring Alipay+ (cross-border)
          • Configuring Alipay (domestic)
          • Configuring Amazon Pay
          • Configuring Apple Pay
          • Configuring Bancontact
          • Configuring BLIK
          • Configuring Boleto
          • Configuring CCAvenue
          • Configuring Clearpay
          • Configuring Credit Cards
          • Configuring FPX Online Banking
          • Configuring Google Pay
          • Configuring iDEAL
          • Configuring Klarna
          • Configuring Konbini
          • Configuring Online Banking (IBP)
          • Configuring Online Banking (Korea Bank Transfer)
          • Configuring PayCo
          • Configuring PayPal
          • Configuring SEPA Direct Debit
          • Configuring Trustly
          • Configuring Wire Transfer
          • Common payment sources
          • Common payment objects
    • Supported payment methods
      • Afterpay
      • Alipay (domestic)
      • Alipay+ (cross-border)
      • Amazon Pay
      • Apple Pay
      • Bancontact
      • BLIK
      • Boleto
      • CCAvenue
      • Clearpay
      • Credit Cards
      • FPX Online Banking
      • Google Pay
      • iDEAL
      • Klarna
      • Konbini
      • Korea Bank Transfer (Online Banking)
      • Online Banking (IBP)
      • PayCo
      • PayPal
      • PayPal Billing Agreement
      • PayPal Credit
      • PayPal Pay in 3
      • PayPal Pay in 4
      • PayPal RatenZahlung (Installment Payment)
      • SEPA Direct Debit
      • Trustly
      • Wire Transfer
    • Source basics
      • Managing sources
      • Handling credit card sources
      • Retrieving sources
    • Building payment workflows
      • Flows by payment type
      • Handling redirect payment methods
    • PSD2 and SCA
    • Payment testing scenarios
      • Testing standard payment methods
      • Testing redirect payment methods
      • Testing receiver payment methods
      • Testing the CCAvenue payment method
  • Events
    • Events overview
    • Responding to events
    • Event types
      • Delayed payment event types
        • Delayed payment expired event
          • Boleto
          • Konbini
          • Wire Transfer
        • Delayed payment reminder event
          • Boleto
          • Konbini
          • Wire Transfer
      • Subscription event types
        • Subscription created event
        • Subscription updated event
        • Subscription action processed event
        • Subscription cancelled event
        • Subscription credit card expired event
        • Subscription payment information changed event
        • Subscription renewal reminder event
        • Subscription renewed event
        • Subscription trial converted event
        • Subscription trial renewal reminder event
        • Subscription payment failed event
      • Post-order event types
        • Invoice created event
        • Refund credit memo event
      • Inventory event types
        • Inventory out of stock event
        • Inventory source and management
        • Inventory self-managed updated event
        • Inventory fulfiller-managed updated event
      • Post-order Notification Integration Guide
    • Webhooks
      • Commerce API safelist
      • Searching for a webhook
      • Creating a webhook
      • Using webhooks
      • Editing a webhook
      • Turning webhooks on or off
      • Revealing a webhook's secret
      • Rotating a webhook's secret
      • Viewing the webhook details
      • Deleting a webhook
  • Developer Resources
    • Postman collection
    • Commerce API references
    • Shopper APIs reference
    • Admin APIs reference
    • DigitalRiver.js reference
      • Including DigitalRiver.js
      • Initializing DigitalRiver.js
      • DigitalRiver object
      • Elements
        • Amazon Pay element
        • Apple Pay elements
        • Google Pay elements
        • IBAN element
        • iDEAL element
        • Konbini elements
        • Compliance element
        • Offline refund element
        • Online Banking elements
        • Tax Identifier element
        • Delayed payment instructions element
        • PayPal elements
      • Guidelines for capturing payment details
      • Security
      • Digital River payment objects
      • Error types, codes, and objects
  • General resources
    • Global Commerce
    • Global Commerce
      • Company hierarchy
      • Categories
        • Getting a list of categories
      • Products
        • Product scenarios
        • Individual products
          • Creating an individual product
        • Base product with variants
          • Creating a base product with variants
        • Bundle offers
          • Creating a prorated bundle offer with a subscription
        • Product combination
          • Creating a product combination
        • Gifting
        • Inventory status
      • Customer service
        • Log a shopper's request to remove PII
      • Customers
        • Creating a customer
        • Digital River-maintained customer login
        • Client-maintained customer login
      • Transparent Commerce purchase flow
    • eCompass
    • eCompass documentation
    • Release notes
      • 2024
      • 2024 latest
      • 2023
      • 2022
      • 2021
      • 2020
Powered by GitBook
On this page
  • High-level workflow use case
  • The schema for skip offer arbitration via the Purchase resource
  • The schema for a trigger offer or override discount via the Cart resource
  • Active query parameters
  • Skip Offer Arbitration flag
  • O-ERID
  • Override or Overridden offer
  • Offer Description

Was this helpful?

  1. Shopper APIs
  2. Cart
  3. Managing offers in a cart
  4. Dynamic offers/personalization

Overriding a promotional URL offer discount

Learn how to override a promotional URL offer discount.

PreviousTriggering a promotional URL offerNextPricing

Last updated 1 year ago

Was this helpful?

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

  1. The user applies an offer ID or O-ERID to a cart to trigger Global Commerce's preconfigured offer behavior.

  2. The client sets up a Promotional URL triggered offer in Global Commerce. A call to the resource triggers the offer and applies the discount offer with the offer ID or ERID included in the call.

  3. 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.

  4. The shopper can see the correct discount applied to the cart.

  5. The shopper successfully submits the order.

  6. The user triggers the Get Order resource (GET /v1/shoppers/me/orders/[orderId]).

  7. The user can see the override description.

The schema for skip offer arbitration via the Purchase resource

This schema applies to a .

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 or an .

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.

Cart
skip offer arbitration
trigger offer
override discount