BizKitHub
DocsAPI ReferenceVoucher/bff/voucher/detail
getVoucherAdmin BFF

/bff/voucher/detail

Returns basic detail of a specific voucher identified by its code.

VouchergetBffVoucherDetail

Parameters

1 query

Query parameters

· 1
idstringRequired

Voucher code to retrieve.

ExampleSUMMER2024

Response schema

1 status code documented

200SuccessVoucher detail object.
idstringRequired

Voucher code.

type"fixed" | "percentage" | "free-credit" | "free-product"Required

Discount type. "fixed" = fixed amount discount, "percentage" = percentage discount, "free-credit" = adds credit to customer account, "free-product" = adds free product to order.

valuestringRequired

Discount value.

usageLimitnumberOptional

Maximum usage count.

usedCountnumberRequired

Current usage count.

usedOrderCountnumberRequired

Number of orders using this voucher.

activebooleanRequired

Whether voucher is active.

isOrderSingletonbooleanRequired

Single use per order flag.

lastUsedDateDate | string | string | numberOptional

Last usage date.

One of 4:
Variant 1
Date

Last usage date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
notestringRequired

Internal note.

validFromDate | string | string | numberOptional

Validity start date.

One of 4:
Variant 1
Date

Validity start date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
validToDate | string | string | numberOptional

Validity end date.

One of 4:
Variant 1
Date

Validity end date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
insertedDateDate | string | string | numberRequired

Creation date.

One of 4:
Variant 1
Date

Creation date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired

Last modification date.

One of 4:
Variant 1
Date

Last modification date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number

Response example

application/json
{
  "id": "example_id",
  "value": "example_value",
  "usageLimit": 0,
  "usedCount": 0,
  "usedOrderCount": 0,
  "active": false,
  "isOrderSingleton": false,
  "note": "example_note"
}

Request example

GET /bff/voucher/detail

get
curl -X GET "https://api.bizkithub.com/bff/voucher/detail?id=SUMMER2024" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key