Corrections and Improvements in the Gift Card Hub API Reference

2022

October

We have updated the API Reference of the Gift Card Hub. For the Settlement and Cancellation endpoints, the path parameter `transactionID` was changed to `tId`. The `transactionID` used in other endpoints is an ID generated by VTEX, while `tId` is an ID generated by the Gift Card provider.

{"base64":" ","img":{"width":97,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","length":933,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/corrections-and-improvements-in-the-gift-card-hub-api-reference-0.png"}}

We have updated the API Reference of the Gift Card Hub. For the Settlement and Cancellation endpoints, the path parameter transactionID was changed to tId. The transactionID used in other endpoints is an ID generated by VTEX, while tId is an ID generated by the Gift Card provider. The endpoints with this change are:

get List All GiftCard Settlement Transactions
post Create GiftCard Settlement Transaction
get List All GiftCard Cancellation Transactions
post Create GiftCard Cancellation Transaction

Also, we added missing descriptions for the following parameters throughout the API:

giftCardProviderID
giftCardID
REST-Range
transactionID
tId