Category.detailed

Request

Fields when send to the api inside a request.

Field Type Description
id Int Id of the category
name String Translated category name
banner Image? Nullable.
messages [String] Array of String
products [Product.detailed] Array of Product.detailed
seo company.SeoData Optional. Product page SEO metatags

Response

Fields when returned by the api in a response.

Field Type Description
id Int Id of the category
name String Translated category name
banner Image? Nullable.
messages [String] Array of String
products [Product.detailed] Array of Product.detailed
seo company.SeoData Optional. Product page SEO metatags

Examples

Request

When used inside a request.

Example 1

{
    "id": 18,
    "name": "Juwan Douglas",
    "banner": {
        "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
    },
    "messages": [
        "...",
        "...",
        "..."
    ],
    "products": [
        {
            "favourite": true
        },
        {
            "favourite": true
        },
        {
            "favourite": true
        }
    ],
    "seo": {
        "title": {
            "en": "Eligendi tenetur impedit nesciunt omnis ratione."
        },
        "description": {
            "en": "Voluptatum corporis quibusdam corporis itaque cum. Magnam inventore sunt quis rerum ea. Cumque corrupti vero expedita beatae id. Quaerat esse ad aut excepturi doloribus."
        },
        "url": {
            "en": "http://www.frami.biz/"
        }
    }
}

Response

When returned in a response.

Example 1

