Redemption

Overview

Redemption refers to instances when coupons or promotions are applied to an order. By subscribing to redemption events, as merchants, you can get event-specific information, including redemption ID, event name, and event status.

The following table details various redemption events along with the example responses:

Events

Event Type Description Example Response
offers:redemption:promotion:created The event is triggered when redemption details for a promotion are created.
{
  "specversion": "v1",
  "type": "offers:redemption:promotion:created",
  "tenantid": "63a123070cf218e178efda30",
  "events": [
    {
      "id": "0076064a-695e-43ac-b004-17802ed186ac",
      "time": "2023-06-01T13:29:40.000Z",
      "source": "offers:business-layer",
      "subject": null,
      "data": {
        "eventName": "REDEMPTION",
        "status": "CREATED",
        "id": "642babcd3ebd250008455701",
        "callbackUrls": [
          "https://stg02.copilot.fabric.inc/api-offers/priceList/100001"
        ]
      }
    }
  ]
}

offers:redemption:promotion:deleted The event is triggered when redemption details for a promotion are deleted.
{
  "specversion": "v1",
  "type": "offers:redemption:promotion:deleted",
  "tenantid": "63a123070cf218e178efda30",
  "events": [
    {
      "id": "0076064a-695e-43ac-b004-17802ed186ac",
      "time": "2023-06-01T13:29:40.000Z",
      "source": "offers:business-layer",
      "subject": null,
      "data": {
        "eventName": "REDEMPTION",
        "status": "DELETED",
        "id": "642babcd3ebd250008455701",
        "callbackUrls": [
          "https://stg02.copilot.fabric.inc/api-offers/priceList/100001"
        ]
      }
    }
  ]
}

offers:redemption:promotion:updated The event is triggered when redemption details for a promotion are updated.
{
  "specversion": "v1",
  "type": "offers:redemption:promotion:updated",
  "tenantid": "63a123070cf218e178efda30",
  "events": [
    {
      "id": "0076064a-695e-43ac-b004-17802ed186ac",
      "time": "2023-06-01T13:29:40.000Z",
      "source": "offers:business-layer",
      "subject": null,
      "data": {
        "eventName": "REDEMPTION",
        "status": "UPDATED",
        "id": "642babcd3ebd250008455701",
        "callbackUrls": [
          "https://stg02.copilot.fabric.inc/api-offers/priceList/100001"
        ]
      }
    }
  ]
}

offers:redemption:coupon:created The event is triggered when redemption details of a coupon are created.
{
  "specversion": "v1",
  "type": "offers:redemption:coupon:created",
  "tenantid": "63a123070cf218e178efda30",
  "events": [
    {
      "id": "0076064a-695e-43ac-b004-17802ed186ac",
      "time": "2023-06-01T13:29:40.000Z",
      "source": "offers:business-layer",
      "subject": null,
      "data": {
        "eventName": "REDEMPTION",
        "status": "CREATED",
        "id": "642babcd3ebd250008455701",
        "callbackUrls": [
          "https://stg02.copilot.fabric.inc/api-offers/priceList/100001"
        ]
      }
    }
  ]
}

offers:redemption:coupon:updated The event is triggered when the redemption details of a coupon are updated.
{
  "specversion": "v1",
  "type": "offers:redemption:coupon:updated",
  "tenantid": "63a123070cf218e178efda30",
  "events": [
    {
      "id": "0076064a-695e-43ac-b004-17802ed186ac",
      "time": "2023-06-01T13:29:40.000Z",
      "source": "offers:business-layer",
      "subject": null,
      "data": {
        "eventName": "REDEMPTION",
        "status": "UPDATED",
        "id": "642babcd3ebd250008455701",
        "callbackUrls": [
          "https://stg02.copilot.fabric.inc/api-offers/priceList/100001"
        ]
      }
    }
  ]
}

offers:redemption:coupon:deleted The event is triggered when the redemption details of a coupon are deleted.
{
  "specversion": "v1",
  "type": "offers:redemption:coupon:deleted",
  "tenantid": "63a123070cf218e178efda30",
  "events": [
    {
      "id": "0076064a-695e-43ac-b004-17802ed186ac",
      "time": "2023-06-01T13:29:40.000Z",
      "source": "offers:business-layer",
      "subject": null,
      "data": {
        "eventName": "REDEMPTION",
        "status": "DELETED",
        "id": "642babcd3ebd250008455701",
        "callbackUrls": [
          "https://stg02.copilot.fabric.inc/api-offers/priceList/100001"
        ]
      }
    }
  ]
}