Skip to main content
Version: 1.01

List Products

GET /api/1.01/product

Retrieves a list of available products with filtering and pagination options

Optional Parameters

ParameterTypeRequiredDefaultDescription
slugStringNo-Filter by slug
brandSlugStringNo-Filter by brand Slug
categoryStringNo-Filter by category
redeemTypeStringNo-Filter by redeem type
redeemValueStringNo-Filter by redeem value
currencyStringNo-Filter by currency
sortByStringNofaceValueAmountSort by field. Options are: Price / name / brand / faceValueAmount
sortOrderStringNoASCOrder of sorting. Options are: ASC / DESC
limitStringNo-Number of results per page
pageStringNo-Page number

Example Request

curl -X GET https://connect.relograde.com/api/1.01/product?brandSlug=rewarble&currency=eur&limit=2 \
-H "Authorization: Bearer <token>"

Example Response

{
"data": [
{
"slug": "rewarble-variable-eur",
"name": "Rewarble Variable EUR",
"faceValueCurrency": "eur",
"isStocked": true,
"feeVariable": 1.02,
"feeFixed": 0.0,
"feeCurrency": "eur",
"redeemValue": "eur",
"brandSlug": "rewarble",
"category": "payment-card",
"redeemType": "currency",
"brandName": "Rewarble"
},
{
"slug": "rewarble-ww-eur-5",
"name": "rewarble 5 EUR WW",
"faceValueAmount": 5.0,
"faceValueCurrency": "eur",
"isStocked": true,
"priceAmount": 5.1,
"priceCurrency": "eur",
"redeemValue": "eur",
"brandSlug": "rewarble",
"category": "payment-card",
"redeemType": "currency",
"brandName": "Rewarble"
}
],
"pagination": {
"total": 11,
"page": 1,
"limit": 2,
"pages": 6
}
}

Response Fields

Field nameField typeField description
dataArrayArray of results
slugStringSlug of product
nameStringName of product
faceValueCurrencyStringCurrency of product
isStockedBooleanWhether the product is in stock or not
feeVariableDecimalFee percentage amount. 1.01 being 1%
feeFixedDecimalFixed fee amount
feeCurrencyStringCurrency of fee(s)
redeemValueStringThe region of the product
brandSlugStringThe slug of the brand of the product
categoryStringCategory of product
redeemTypeStringRedeem type of product
brandNameStringName of the product’s brand
faceValueAmountDecimalThe amount received when redeeming the product
priceAmountDecimalThe price of the product
priceCurrencyStringThe currency of priceAmount

Notes

note
  • Currency codes follow ISO 4217 standard
  • Price information may be provided either as fixed price or as fee.
  • Price information may have been altered in the documentation