Get Program Offers
This endpoint allows to get all program offers.
Request
GET <API base url>/offers
URL query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| language | string | yes | Two letter language code according to ISO 639-1 |
| take | uint32 | yes | Number of records to return (max 1000) |
| afterId | uint64 | no | Offer identifier |
Response
On success:
{
"value": required array of {
"id": required uint64,
"merchant": {
"id": required uint64,
"marketName": required string
},
"category": optional string,
"ad": optional {
"languageCode": required string,
"name": required string,
"description": optional string,
"rewardText": optional string
},
"reward": optional {
"merchant": {
"id": required uint64,
"marketName": required string
},
"type": required string (one of - discount, gift, certificate, plusX, etc.),
"certificate": optional {
"provider": required string,
"ids": optional array of string,
"value": optional number
},
"limit": optional {
"max": required number
}
},
"conditions": optional {
"type": required string (one of - none, offersAccumulation, transactionsAccumulation)
},
"startDate": optional string (date in format YYYY-MM-DD),
"endDate": optional string (date in format YYYY-MM-DD),
"announcedFrom": required date
}
}