{
    "id": 11,
    "name": "Kamryn Conn",
    "banner": {
        "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
    },
    "messages": [
        "...",
        "...",
        "..."
    ],
    "products": [
        {
            "id": 10,
            "name": "...",
            "images": [
                {
                    "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
                },
                {
                    "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
                },
                {
                    "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
                }
            ],
            "price_type": "PER_UNIT",
            "target_price": false,
            "price": 11,
            "subtitle": "...",
            "description": "...",
            "allergens": [
                {
                    "id": 17,
                    "name": "Crustaceans"
                },
                {
                    "id": 13,
                    "name": "Celery"
                },
                {
                    "id": 15,
                    "name": "Sulphite"
                }
            ],
            "url": "https://example.com",
            "url_type": "none",
            "specialty": true,
            "favourite": true,
            "product_prices": [
                {
                    "id": 12,
                    "name": "...",
                    "price": 10
                },
                {
                    "id": 14,
                    "name": "...",
                    "price": 13
                },
                {
                    "id": 16,
                    "name": "...",
                    "price": 16
                }
            ],
            "optionsets": [
                {
                    "id": 11,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 16,
                            "name": "...",
                            "price_change": 18
                        },
                        {
                            "id": 19,
                            "name": "...",
                            "price_change": 18
                        },
                        {
                            "id": 18,
                            "name": "...",
                            "price_change": 11
                        }
                    ]
                },
                {
                    "id": 17,
                    "name": "...",
                    "allow_attachment": false,
                    "options": [
                        {
                            "id": 19,
                            "name": "...",
                            "price_change": 11
                        },
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 14
                        },
                        {
                            "id": 17,
                            "name": "...",
                            "price_change": 18
                        }
                    ]
                },
                {
                    "id": 11,
                    "name": "...",
                    "allow_attachment": false,
                    "options": [
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 19
                        },
                        {
                            "id": 16,
                            "name": "...",
                            "price_change": 18
                        },
                        {
                            "id": 16,
                            "name": "...",
                            "price_change": 18
                        }
                    ]
                }
            ],
            "min_max": {
                "amount": {
                    "minimum": 17,
                    "maximum": 17,
                    "suggested": 17
                },
                "weight": {
                    "minimum": 15,
                    "maximum": 15,
                    "suggested": 11
                },
                "persons": {
                    "minimum": 15,
                    "maximum": 14,
                    "suggested": 19
                }
            },
            "info": [
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                }
            ]
        },
        {
            "id": 17,
            "name": "...",
            "images": [
                {
                    "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
                },
                {
                    "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
                },
                {
                    "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
                }
            ],
            "price_type": "PER_UNIT",
            "target_price": true,
            "price": 14,
            "subtitle": "...",
            "description": "...",
            "allergens": [
                {
                    "id": 12,
                    "name": "Crustaceans"
                },
                {
                    "id": 15,
                    "name": "Peanut"
                },
                {
                    "id": 11,
                    "name": "Fish"
                }
            ],
            "url": "https://example.com",
            "url_type": "none",
            "specialty": false,
            "favourite": true,
            "product_prices": [
                {
                    "id": 15,
                    "name": "...",
                    "price": 16
                },
                {
                    "id": 14,
                    "name": "...",
                    "price": 16
                },
                {
                    "id": 10,
                    "name": "...",
                    "price": 11
                }
            ],
            "optionsets": [
                {
                    "id": 16,
                    "name": "...",
                    "allow_attachment": false,
                    "options": [
                        {
                            "id": 16,
                            "name": "...",
                            "price_change": 15
                        },
                        {
                            "id": 14,
                            "name": "...",
                            "price_change": 11
                        },
                        {
                            "id": 17,
                            "name": "...",
                            "price_change": 11
                        }
                    ]
                },
                {
                    "id": 16,
                    "name": "...",
                    "allow_attachment": false,
                    "options": [
                        {
                            "id": 14,
                            "name": "...",
                            "price_change": 12
                        },
                        {
                            "id": 10,
                            "name": "...",
                            "price_change": 11
                        },
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 17
                        }
                    ]
                },
                {
                    "id": 15,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 15,
                            "name": "...",
                            "price_change": 13
                        },
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 19
                        },
                        {
                            "id": 16,
                            "name": "...",
                            "price_change": 18
                        }
                    ]
                }
            ],
            "min_max": {
                "amount": {
                    "minimum": 19,
                    "maximum": 19,
                    "suggested": 18
                },
                "weight": {
                    "minimum": 18,
                    "maximum": 13,
                    "suggested": 15
                },
                "persons": {
                    "minimum": 16,
                    "maximum": 16,
                    "suggested": 16
                }
            },
            "info": [
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                }
            ]
        },
        {
            "id": 13,
            "name": "...",
            "images": [
                {
                    "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
                },
                {
                    "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
                },
                {
                    "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
                }
            ],
            "price_type": "PER_UNIT",
            "target_price": false,
            "price": 11,
            "subtitle": "...",
            "description": "...",
            "allergens": [
                {
                    "id": 16,
                    "name": "Sulphite"
                },
                {
                    "id": 19,
                    "name": "Fish"
                },
                {
                    "id": 14,
                    "name": "Crustaceans"
                }
            ],
            "url": "https://example.com",
            "url_type": "none",
            "specialty": false,
            "favourite": false,
            "product_prices": [
                {
                    "id": 12,
                    "name": "...",
                    "price": 16
                },
                {
                    "id": 12,
                    "name": "...",
                    "price": 17
                },
                {
                    "id": 10,
                    "name": "...",
                    "price": 11
                }
            ],
            "optionsets": [
                {
                    "id": 15,
                    "name": "...",
                    "allow_attachment": false,
                    "options": [
                        {
                            "id": 12,
                            "name": "...",
                            "price_change": 19
                        },
                        {
                            "id": 11,
                            "name": "...",
                            "price_change": 19
                        },
                        {
                            "id": 11,
                            "name": "...",
                            "price_change": 19
                        }
                    ]
                },
                {
                    "id": 17,
                    "name": "...",
                    "allow_attachment": true,
                    "options": [
                        {
                            "id": 10,
                            "name": "...",
                            "price_change": 17
                        },
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 16
                        },
                        {
                            "id": 19,
                            "name": "...",
                            "price_change": 19
                        }
                    ]
                },
                {
                    "id": 12,
                    "name": "...",
                    "allow_attachment": false,
                    "options": [
                        {
                            "id": 11,
                            "name": "...",
                            "price_change": 10
                        },
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 18
                        },
                        {
                            "id": 13,
                            "name": "...",
                            "price_change": 17
                        }
                    ]
                }
            ],
            "min_max": {
                "amount": {
                    "minimum": 13,
                    "maximum": 12,
                    "suggested": 11
                },
                "weight": {
                    "minimum": 14,
                    "maximum": 13,
                    "suggested": 18
                },
                "persons": {
                    "minimum": 16,
                    "maximum": 14,
                    "suggested": 13
                }
            },
            "info": [
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                },
                {
                    "name": "...",
                    "title": "...",
                    "text": "...",
                    "type": "HTML"
                }
            ]
        }
    ],
    "seo": {
        "title": {
            "en": "Ipsum laborum adipisci nulla omnis magni voluptatem sunt sunt quasi."
        },
        "description": {
            "en": "Consequatur quibusdam similique consequatur voluptatem ea dolores. Nulla et distinctio excepturi distinctio consequuntur dolor."
        },
        "url": {
            "en": "https://moore.org/maxime-omnis-repudiandae-provident-eveniet-iste-omnis.html"
        }
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.2.1 stable