We will update the API regularly to reflect the latest updates and changes, any changes will be listed by date below.
We have changed the structure of experiences retrieved with voucher redemptions /redeem/check view the changes here.
The endpoints for checking and redeeming a voucher have changed to make them more understandable.
Reversal of redemptions has been added - a new parameter is returned on redemption which can be passed back to reverse the redemption for any reason. (e.g. in the event of a void).
Additional data has been added to the Get Sales Data API. We are now including payment method values in a new field labelled payments,
Additional validation error added to /redeem call to better address scenario where unredeemed experiences exist but none are valid at the current site. No action required for integrations that directly return (or fallback to) the response message from 422 responses.
New endpoints have been added to the API:
Filters have been added to allow the filtering of vouchers in the /redeem/check and /redeem-unified endpoints. This is not added to the /redeem endpoint as it assumes the filters input will be used for decision-making in the integrations UI. More information about filters usage can be found in the filters documentation.
Redundant value parameter has been removed from the /redeem/reverse request specification.
New response value held_until has been added to the /redeem/check response
specification, null is returned if the voucher is not held.
New response value available_count has been added to the /vouchers response specification.
New option delivered for the status GET parameter has been added to the /fulfilment/jobs request specification.