Promotion

The info about the shop promotion

Field Type Description
is_enabled Bool A boolean value
title String A String value
type String String enumarion of 'product', 'category'
id Int An integer value
custom_image_enabled Bool A boolean value
photo Image? Nullable.

Examples

Request

When used inside a request.

Example 1

{
    "is_enabled": false,
    "title": "...",
    "type": "product",
    "id": 19,
    "custom_image_enabled": false,
    "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": true
    }
}

Response

When returned in a response.

Example 1

{
    "is_enabled": true,
    "title": "...",
    "type": "product",
    "id": 19,
    "custom_image_enabled": false,
    "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": 11,
        "white_background": false
    }
}
1.9.0 stable