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

Was this helpful?

  1. Shopper APIs
  2. Cart
  3. Managing offers in a cart

Applying a coupon or promo code

Learn how to apply a coupon or promo code.

PreviousApplying an offerNextGetting all applied offers

Last updated 5 months ago

Was this helpful?

Coupons or promotional codes encourage store sales by providing discounts on products or shipping costs. You can configure a coupon or promo code offer in Global Commerce and apply that coupon or promo code to an active shopping cart to encourage sales in your stores by providing discounts on products or shipping costs.

Send a request to the resource with the required promoCode query parameter. The request must include a valid anonymous or authenticated customer token. No payload is associated with this request; the payload could be empty.

The request in the following example applies a promotional code value of wb32xjtam.

Note: A successful request returns a 200 status code in the response header. An unsuccessful request returns an error code in the response.

curl --location --request POST https://api.digitalriver.com/v1/shoppers/me/carts/active?promoCode=wb32xjtam
--header 'authorization: Basic ***\ 
...
{
   "cart": {
      "id": "1234567890",
      "lineitems": {
         "lineitem": {
            "id": "12765711619",
            "quantity": "1",
            "product": {
               "displayname": "Displayable Product Name",
               "thumbnailimage": "http://drh1.img.digitalriver.com/DRHM/Storefront/images\n/product/thumbnail/small-product-image.jpg",
               "_uri": "https://api.digitalriver.com/v1/shoppers/me/products/232054400"
            },
            "pricing": {
               "listprice": {
                  "_currency": "USD",
                  "__text": "24.95"
               },
               "listpricewithquantity": {
                  "_currency": "USD",
                  "__text": "24.95"
               },
               "salepricewithquantity": {
                  "_currency": "USD",
                  "__text": "14.95"
               },
               "formattedlistprice": "$24.95",
               "formattedlistpricewithquantity": "$24.95",
               "formattedsalepricewithquantity": "$14.95"
            },
            "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active /line-items/12765711619"
         },
         "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active /line-items"
      },
      "billingaddress": {
         "shippingaddress": {
            "payment": {
               "name": "Visa",
               "displayablenumber": "************1111",
               "expirationyear": "2017"
            },
            "shippingmethod": {
               "code": "142400",
               "description": "USPS - Priority Mail"
            },
            "shippingoptions": {
               "pricing": {
                  "subtotal": {
                     "_currency": "USD",
                     "__text": "24.95"
                  },
                  "discount": {
                     "_currency": "USD",
                     "__text": "10.00"
                  },
                  "shippingandhandling": {
                     "_currency": "USD",
                     "__text": "0.00"
                  },
                  "tax": {
                     "_currency": "USD",
                     "__text": "0.00"
                  },
                  "ordertotal": {
                     "_currency": "USD",
                     "__text": "14.95"
                  },
                  "formattedsubtotal": "$24.95",
                  "formatteddiscount": "$10.00",
                  "formattedshippingandhandling": "$0.00",
                  "formattedtax": "$0.00",
                  "formattedordertotal": "$14.95"
               },
               "_uri": "https://api.digitalriver.com/v1/shoppers/me/shipping-options"
            },
            "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-address"
         },
         "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/billing-address"
      },
      "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active"
   }
}
{
   "cart": {
      "id": "1234567890",
      "lineitems": {
         "lineitem": {
            "id": "12765711619",
            "quantity": "1",
            "product": {
               "displayname": "Displayable Product Name",
               "thumbnailimage": "http://drh1.img.digitalriver.com/DRHM/Storefront/images\n/product/thumbnail/small-product-image.jpg",
               "_uri": "https://api.digitalriver.com/v1/shoppers/me/products/232054400"
            },
            "pricing": {
               "listprice": {
                  "_currency": "USD",
                  "__text": "24.95"
               },
               "listpricewithquantity": {
                  "_currency": "USD",
                  "__text": "24.95"
               },
               "salepricewithquantity": {
                  "_currency": "USD",
                  "__text": "14.95"
               },
               "formattedlistprice": "$24.95",
               "formattedlistpricewithquantity": "$24.95",
               "formattedsalepricewithquantity": "$14.95"
            },
            "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active /line-items/12765711619"
         },
         "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active /line-items"
      },
      "billingaddress": {
         "shippingaddress": {
            "payment": {
               "name": "Visa",
               "displayablenumber": "************1111",
               "expirationyear": "2017"
            },
            "shippingmethod": {
               "code": "142400",
               "description": "USPS - Priority Mail"
            },
            "shippingoptions": {
               "pricing": {
                  "subtotal": {
                     "_currency": "USD",
                     "__text": "24.95"
                  },
                  "discount": {
                     "_currency": "USD",
                     "__text": "10.00"
                  },
                  "shippingandhandling": {
                     "_currency": "USD",
                     "__text": "0.00"
                  },
                  "tax": {
                     "_currency": "USD",
                     "__text": "0.00"
                  },
                  "ordertotal": {
                     "_currency": "USD",
                     "__text": "14.95"
                  },
                  "formattedsubtotal": "$24.95",
                  "formatteddiscount": "$10.00",
                  "formattedshippingandhandling": "$0.00",
                  "formattedtax": "$0.00",
                  "formattedordertotal": "$14.95"
               },
               "_uri": "https://api.digitalriver.com/v1/shoppers/me/shipping-options"
            },
            "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/shipping-address"
         },
         "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active/billing-address"
      },
      "_uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active"
   }
}

Typically, the next steps after applying a coupon or promo code are either to complete the purchase process or and creating an order to complete the checkout process.

Primary versus secondary offers

When using a coupon, it's important to note that it's linked to a primary offer which may also have a secondary offer, typically tied to shipping discounts. Each offer has its specific criteria, which can be evaluated separately. A warnings object appears in the response only when neither set of criteria is met. For example, you create a discount offer with a second shipping discount as follows:

  • The primary offer is a $5 discount for Product A.

  • The secondary offer is a 50% shipping discount on orders over $200.

The following table shows when the A warnings object appears.

Discount scenarios
Does the primary offer criteria match?
Does the secondary offer criteria match
Warning displayed when applying coupon in the cart

  1. Empty cart

  2. The cart amount is less than $200 and Product A is not in the cart

No

No

Yes

  1. Product A is in the cart

Yes

No

No

  1. The cart amount has reached $200

Yes

Yes

No

  1. The cart amount has reached $200 and the Product A is in the cart

No

Yes

No

Carts
redirecting the customer to the Digital River-hosted checkout
submitting the cart
POST shoppers/me/carts/active