BizKitHub
DocsAPI ReferenceVoucher/bff/voucher/full-detail
getVoucherAdmin BFF

/bff/voucher/full-detail

Returns comprehensive detail of a voucher including usage context, recent orders that used it, linked products (for voucher templates), and computed status fields like effective activity and days until expiration.

VouchergetBffVoucherFull-detail

Parameters

1 query

Query parameters

· 1
codestringRequired

Voucher code to retrieve full details for.

ExampleSUMMER2024

Response schema

1 status code documented

200SuccessComprehensive voucher detail with context.
idstringRequired

Voucher code.

internalIdstringRequired

Internal database ID.

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.

usageLimitnumber | nullRequired

Maximum usage count or null if unlimited.

One of 2:
Variant 1
number
Variant 2
null
usedCountnumberRequired

Current usage count.

usedOrderCountnumberRequired

Number of orders using this voucher.

activebooleanRequired

Database active flag.

effectivelyActivebooleanRequired

Computed status considering expiration, usage limit, and validity period.

isOrderSingletonbooleanRequired

Single use per order flag.

lastUsedDateDate | string | string | number | nullRequired

Last usage date.

One of 2:
Variant 1
Date | string | string | number
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
null
notestringRequired

Internal note (full content).

validFromDate | string | string | number | nullRequired

Validity start date.

One of 2:
Variant 1
Date | string | string | number
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
null
validToDate | string | string | number | nullRequired

Validity end date.

One of 2:
Variant 1
Date | string | string | number
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
null
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
remainingUsagenumber | nullRequired

Remaining uses before limit is reached. Null if unlimited.

One of 2:
Variant 1
number
Variant 2
null
isExpiredbooleanRequired

Whether the validity period has ended.

isNotYetValidbooleanRequired

Whether the validity period has not started yet.

daysUntilExpirationnumber | nullRequired

Days until voucher expires. Null if no expiration date or already expired.

One of 2:
Variant 1
number
Variant 2
null
costnumber | nullRequired

Money the voucher cost when issued (organisation default currency). null = "ratio unknown" → resulting credits applied 1:1. 0 = "explicitly gifted" → resulting credits carry zero money value.

One of 2:
Variant 1
number
Variant 2
null
sourceOrderobject | nullRequired

Order that spawned this voucher (product-template fulfilment or workflow special action). Null for manually created vouchers.

One of 2:
Variant 1
orderIdnumberRequired

Source order ID.

orderHashstringRequired

Source order hash (admin order detail route segment).

orderNumberstringRequired

Source order number.

orderVariableSymbolstringRequired

Source order variable symbol.

Variant 2
null
recentOrdersobject[]Required

Last 5 orders that used this voucher.

Each array item:

Order that used this voucher.

orderIdnumberRequired

Order ID.

orderHashstringRequired

Order hash (used as the admin order detail route segment).

orderNumberstringRequired

Order number.

orderVariableSymbolstringRequired

Variable symbol for payment.

customerNamestringRequired

Customer name or "Anonymous".

orderTotalstringRequired

Total order value with VAT.

currencyCodestringRequired

Currency code (e.g., CZK, EUR).

usedDateDate | string | string | numberRequired

When voucher was applied to this order.

One of 4:
Variant 1
Date

When voucher was applied to this order.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
linkedProductsobject[]Required

Products that generate this voucher when purchased.

Each array item:

Product linked to this voucher template.

productIdnumberRequired

Product ID.

productNamestringRequired

Product name.

productCodestringRequired

Product SKU/code.

productActivebooleanRequired

Whether product is active.

Response example

application/json
{
  "id": "example_id",
  "internalId": "example_internalId",
  "value": "example_value",
  "usedCount": 0,
  "usedOrderCount": 0,
  "active": false,
  "effectivelyActive": false,
  "isOrderSingleton": false,
  "note": "example_note",
  "isExpired": false,
  "isNotYetValid": false,
  "recentOrders": [
    {
      "orderId": 0,
      "orderHash": "example_orderHash",
      "orderNumber": "example_orderNumber",
      "orderVariableSymbol": "example_orderVariableSymbol",
      "customerName": "example_customerName",
      "orderTotal": "example_orderTotal",
      "currencyCode": "example_currencyCode"
    }
  ],
  "linkedProducts": [
    {
      "productId": 0,
      "productName": "example_productName",
      "productCode": "example_productCode",
      "productActive": false
    }
  ]
}

Request example

GET /bff/voucher/full-detail

get
curl -X GET "https://api.bizkithub.com/bff/voucher/full-detail?code=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