Parameters
1 query
Query parameters
· 1idstringRequiredVoucher code to retrieve.
SUMMER2024Returns basic detail of a specific voucher identified by its code.
1 query
idstringRequiredVoucher code to retrieve.
SUMMER20241 status code documented
idstringRequiredVoucher code.
type"fixed" | "percentage" | "free-credit" | "free-product"RequiredDiscount type. "fixed" = fixed amount discount, "percentage" = percentage discount, "free-credit" = adds credit to customer account, "free-product" = adds free product to order.
valuestringRequiredDiscount value.
usageLimitnumberOptionalMaximum usage count.
usedCountnumberRequiredCurrent usage count.
usedOrderCountnumberRequiredNumber of orders using this voucher.
activebooleanRequiredWhether voucher is active.
isOrderSingletonbooleanRequiredSingle use per order flag.
singleUsePerCustomerbooleanRequiredIf true, each customer may redeem this voucher on at most one order.
redeemableAtOrderbooleanRequiredIf true, voucher may be redeemed on the reservation / order form.
redeemableAtVoucherPagebooleanRequiredIf true, voucher may be redeemed on the voucher-redeem page.
lastUsedDateDate | string | string | numberOptionalLast usage date.
Last usage date.
notestringRequiredInternal note.
validFromDate | string | string | numberOptionalValidity start date.
Validity start date.
validToDate | string | string | numberOptionalValidity end date.
Validity end date.
insertedDateDate | string | string | numberRequiredCreation date.
Creation date.
updatedDateDate | string | string | numberRequiredLast modification date.
Last modification date.
{
"id": "example_id",
"value": "example_value",
"usageLimit": 0,
"usedCount": 0,
"usedOrderCount": 0,
"active": false,
"isOrderSingleton": false,
"singleUsePerCustomer": false,
"redeemableAtOrder": false,
"redeemableAtVoucherPage": false,
"note": "example_note"
}GET /bff/voucher/detail
curl -X GET "https://api.bizkithub.com/bff/voucher/detail?id=SUMMER2024" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"All BizKitHub public API endpoints require authentication via API key.