List the products you can send
const url = 'https://api.1up.gift/products?page=1&limit=100';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.1up.gift/products?page=1&limit=100' \ --header 'Authorization: Bearer <token>'The catalogue is global, except for products restricted to named customers, which only those customers see. Results are paged, so this can back a picker as well as a plain listing.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”ISO 3166-1 alpha-2 country the gift will be sent for. Drives which gifts are redeemable and how physical gifts are priced. Defaults to GB.
Free-text filter on the product name.
Only return products priced in this currency.
Only return products that can be sent for this amount or less.
1-based page number.
Products per page, 1–200. Defaults to 100.
Responses
Section titled “Responses”The matching page of products.
A gift you can send: enough to identify it, price it and present it in a picker.
object
The product id. Pass it as productId when sending.
The product name.
Digital (e-voucher) vs a physical gift.
The currency the product is priced in.
The currency’s display prefix (e.g. “£”), so a caller can format amounts the same prefix-only way the Label does.
The fixed delivered total for a physical gift (marked-up cost + postage + VAT). Null for digital gifts, whose price is whatever amount the sender chooses.
The fixed amounts a digital gift can be sent at. Empty for physical gifts and for digital gifts that take any amount within a range (see MinAmount/MaxAmount).
The fixed denominations as ready-to-display picker choices: canonical numeric value (e.g. “25.00”) mapped to its prefix-formatted label (e.g. “£25.00”), matching how the 1UP web app shows them.
The bounds a digital gift’s amount must fall within. For fixed-denomination gifts these are the lowest and highest denomination; for custom-value gifts they are the allowed range; null when not applicable.
Whether the caller must supply an amount to send this gift. False when the amount is implied: physical gifts (intrinsic price) and digital gifts with a single possible denomination.
A ready-to-display label combining the name with its price context, for a picker.
A gift you can send: enough to identify it, price it and present it in a picker.
object
The product id. Pass it as productId when sending.
The product name.
Digital (e-voucher) vs a physical gift.
The currency the product is priced in.
The currency’s display prefix (e.g. “£”), so a caller can format amounts the same prefix-only way the Label does.
The fixed delivered total for a physical gift (marked-up cost + postage + VAT). Null for digital gifts, whose price is whatever amount the sender chooses.
The fixed amounts a digital gift can be sent at. Empty for physical gifts and for digital gifts that take any amount within a range (see MinAmount/MaxAmount).
The fixed denominations as ready-to-display picker choices: canonical numeric value (e.g. “25.00”) mapped to its prefix-formatted label (e.g. “£25.00”), matching how the 1UP web app shows them.
The bounds a digital gift’s amount must fall within. For fixed-denomination gifts these are the lowest and highest denomination; for custom-value gifts they are the allowed range; null when not applicable.
Whether the caller must supply an amount to send this gift. False when the amount is implied: physical gifts (intrinsic price) and digital gifts with a single possible denomination.
A ready-to-display label combining the name with its price context, for a picker.
Examplegenerated
[ { "id": 1, "name": "example", "isDigital": true, "currency": "example", "currencyPrefix": "example", "totalPrice": 1, "denominations": [ 1 ], "denominationChoices": "example", "minAmount": 1, "maxAmount": 1, "requiresAmount": true, "label": "example" }]A gift you can send: enough to identify it, price it and present it in a picker.
object
The product id. Pass it as productId when sending.
The product name.
Digital (e-voucher) vs a physical gift.
The currency the product is priced in.
The currency’s display prefix (e.g. “£”), so a caller can format amounts the same prefix-only way the Label does.
The fixed delivered total for a physical gift (marked-up cost + postage + VAT). Null for digital gifts, whose price is whatever amount the sender chooses.
The fixed amounts a digital gift can be sent at. Empty for physical gifts and for digital gifts that take any amount within a range (see MinAmount/MaxAmount).
The fixed denominations as ready-to-display picker choices: canonical numeric value (e.g. “25.00”) mapped to its prefix-formatted label (e.g. “£25.00”), matching how the 1UP web app shows them.
The bounds a digital gift’s amount must fall within. For fixed-denomination gifts these are the lowest and highest denomination; for custom-value gifts they are the allowed range; null when not applicable.
Whether the caller must supply an amount to send this gift. False when the amount is implied: physical gifts (intrinsic price) and digital gifts with a single possible denomination.
A ready-to-display label combining the name with its price context, for a picker.
Examplegenerated
[ { "id": 1, "name": "example", "isDigital": true, "currency": "example", "currencyPrefix": "example", "totalPrice": 1, "denominations": [ 1 ], "denominationChoices": "example", "minAmount": 1, "maxAmount": 1, "requiresAmount": true, "label": "example" }]