api
vouchers
Get Voucher by id
get/api/vouchers/{id}
Path parameters
idstring required
The ID of the voucher to get
Response
OK
codestring required
Code used to redeem the voucher
amountnumber float required
The amount of the voucher in seller's currency. eg. 50.0 -> 50 EUR
validUntilstring date-time
The date until this voucher can be redeemed.
sellerIdstring
The ID of the seller of the voucher
transactionIdstring
The ID of the transaction if the voucher was a result of a transaction
productIdstring
The ID of the product if the voucher was a result of a product
refundIdstring
The ID of the refund if the voucher was a result of a refund
customerIdstring
The ID of the customer if the voucher was created for a specific customer
origin'default' | 'shop' | 'import' | 'upgrade' | 'refund'
The origin of the voucher
createdAtstring date-time required
An ISO Timestamp indicating when the voucher was created.
updatedAtstring date-time required
An ISO Timestamp indicating when the voucher was last updated.