v1

latestOpenAPI 3.0.02026-07-22207183.5 KB

Record Order

Record order with a coupon

For In-Store situations where a referral transaction can occur identified by a coupon and typically without a customer email address.

The coupon must be a single-use coupon. You can validate the coupon code first using the Merchant API -> Validate Coupon Code endpoint if you wish.

If you have an email address and may not have a coupon, use the Record Order endpoint instead.

We will use the order confirmation to:

Record the customer is an existing customer and no longer eligible for introductory rewards (and mark their referral as redeemed)
Reward a referrer if this purchase was as a result of a referral

We will also use the data to optimise your referral scheme.

post/api/consumer/{version}/coupon_redemption

Path parameters

version'v2' | 'v1' required

Version

Request body

Example request

{
  "order": {
    "orderIdentifier": "123456",
    "total": "100",
    "currencyCode": "GBP",
    "dateString": "2026-01-01T12:00:00+00:00",
    "couponCode": "ABC23252",
    "discountAmount": "12.44",
    "orderItemCount": "3"
  },
  "customer": {
    "emailAddress": "jane.doe@example.com"
  },
  "request": {
    "partnerCode": "[YOUR-PARTNER-CODE]",
    "situation": "mobile-app",
    "segment": "vip",
    "localeCode": "en_GB",
    "ipAddress": "127.0.0.1",
    "appVersion": "e.g. MyApp/v1.73"
  }
}

Response

Returned when successful