Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| shops | [Int] | Offers are valid for certain shop ids |
| name | String | A String value |
| from_date | Date | Date in YYYY-MM-DD |
| until_date | Date | Date in YYYY-MM-DD |
| valid_for | String | Offers are valid on either order date or acquire date. |
| recurring | Bool | Offers can be recurring within from_date and until_date |
| recurring_on | String | Optional. Offers can be recurring on a day of the week. |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| id | Int | An integer value |
| shops | [Int] | Offers are valid for certain shop ids |
| name | String | A String value |
| from_date | Date | Date in YYYY-MM-DD |
| until_date | Date | Date in YYYY-MM-DD |
| valid_for | String | Offers are valid on either order date or acquire date. |
| recurring | Bool | Offers can be recurring within from_date and until_date |
| recurring_on | String | Optional. Offers can be recurring on a day of the week. |
| items | [OfferItem] | Optional. Offers are applicable to categories, products or product prices |
When used inside a request.
{
"shops": [
15,
18,
15
],
"name": "...",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": false,
"recurring_on": "monday"
}When returned in a response.
{
"id": 11,
"shops": [
13,
13,
18
],
"name": "...",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": false,
"recurring_on": "monday",
"items": [
{
"applies_to": "category",
"item_id": 11,
"type": "percentage",
"id": 17,
"percentage": 14,
"minimum_amount": 10,
"free_amount": 13
},
{
"applies_to": "category",
"item_id": 10,
"type": "percentage",
"id": 15,
"percentage": 14,
"minimum_amount": 13,
"free_amount": 19
},
{
"applies_to": "category",
"item_id": 16,
"type": "percentage",
"id": 15,
"percentage": 18,
"minimum_amount": 10,
"free_amount": 15
}
]
}