BizKitHub
DocsAPI ReferenceVoucher/bff/voucher/usage-history
getVoucherAdmin BFF

/bff/voucher/usage-history

Returns paginated history of all orders that used a specific voucher. Includes order details, customer information, and usage timestamps.

VouchergetBffVoucherUsage-history

Parameters

3 query

Query parameters

· 3
codestringRequired

Voucher code to get usage history for.

ExampleSUMMER2024
limitstringOptional

Maximum number of items to return (default: 50).

Example50
offsetstringOptional

Number of items to skip for pagination (default: 0).

Example0

Response schema

1 status code documented

200SuccessPaginated voucher usage history.
itemsobject[]Required

Array of usage history records.

Each array item:

Single usage history record.

orderIdnumberRequired

Order ID.

orderHashstringRequired

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

orderNumberstringRequired

Order number.

orderVariableSymbolstringRequired

Variable symbol for payment identification.

orderStatusstringRequired

Current order status label.

orderTotalPricestringRequired

Total order value with VAT.

currencyCodestringRequired

Currency code.

customerNamestringRequired

Customer name or "Anonymous".

customerEmailstringRequired

Customer email address.

usedDateDate | string | string | numberRequired

When the voucher was applied to this order.

One of 4:
Variant 1
Date

When the voucher was applied to this order.

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

When the order was created.

One of 4:
Variant 1
Date

When the order was created.

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

Total number of orders that used this voucher.

Response example

application/json
{
  "items": [
    {
      "orderId": 0,
      "orderHash": "example_orderHash",
      "orderNumber": "example_orderNumber",
      "orderVariableSymbol": "example_orderVariableSymbol",
      "orderStatus": "example_orderStatus",
      "orderTotalPrice": "example_orderTotalPrice",
      "currencyCode": "example_currencyCode",
      "customerName": "example_customerName",
      "customerEmail": "example_customerEmail"
    }
  ],
  "totalCount": 0
}

Request example

GET /bff/voucher/usage-history

get
curl -X GET "https://api.bizkithub.com/bff/voucher/usage-history?code=SUMMER2024&limit=50&offset=0" \
  -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