Coupons

Summarize coupon redemption failures in session

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Create a summary of the reasons for coupon redemption failures in a given customer session.

get/v1/coupon_rejections

Request

Base URL
https://yourbaseurl.talon.one
Auth
- API key in header Authorization
- or API key in header Authorization
TypeScript
https://skmtc.dev/talon/apis/management-api/docs/v1/coupon_rejections/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

sessionIntegrationIdstring required

The integration ID of the session to summarize.

applicationIdnumber

Filter results by Application ID.

languagestring

The ISO-639 code of the language in which the summary will be generated.

couponCodestring

The coupon code for which to get the rejection reason.

Response

Example response

{
  "data": [
    {
      "id": 1,
      "eventID": 1011,
      "profileID": "a48f10dddb5c9493aad194e49bb9c1dac",
      "status": "rejected",
      "couponCode": "ABC123",
      "language": "en",
      "summary": "Session total was less than the required total.",
      "createdAt": "2021-07-20T21:59:00Z",
      "updatedAt": "2021-07-20T21:59:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.