Sign in
CouponCodes

Get the offering discount for a coupon code

Returns the primary OfferingDiscount configured on the coupon behind the given redemption code. Useful at point of sale when you want to preview the offerings a coupon code applies to before asking the customer to commit it to a basket.

The lookup is scoped to the organisation derived from the caller's site context: if the code exists in another organisation the endpoint returns 404.

Requires the CUSTOMERS_VIEW permission.

get/shop/coupon-codes/{code}/offering-discounts

Response

The first OfferingDiscount configured on the coupon backing the given code. Returned as a singleton (not an array) because the endpoint surfaces the primary discount eligibility for point-of-sale UIs.

Example response

{
  "data": {
    "offerings": [
      {
        "offering_name": "Test offering"
      }
    ],
    "fixed_amount": 50,
    "percentage": 10
  }
}

Changes