Skip to content

Get voucher history

/api/v1.0/LoyaltyVault/Account/{accountNumber}/Vouchers/{voucherId}/History

The API call returns the voucher history for a specific voucher number.

Request parameters

For the voucher history API call, the following additional parameter is added.

  • AccountNumber The loyalty vault account
  • VoucherId The voucher ID is a compulsory parameter as the voucher history is returned for the specific voucher. The field should be populated with the voucher serial number

Response

[
  {
    "dateTime": "2024-12-10T09:51:12.186Z",
    "operatorId": "string",
    "shopId": "string",
    "posId": "string",
    "receiptNr": "string",
    "status": "Created",
    "comment": "string"
  }
]
  • DateTime Date and time when the point movement occurred.
  • Operator ID The POS operator. For the web store, this could be blank.
  • ShopId The store ID. For the web store, this could be blank.
  • PosId The terminal ID where the transaction was created or blank for the web store.
  • Receiptnr The sales receipt number / Online order number.
  • Status The voucher status, e.g., Created, Active or Expired.
  • Comment Additional information for the movement, for example, that the voucher was ‘Auto converted’ or ‘Auto expired’.