Parameter | Type | Required? | Default | Description |
---|---|---|---|---|
scope | enum | no | standard | Determines the scope the API operates on. See Offers scoping |
Key | Type | Optional? | Description |
---|---|---|---|
stores | string[] | no (may be empty) | List of unique stores assigned to offers |
collections | Collection[] | no (may be empty) | List of unique collections assigned to offers - see Collection model |
activated_seconds_time | integer | no | Number of seconds the offers stays active after member uses it |
{
"stores": ["M&H", "Doo Doo"],
"collections": [
{
"id": 1000016,
"title": "Collection #1",
"description": null,
"offers_order": [1000115, 1000112, 1000114],
"files": [
{
"url": "https://offers-api.s3.eu-central-1.amazonaws.com/collection-1000016-collection_cover_default-original.jpg",
"width": 600,
"height": 300,
"kind": "collection_cover_default",
"size_type": "original"
},
{
"url": "https://offers-api.s3.eu-central-1.amazonaws.com/collection-1000016-collection_cover_default-thumbnail.jpg",
"width": 300,
"height": 150,
"kind": "collection_cover_default",
"size_type": "thumbnail"
},
{
"url": "https://offers-api.s3.eu-central-1.amazonaws.com/collection-1000016-collection_cover_default-base.jpg",
"width": 600,
"height": 300,
"kind": "collection_cover_default",
"size_type": "base"
}
]
}
],
"activated_seconds_time": 35
}