Dictionary

Set product or category in the spotlight.

Field Type Description
enable Bool A boolean value
title String A small message about the "promotion"
type String String enumarion of 'product', 'category'
id Int An integer value
photo Image? Nullable.

Examples

Request

When used inside a request.

Example 1 

{
    "enable": true,
    "title": "...",
    "type": "product",
    "id": 14,
    "photo": {
        "resolutions": [
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            },
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            },
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            }
        ],
        "white_background": false
    }
}

Response

When returned in a response.

Example 1 

{
    "enable": true,
    "title": "...",
    "type": "product",
    "id": 12,
    "photo": {
        "resolutions": [
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            },
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            },
            {
                "src": "https://example.com",
                "width": 600,
                "height": 350
            }
        ],
        "file_id": 13,
        "white_background": true
    }
}
This is a development version Do not use this version in production
1.10.0 development