Voucher group
Voucher groups are templates from which vouchers can be generated. Individual vouchers are not complete on their own - you need a voucher's group to fully identify its functionality. Voucher groups may have several limitations, like how many vouchers can be generated (for unique one-off vouchers), or how many times a shared voucher (same code used many times) may be used.
Two vouchers are supported: Giveaway and Campaign. Giveaway voucher groups are connected to a product and redeeming a voucher from this group will create a subscription or grant digital content access. The campaign version is used in connection to Campaigns that require vouchers to be activated in the purchase flow.
voucherGroupId ✓ | integer (as string)Unique ID of the voucher group |
|---|---|
clientId ✓ | stringID of the client that owns the voucher group and its vouchers |
discountId ✓ | integer (as string)ID of discount to apply |
campaignId ✓ | integer (as string)Unique ID, used by 'campaign' voucher groups |
productId ✓ | integer (as string)Used by 'campaign' voucher groups |
type ✓ | Voucher typeThe type of the voucher group and all its vouchers |
unique ✓ | booleanIf |
limit ✓ | integer (as string)The maximum number of vouchers that may be generated, or the number of times a shared voucer may be used. 0 means no limit |
title ✓ | stringA descriptive name of the voucher, suitable for presentation to end-users |
description ✓ | stringA description of the intention of the voucher group |
createdBy ✓ | integer (as string)The |
updated ✓ | datetimeWhen the voucher group was last modified |
created ✓ | dateimeWhen the voucher group was created |
The check mark ✓ indicates that the field always contains a valid non-empty value.
Voucher
Vouchers are mainly described by the voucher group they belong to. Shared vouchers can be redeemed multiple times and as such never changes its status to redeemed. Unique vouchers have unique codes for each user and can only be redeemed once.
voucherId ✓ | integer (as string)Unique ID of the voucher. Endpoints only ever use the |
|---|---|
voucherGroupId ✓ | integer (as string)ID of the voucher group the voucher belongs to |
userId ✓ | integer (as string)
|
type ✓ | Voucher typeVoucher group type |
count | integer (as string)Number of time the voucher has been redeemed. Only available for shared vouchers. |
voucherCode ✓ | stringA unique string that gives access to this voucher |
status ✓ | Voucher status |
handoutBy ✓ | integer (as string)
|
createdBy ✓ | integer (as string)
|
updated ✓ | datetimeWhen the voucher was last updated (i.e. had its status changed) |
created ✓ | datetimeWhen the voucher was created |
The check mark ✓ indicates that the field always contains a valid non-empty value.
Voucher type
An enum, with the following possible values:
| Campaign, redeems as a campaign purchase |
|---|---|
| Voucher as payment method |
| Giveaway, when redeemed, the user is given the product directly, without creating an order (thus, no there will be no receipt generated from the system). For testing purposes only, not available in production. |
| Free with order, redeemer is given product and order is created for 0 value. Replaced by |
Voucher status
An enum, with the following possible values:
| Voucher is expired and can no longer be redeemed |
|---|---|
| Voucher is generated and may be either used or handed out |
| Voucher is handed out. If the userId field is set, only this user may redeem it |
| Voucher is redeemed and can no longer be used. Kept only for historic reasons |
Comments/feedback
Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. Our team reads and responds to every question. Additionally, your experience can help others using Schibsted account, and it can help us continuously improve our documentation.