/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

3 total

Query · 3

codestringRequired

Voucher code to get usage history for.

limitstring

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

offsetstring

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

Request

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"

Response

Paginated voucher usage history.

{
  "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
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key