Use this endpoint to get information on products assigned to your reward store.
The following parameters are available to filter the products returned:
| Parameter | Example(s) | Notes |
|---|---|---|
| codes | XY-001,XY-002,AB-999 | Optional. Specify multiple comma separated. |
| countries | gb,im,je,gg | Optional. Only return products deliverable to these countries. Comma separated ISO 3166-1 alpha-2. |
| languages | en,fr,de | Optional. Only return the specified translations for the name and description fields. Note that not all languages are guaranteed to be present. Please see Getting Started for a list of available languages. If this field is omitted, all languages will be output. English (en) is always present. |
| per_page | 500 | How many products to return per page. Default 500, minimum 1, maximum 2000. |
| page | 4 | The page of paginated results to return. Default 1. |
{
"codes": "XY-001,XY-002,AB-999",
"countries": "gb,im,je,gg",
"languages": "en,fr,de",
"per_page": 800,
"page": 2
}
The output will contain the following fields:
| Field | Description |
|---|---|
| total | Total products across all pages. |
| per_page | Total products per page, set in the initial request. |
| current_page | Current page, set in the initial request. |
| last_page | The last page that contains results. |
| from | The starting product number for this page. |
| to | The last product number for this page. |
| data | Array of objects, each containing the product data. |
Each object in the data array will contain the following fields:
| Field | Description |
|---|---|
| code | The unique product code. |
| name | Object of name translations, keyed by the language code. |
| description | Object of product body description translations, keyed by the language code. |
| brand | Object containing code (unique identifier) and description (for display) properties. Null if product does not have a brand assigned. |
| subcategory | The subcategory code for this product. |
| currency | The currency the price and delivery rates are in. |
| price | The price for this product. |
| delivery | Object containing delivery rate objects for this product, keyed by the internal delivery rate number. Each delivery object has two properties: cost is the price, countries is a comma separated list of ISO 3166-1 alpha-2 country codes the rate applies to. |
| colour | Colour of the product, if applicable. Note the British English spelling of the field. |
| size | Size of the product, if applicable. |
| shape | Shape of the product, if applicable. |
| gtin | GTIN barcode number. |
| countryoforigin | Country of Origin. |
| core | Whether the product is a core line. |
| sustainable | Whether the product follows sustainable practises. |
| mains_plug | Whether the product contains a mains plug. |
Multiple Images are now available
For product images, please use the following URL: https://b2cdn.reward-store.co.uk/file/pilrewards-images/{product_code}.jpg
For example: https://b2cdn.reward-store.co.uk/file/pilrewards-images/XY-001.jpg
In cases where multiple imges are available these will be denoted with a '-1' to '-4' as below
https://b2cdn.reward-store.co.uk/file/pilrewards-images/XY-001.jpg
You are welcome to link directly to these images.
{
"total": 3200,
"per_page": 800,
"current_page": 2,
"last_page": 4,
"from": 801,
"to": 1600,
"data": [
{
"code": "XY-001",
"name": {
"en": "Example product",
"fr": "Exemple de produit",
"de": "Beispielprodukt"
},
"description": {
"en": "This is a description for an example product",
"fr": "Ceci est une description d'un exemple de produit"
},
"brand": {
"code": "EXAMPLE",
"description": "Example Brand"
},
"subcategory": "BOOKS003",
"currency": "gbp",
"price": "123.45",
"delivery": {
"1": {
"cost": "9.99"
"countries": "gb,im"
},
"2": {
"cost": "12.99"
"countries": "je,gg"
}
},
"colour": "Blue",
"size": "Large",
"shape": "Round",
"gtin": "0123456789012"
"countryoforigin": "CN",
"core": "Large",
"sustainable": "1",
"mains_plug": "1"
}
]
}