Introduction
Promotion model
Example
{
"id": 227,
"store_ids": [444],
"collection_id": 18,
"name": "SuperPromotion",
"description": "Special",
"usable_since": "2022-05-05T13:00:00.000000Z",
"usable_until": null,
"image": { "url": "https://cdn-files.dev.placewise.com/files/MkdCaUg4Rg" },
"url": "promotions/{id}",
"details": { "foo": "bar" }
}Definition
| Key | Type | Optional | Description |
|---|---|---|---|
| id | integer | no | |
| store_ids | integer | yes | ID of Stores |
| collection_id | integer | yes | ID of PromotionCollection |
| name | string | yes | Depends on X-Locale header |
| description | string | yes | Depends on X-Locale header |
| usable_since | datetime | yes | |
| usable_until | datetime | yes | |
| image | object | yes | |
| image.url | string (URL) | no | |
| url | string | yes | Address of the entity page within Website |
| details | object | no | Additional stuff |
PromotionCollection model
Example
{
"id": 17,
"title": "SuperCollection",
"description": "Special"
}Definition
| Key | Type | Nullable | Description |
|---|---|---|---|
| id | integer | no | |
| name | string | yes | Depends on X-Locale header |
| description | string | yes | Depends on X-Locale header |