Skip to main content
POST
/
EVENTS.REDEMPTION.FAILED
{
  "order": null,
  "holder": null,
  "voucher": null,
  "campaign": null,
  "customer": {
    "id": "cust_1g637SqVZnkdPNdAIZ7Ra879",
    "name": "Jane Doe",
    "email": "jane@jane.io",
    "object": "customer",
    "metadata": {
      "lang": "en",
      "region": "EMEA"
    },
    "source_id": "test_customer_id_2"
  },
  "created_at": "2024-02-02T12:12:12.919Z",
  "redemption": {
    "id": "rf_0e3ac5685ba431c104",
    "date": "2024-02-02T12:12:12.918Z",
    "object": "redemption",
    "result": "FAILURE",
    "status": "FAILED",
    "customer": {
      "id": "cust_1g637SqVZnkdPNdAIZ7Ra879",
      "name": "Jane Doe",
      "email": "jane@jane.io",
      "object": "customer",
      "metadata": {
        "lang": "en",
        "region": "EMEA"
      },
      "source_id": "test_customer_id_2"
    },
    "metadata": {},
    "customer_id": "cust_1g637SqVZnkdPNdAIZ7Ra879",
    "tracking_id": "track_Pw6r3ejnml43kIwNS4Zj09KZ67xOfLUy",
    "failure_code": "no_applicable_redeemables",
    "failure_message": "No applicable redeemables"
  },
  "promotion_tier": null
}

Response

200 - application/json

Indicates that redemption is unsuccessful.

Event data object schema for redemption.failed.

​
customer
object

Simplified customer data.

​
order
object

Order information.

​
campaign
object

Simplified campaign data.

​
voucher
object

Simplified voucher data.

​
holder
object

Details about the redeemable holder.

​
promotion_tier
object

Simplified promotion tier data.

​
promotion_stack
object

Simplified promotion stack data.

​
redemption
object

Simplified redemption data.

​
created_at
string<date-time>

Timestamp representing the date and time when the redemption failed in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

⌘I