🍔Importing catalog to honei

By facilitating direct catalog importation, honei enables third-party providers to effortlessly sync their menus, reducing manual work and ensuring a consistent user experience across all touchpoints.

The third party will need to provide honei's support team with a callback URL, which is where you will be notified once the catalog import is complete.

POST {base}/polling/universal/catalog

This request allows us to import a set of categories with their corresponding items and modifiers that will be displayed in honei.

Query Parameters

Name	Type	Description
truncate	Boolean	In case that we want to truncate venue's catalogs. We use this to differentiate an initial import from any subsequent changes made after the initial import as webhook,

Headers

Name	Type	Description
x-client-id*	String	The unique identifier for the authorized third party.
x-nonce*	String	The unique and random string generated by the third party for the request.
x-token*	String	The Base64-encoded hash of the nonce concatenated with the secret.
venue-api-key*	String	The unique identifier provided by the Honei support team for the specific venue.

200 Field verifications passed.

403: Forbidden Not valid headers

400: Bad Request Invalid body

Body

[{
    "id": "6728c87c-e493-4c72-80a3-428e2fab49fx",
    "name": "Drinks", 
    "isEnabled": true,
    "index": 0,
    "description": "Fresh drinks",
    "items": [
        {
            "id": "6728c87c-e493-4c72-80a3-428e2fab49bc",
            "name": "Coke",
            "img": "",
            "isEnabled": true,
            "price": 1.5,
            "type": "drinks",
            "allergens": [],
            "description": "35cl coke",
            "metadata": null,
            "modifiers": [
                {
                    "id": "6728c87c-e493-4c72-80a3-428e2fab49bd",
                    "label": "How would you like your Coca-Cola?",
                    "isEnabled": true,
                    "optionsLimit": {
                        "min": 0,
                        "max": 2
                    },
                    "options": [
                        {
                            "id": "6728c87c-e493-4c72-80a3-428e2fab49bf",
                            "name": "With ice",
                            "isEnabled": true,
                            "default": true,
                            "supl": 0.1
                        },
                        {
                            "id": "6728c87c-e493-4c72-80a3-428e2fab49bf",
                            "name": "With lemon",
                            "isEnabled": true,
                            "default": false,
                            "supl": 0
                        }
                    ]
                }
            ]
        },
        {
            "id": "id-combo-1",
            "name": "lunch menu",
            "description": "delicious lunch menu",
            "price": 10.99,
            "isEnabled": true,
            "index": 1,
            "img": "lunch-menu-image.jpg",
            "metadata": { "key": "value" },
            "printableName": "Lunch Menu Printable Name",
            "categories": [
                {
                    "label": "Appetizer",
                    "id": "cat-1",
                    "optionsLimit": { "min": 1, "max": 3 },
                    "isEnabled": true,
                    "items": [
                        {
                            "price": 1.99,
                            "id": "olives-1",
                            "name": "Olives 1",
                            "description": "delicious olives",
                            "isEnabled": true,
                            "index": 0,
                            "img": "olives.jpg",
                            "metadata": { "itemKey": "itemValue" },
                            "printableName": "Olives",
                            "promotionalTag": "hot",
                            "isEnabled": true,
                        },
                        {
                            "price": 2.99,
                            "id": "item-2",
                            "name": "jamón ibérico",
                            "description": "delicious jamón ibérico",
                            "isEnabled": true,
                            "index": 1,
                            "img": "jamon-ibérico.jpg",
                            "metadata": { "itemKey": "itemValue2" },
                            "printableName": "Jamón Ibérico",
                            "promotionalTag": "new",
                            "isEnabled": true,
                        }
                    ]
                },
                {
                    "label": "Starters",
                    "id": "cat-2",
                    "optionsLimit": { "min": 0, "max": 2 },
                    "isEnabled": true,
                    "items": [
                        {
                            "price": 0,
                            "id": "soup-3",
                            "name": "soup",
                            "description": "delicious soup",
                            "isEnabled": true,
                            "index": 0,
                            "img": "soup.jpg",
                            "metadata": { "itemKey": "itemValue3" },
                            "printableName": "Soup",
                            "promotionalTag": "",
                            "isEnabled": true,
                        }
                    ]
                }
            ]
        },
    ]
}]

Once the import is completed, the third party's server will be notified.