Method "getProducts"
Use this method to get the list of available products. Please bear in mind that the catalogue is regularly updates and any field, except the id field, may vary.
Parameters: no
Response:
| id | Product ID |
| title | Product title |
| url | Product detail page URL |
| brief | Brief product/brand description |
| categories | List of product categories. See getCategories |
| faces | List of available denominations. 0 value means "flexible-denomination", i.e. any denomination between "face_min" and "face_max" may be requested (e.g. 550). |
| face_min, face_max | Minimum and maximum value in case of flexible-denomination |
| face_step | Step value in case of flexible-denomination |
| faces_description | A map where keys are denominations (numbers in string format) and values are brief descriptions of the corresponding denominations. |
| main_image | A key-value map of product images. At the moment it contains small, medium and large links to images. |
| image_url | Deprecated. URL to product image (can be used "http://" or "https://"). You shouldn't rely on it. It's going to be removed in the future. |
| disclaimer | Gift card rules and disclaimer (html) |
| digital_acceptance | Possibility of gift card to be redeemed in form of digital code (without printing on paper). - no — must be printed before acceptance- any — acceptance "by code"- eshop — acceptance "by code" only in e-shop- exchange — acceptance "by code" on Giftery web site - offline — acceptance "by code" only in offline stores |
| supplier_id | Product supplier ID |
| is_predefined_cert | Indicates that the product works with pre-generated (preloaded) codes |
| is_merchant_cert | Indicates that the product works with supplier codes (obtained from the supplier) |
| face_multiplier | Client discount/markup applied to the gift card denomination. Values below 1 mean a discount (e.g. 0.95), values above 1 mean a markup (e.g. 1.05). The amount of denomination * face_multiplier is charged from the client's balance. Rounding up or down may be applied. |
| www | Product website |
| certificates_in_one_purchase | Number of certificates in a single purchase (a number or null) |
| catalog_comment | Comment for the catalogue |
| activation_delay | Delay in business days between the purchase of the gift card and the moment it can be used in a store |
| number_of_uses | Number of gift card uses at a point of sale (store, website or app), in numeric format |
Example:
cmd: getProducts, data: {}
Response:
json
{
"status": "ok",
"data": [
{
"id": "2111",
"title": "Giftery card",
"url": "https://www.giftery.es/giftcards/gifterycard",
"brief": "The multibrand gift certificate “Giftery Card” offers maximum freedom of choice, as it can be exchanged for one or several certificates from our partners.",
"categories": [
29
],
"faces": [
0,
2000,
3000,
5000,
10000
],
"face_min": 1,
"face_max": 90000,
"face_step": 50,
"faces_description": {
"2000": "1000 miles",
"5000": "2500 miles"
},
"digital_acceptance": "any",
"disclaimer": "<ol><li>The multibrand gift certificate “Giftery Card” should be changed...",
"main_image": {
"small": "https://cdn.giftery.es/340x155/upload/iblock/4af/4af4b0a61c95083f35e807500b18b60f.jpg",
"medium": "https://cdn.giftery.es/680x310/upload/iblock/4af/4af4b0a61c95083f35e807500b18b60f.jpg",
"large": "https://cdn.giftery.es/1360x620/upload/iblock/4af/4af4b0a61c95083f35e807500b18b60f.jpg"
}
}
]
}