v1.03

Order Resource

`Find Order`

Added · a new redemptionLink property to each orderline.

List endpoints (List Products, List Brands, Find All Orders) now return a consistent envelope when pagination parameters are supplied: the results live under data, and a new metadata object contains the pagination data.

{
  "data": [ /* results */ ],
  "metadata": {
    "page": 1,
    "pageSize": 50,
    "totalItems": 100,
    "totalPages": 2
  }
}

The metadata object contains:

Field	Description
`page`	Current page number
`pageSize`	Number of results per page
`totalItems`	Total number of matching results
`totalPages`	Total number of available pages

metadata is nullable and only present when pagination parameters are used.

Product Resource

`List Products`

Added · an optional paymentCurrency parameter that returns prices converted into a currency of your choice using our FX rates.
Added · an optional faceValue parameter to filter products by an exact face value.
Added · a metadata pagination object to the response (see Pagination).
Added · a priceInclVat property to each product, the price with VAT included, representing the final amount you'll actually be charged for the product after tax.

When paymentCurrency is supplied, these fields are added to each product in the response:

Field	Description
`paymentCurrency`	The currency prices are displayed in
`priceAmountInPaymentCurrency`	Fixed price converted to the payment currency
`priceInclVatInPaymentCurrency`	Price including VAT in the payment currency
`vatAmountInPaymentCurrency`	VAT amount in the payment currency
`faceValueMinInPaymentCurrency`	Variable-product minimum face value in the payment currency
`faceValueMaxInPaymentCurrency`	Variable-product maximum face value in the payment currency

Brand Resource

`List Brands`

Added · an optional name parameter to filter by brand name (case-insensitive).
Added · an optional redeemValue parameter to filter brands by a redeem value (e.g. amazon.co.uk).
Added · a metadata pagination object to the response (see Pagination).

FX Rates

`Get FX Rates`

New endpoint · retrieve our current exchange rates.

v1.03

On this page