Skip to main content
POST
/
EVENTS.VOUCHER.DISABLED
{
  "voucher": {
    "id": "v_T3TAfGlOsyjEQkfvUvknNYfcynUEvJ3i",
    "code": "Your-applicable-9",
    "gift": null,
    "type": "DISCOUNT_VOUCHER",
    "active": false,
    "assets": {
      "qr": {
        "id": "5a112cc9-900a-4d24-95b7-9680ca7f7133",
        "url": "{{voucher_qr_code.url}}"
      },
      "barcode": {
        "id": "c09881b3-b569-492f-82bb-5b977cd07b54",
        "url": "{{voucher_barcode.url}}"
      }
    },
    "object": "voucher",
    "publish": {
      "url": "/v1/vouchers/Your-applicable-9/publications?page=1&limit=10",
      "count": 0,
      "object": "list"
    },
    "campaign": "Test-campaign-applicable-to",
    "category": "Star Platinum",
    "discount": {
      "type": "PERCENT",
      "effect": "APPLY_TO_ITEMS",
      "percent_off": 5,
      "amount_limit": 15000,
      "aggregated_amount_limit": 30000
    },
    "metadata": {},
    "categories": [
      {
        "id": "cat_0e156dab8f2e43873a",
        "name": "Star Platinum",
        "object": "category",
        "hierarchy": 10,
        "created_at": "2024-01-03T10:03:24.092Z"
      }
    ],
    "created_at": "2024-02-09T11:18:34.621Z",
    "redemption": {
      "url": "/v1/vouchers/Your-applicable-9/redemptions?page=1&limit=10",
      "object": "list",
      "quantity": null,
      "redeemed_quantity": 0
    },
    "start_date": "2024-02-17T00:00:00.000Z",
    "updated_at": "2024-02-09T11:33:46.580Z",
    "campaign_id": "camp_18NCNUkQIaXnqbHqhtQnt355",
    "category_id": "cat_0e156dab8f2e43873a",
    "loyalty_card": null,
    "additional_info": "Additional information about the voucher",
    "expiration_date": "2024-02-29T00:00:00.000Z",
    "is_referral_code": false,
    "validity_timeframe": null,
    "validity_day_of_week": [
      1,
      0
    ],
    "validation_rules_assignments": {
      "data": [
        {
          "id": "asgm_2V5oGJRMK0fAPhwU",
          "object": "validation_rules_assignment",
          "rule_id": "val_WmgZXBqwCZrv",
          "created_at": "2024-02-09T10:16:04.401Z",
          "related_object_id": "camp_18NCNUkQIaXnqbHqhtQnt355",
          "related_object_type": "campaign"
        }
      ],
      "total": 1,
      "object": "list",
      "data_ref": "data"
    }
  },
  "campaign": {
    "id": "camp_18NCNUkQIaXnqbHqhtQnt355",
    "name": "Test-campaign-applicable-to",
    "object": "campaign"
  }
}

Response

200 - application/json

Indicates that a voucher has been disabled.

Event data object schema for voucher.disabled.

​
voucher
object

Object representing a voucher.

​
campaign
object

Simplified campaign data.

⌘I