Creating vouchers

Returns an OK code and returns the details of the created voucher

{
  "result": {
      "code": 1,
      "status": "ok"
  },
  "results": {
      "voucher_key": "0df3e1934e277240bd44072f302c75165dab108b6705d48695b38101634274ab",
      "voucher_id": 44974,
      "voucher_status": "generated",
      "campaign_id": 2,
      "campaign_title": "20 EUR voucher for every 200 EUR spent",
      "voucher_expiry_datetime_utc": "2050-01-01 00:00:00",
      "voucher_expiry_seconds_remaining": 1126928505,
      "voucher_currency_id": 2,
      "voucher_amount": 40,
      "voucher_amount_redeemed": null,
      "voucher_honour_code": "honour0004",
      "voucher_title": "€20 Voucher",
      "voucher_text": "Your new voucher, enjoy!",
      "voucher_description": "Redeem this voucher in store to get €20 off your purchase.",
      "voucher_notes": "Here is the place to put long-form notes such as terms and conditions or instructions for use.",
      "voucher_image_url": "https://www.example.com/voucher-image.jpg",
      "user_id": 1,
      "user_entity_card": {
          "type": "regular",
          "code": "1"
      },
      "result_type": "create-voucher"
  }
}

Overview

• Call name: create-voucher
• Endpoint URL: https://api0.spaaza.com/v1/create-voucher.json
• Request methods: POST
• Request Content-Type: multipart/form-data or application/x-www-form-urlencoded
• Response Content-Type: application/json
• Auth required: yes

Creates a basket voucher for use in the next purchase.

Note that currently, this logic only works for vouchers from campaigns of type “wallet” and type “loyalty”.

The create call takes a ‘campaign id’ and a voucher amount.

In the case of a wallet campaign, the user being granted the voucher must have enough balance in the wallet for a voucher to be created.

Permissions and Authentication

This API call requires a valid Spaaza session. The session can be as follows:

• User authentication: a session generated by an end-user login.
• Admin authentication: the performing user needs to be logged in and have write access to the entity (business or chain) to which the user is connected.
• Privileged authentication: the use of privileged authentication is permitted for this endpoint.

HTTP Parameters

The following HTTP parameters can be passed to the endpoint:

In the case of privileged or admin authentication, the following parameters can/must also be passed to the endpoint: