Link Search Menu Expand Document

Working with Spaaza vouchers in the webshop

Spaaza provides digital voucher tools to allow brands to easily and securely redeem customer rewards in a webshop as well as other channels.

A webshop system redeems a voucher in Spaaza by applying the voucher to their transaction and then sending the voucher key to Spaaza in the completed order via our add-basket API endpoint.

In Spaaza, a voucher can be a title to a monetary or percentage discount, a free item, an experience or even an action taken by a third party. Vouchers are tied to a customer’s account and can only be used on a transaction associated or linked to their account. This reduces fraud and also makes redemption more customer-(and staff)-friendly as there is no need to look up and enter voucher codes.

Vouchers usually need to be “claimed” or activated by the customer (or a staff member) before they can be redeemed. However it is also possible to set vouchers to the status “claimed” by default, in which case they will be redeemed automatically against the next transaction that the customer makes.

It is possible to restrict how individual vouchers can be redeemed in Spaaza so that any monetary value is only redeemed on certain items in a customer’s transaction. For example: “do not allow sign up vouchers to be used on sale items”. Webshop developers should ideally use the get-basket-price endpoint so that Spaaza can ensure these restrictions are applied.

For many more details on the type of vouchers available in Spaaza and how to work with these please visit our Voucher API page.

The flow diagram below illustrates the typical flows between Spaaza and webshop system needed to redeem vouchers.

A typical webshop voucher redemption data flow

Locking vouchers

It is recommended that vouchers are “locked” using the lock-voucher API endpoint to ensure that a voucher cannot be used in other purchase or deleted during the checkout process. This is one of many anti-fraud technologies built into Spaaza.

Locking vouchers is particularly relevant in the webshop when there may be a delay in between when the order is completed in the webshop and when the payment is processed by the payment processor (after which the order is normally sent to Spaaza). During this time it is possible to use a voucher again if it has not been locked to the basket/order number.

Vouchers created by wallets

“Basket” vouchers can also be created by a Credit or “Monetary Wallet”.

The idea behind Spaaza’s Credit Wallet is that customers can save up a monetary value discount and then choose how much of that discount they want to spend.

Customers can choose an amount to spend in their Wallet using for example a mobile app with Spaaza integrated. This interaction would create a basket voucher in Spaaza of that selected value.

The frontend webshop user experience for working with wallets can be built natively into a webshop using Spaaza’s APIs alternatively Spaaza’s iFrame can be used.

APIs to get vouchers

A customer’s vouchers are available using the get-card and get-user-vouchers API endpoints. Vouchers can also be created as a result of get-basket-price (see 3.5 below).

When to request vouchers in the webshop

Spaaza’s goal is to allow brands to reward customers for lots of type of interactions (not just purchases) and to allow rewards to be targeted to specific customers and groups of customers. As a result a voucher could be created at any time in Spaaza and may be available for some users and not others. It’s therefore best to request new vouchers from Spaaza frequently, on a per-user basis.

For example vouchers, could be created in Spaaza when the following events occur:

  • when the customer meets the target/goal of a campaign that is running (e.g. “spend €500 and earn a €10 voucher”, get €5 when you reach 1000 points, create an account and get 10% off”)

  • at the checkout where a voucher is created in real time by Basket Campaign that is running where the voucher is based on the contents of the basket and the profile of the customer (e.g. “gold level members always get 10% off”)

  • via a manual action for an individual customer, usually done at head office using Spaaza’s Console tool (e.g. “sorry for the late delivery, we have added a €5 voucher to your account”)

  • via a bulk voucher issue campaign for a defined group of customers (“issue all customers who have not shopper in more than a year a voucher every Friday afternoon”)

Spaaza’s get-basket-price API can be used by a webshop system to request what a “basket” or order should look like after the claimed Spaaza vouchers have been applied. This can be useful for example if a brand has a rule set up in Spaaza like “basket vouchers cannot be used on sale items”.

This call is also necessary to apply certain types of promotions as Spaaza has the ability to create a voucher in real time for a user if they match a certain profile, for example: in the case of the promotion “gold level members get 10% off every purchase” Spaaza can create a voucher equal to 10% of the basket value when get-basket-price is used for a matching user.

Vouchers created by get-basket-price that are based on the contents of a basket are tied to the basket and typically “short-lived”.

It is up to the webshop partner to decide on how to apply the vouchers against the order and thus what the final order will look like. This final order is then sent to Spaaza.