MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Base URL

https://restronik.dev

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_API_KEY}".

Application

GET Menu Items

Example request:
curl --request GET \
    --get "https://restronik.dev/api/v1/application/menu-items" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


{
    "data": [
        {
            "id": 1,
            "translations": {
                "tr": {
                    "name": "Pizza",
                    "short_description": null,
                    "long_description": null
                },
                "en": {
                    "name": "Pizza",
                    "short_description": null,
                    "long_description": null
                }
            },
            "unit_type": "piece",
            "unit_quantity": 1,
            "category": {
                "id": 123,
                "is_active": 1,
                "is_hidden": 0,
                "translations": {
                    "tr": {
                        "name": "Pizzalar",
                        "description": null
                    }
                },
                "media": {
                    "image": [
                        {
                            "image_url": "http://127.0.0.1:8000/storage/156/conversions/Pizzalar-image-1024x1024.jpg",
                            "thumb_url": "http://127.0.0.1:8000/storage/156/conversions/Pizzalar-thumb-300x300.jpg",
                            "original_url": "http://127.0.0.1:8000/storage/156/Pizzalar.jpg",
                            "original_size": 541860
                        }
                    ]
                }
            },
            "plu": null,
            "barcode_number": null,
            "order": null,
            "is_open_priced": 0,
            "price": {
                "dinein_service": "53.00",
                "delivery_service": "53.00",
                "takeaway_service": "service disabled",
                "self_service": "service disabled",
                "room_service": "service disabled"
            },
            "tax_rate": "1.00",
            "has_not_allergen": 0,
            "allergens": [
                {
                    "id": 3,
                    "translations": {
                        "tr": {
                            "name": "Yumurta ve yumurta ürünleri",
                            "description": null
                        },
                        "en": {
                            "name": "Eggs and products thereof",
                            "description": null
                        }
                    }
                }
            ],
            "stock_status": 1,
            "is_hidden": 0,
            "sales_status": {
                "dinein_service": 1,
                "delivery_service": 1,
                "takeaway_service": "service disabled",
                "self_service": "service disabled",
                "room_service": "service disabled"
            },
            "calorie": null,
            "preparation_time": null,
            "recipe": null,
            "recipe_items": [
                {
                    "id": 149,
                    "is_removable": 0,
                    "translations": {
                        "tr": {
                            "name": "Acı Biber Sosu"
                        },
                        "de-AT": {
                            "name": "Pfeffersoße"
                        },
                        "en": {
                            "name": "Hot Pepper Sauce"
                        }
                    }
                },
                {
                    "id": 150,
                    "is_removable": 0,
                    "translations": {
                        "tr": {
                            "name": "Pizza Hamuru"
                        },
                        "de-AT": {
                            "name": "Pizzateig"
                        },
                        "en": {
                            "name": "Pizza Dough"
                        }
                    }
                }
            ],
            "stations": {
                "dinein_service": [
                    {
                        "id": 1,
                        "name": "Mutfak",
                        "printer": {
                            "id": 1,
                            "name": "Mutfak Yazıcısı",
                            "ip_address": "192.168.1.121",
                            "port": null,
                            "mac_address": "52:21:7F:EE:07:7E",
                            "serial_number": null,
                            "registration_number": null
                        }
                    },
                    {
                        "id": 4,
                        "name": "Bar",
                        "printer": {
                            "id": 3,
                            "name": "Bar Yazıcısı",
                            "ip_address": "192.168.1.123",
                            "port": null,
                            "mac_address": "29:A3:21:AB:34:7E",
                            "serial_number": null,
                            "registration_number": null
                        }
                    }
                ],
                "delivery_service": [
                    {
                        "id": 1,
                        "name": "Mutfak",
                        "printer": {
                            "id": 1,
                            "name": "Mutfak Yazıcısı",
                            "ip_address": "192.168.1.121",
                            "port": null,
                            "mac_address": "52:21:7F:EE:07:7E",
                            "serial_number": null,
                            "registration_number": null
                        }
                    },
                    {
                        "id": 5,
                        "name": "Alt Bar",
                        "printer": null
                    }
                ],
                "takeaway_service": "service disabled",
                "self_service": "service disabled",
                "room_service": "service disabled"
            },
            "modifiers": [
                {
                    "id": 2,
                    "type": "multiple",
                    "is_hidden": 0,
                    "is_required": null,
                    "min": null,
                    "max": null,
                    "translations": {
                        "tr": {
                            "title": "İlave Malzeme Tercihi"
                        }
                    },
                    "modifier_items": [
                        {
                            "id": 5,
                            "type": "text",
                            "price": "2.00",
                            "order": null,
                            "status": 1,
                            "default": 0,
                            "translations": {
                                "tr": {
                                    "name": "Mantar"
                                }
                            }
                        },
                        {
                            "id": 6,
                            "type": "text",
                            "price": "3.00",
                            "order": null,
                            "status": 1,
                            "default": 0,
                            "translations": {
                                "tr": {
                                    "name": "Mısır"
                                }
                            }
                        }
                    ]
                },
                {
                    "id": 3,
                    "type": "single",
                    "is_hidden": 0,
                    "is_required": 1,
                    "min": null,
                    "max": null,
                    "translations": {
                        "tr": {
                            "title": "Hamur Tercihi"
                        }
                    },
                    "modifier_items": [
                        {
                            "id": 8,
                            "type": "product",
                            "price": "0.00",
                            "order": null,
                            "status": 1,
                            "default": 0,
                            "translations": {
                                "tr": {
                                    "name": "İnce Hamur"
                                }
                            }
                        },
                        {
                            "id": 9,
                            "type": "product",
                            "price": "3.00",
                            "order": null,
                            "status": 1,
                            "default": 1,
                            "translations": {
                                "tr": {
                                    "name": "Kalın Hamur"
                                }
                            }
                        }
                    ]
                }
            ],
            "media": {
                "image": [
                    {
                        "image_url": "http://127.0.0.1:8000/storage/154/conversions/pizza-image-1024x1024.jpg",
                        "thumb_url": "http://127.0.0.1:8000/storage/154/conversions/pizza-thumb-300x300.jpg",
                        "original_url": "http://127.0.0.1:8000/storage/154/pizza.jpg",
                        "original_size": 1182145
                    }
                ]
            }
        }
    ]
}

Request   

GET api/v1/application/menu-items

Response

Response Fields

id  integer  

translations.{lang}.name  string  

translations.{lang}.short_description  string  

translations.{lang}.long_description  string  

unit_type  string  

responses: "piece", "mass"

unit_quantity  number  

category  object  

Check "Menu Item Category > Show"

plu  string  

barcode_number  string  

order  integer  

is_open_priced  boolean  

price.{service_type}  string  

responses: "NUMBER", "service disabled", "open priced"

tax_rate  string  

has_not_allergen  boolean  

allergens.id  integer  

allergens.translations.{lang}.name  string  

allergens.translations.{lang}.description  string  

stock_status  boolean  

is_hidden  boolean  

If TRUE then only waiters should see this data and customers shouldn't.

sales_status.{service_type}  string  

responses: "BOOL", "service disabled"

calorie  integer  

preparation_time  integer  

recipe  string  

recipe_items.id  integer  

recipe_items.is_removable  boolean  

recipe_items.translations.{lang}.name  string  

stations.{service_type}.id  integer  

stations.{service_type}.name  string  

stations.{service_type}.printer.id  integer  

stations.{service_type}.printer.name  string  

stations.{service_type}.printer.ip_address  string  

stations.{service_type}.printer.port  string  

stations.{service_type}.printer.mac_address  string  

stations.{service_type}.printer.serial_number  string  

stations.{service_type}.printer.registration_number  string  

modifiers.id  integer  

modifiers.type  string  

responses: "single", "multiple"

modifiers.is_hidden  boolean  

If TRUE then only waiters should see this data and customers shouldn't.

modifiers.is_required  boolean  

modifiers.min  integer  

modifiers.max  integer  

modifiers.translations.{lang}.title  string  

modifiers.modifier_items.id  integer  

modifiers.modifier_items.type  string  

responses: "text", "product"

modifiers.modifier_items.price  string  

modifiers.modifier_items.order  integer  

modifiers.modifier_items.status  boolean  

modifiers.modifier_items.defaul  boolean  

modifiers.modifier_items.translations.{lang}.name  string  

media.image.image_url  string  

Max resolution: 1024 x 1024 px

media.image.thumb_url  string  

Max resolution: 300 x 300 px

media.image.original_url  string  

media.image.original_size  integer  

GET Menu Item Categories

Example request:
curl --request GET \
    --get "https://restronik.dev/api/v1/application/menu-item-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


{
    "data": [
        {
            "id": 42,
            "is_active": 1,
            "is_hidden": 0,
            "translations": {
                "tr": {
                    "name": "Tatlılar",
                    "description": null
                },
                "en": {
                    "name": "Desserts",
                    "description": null
                }
            },
            "media": {
                "image": [
                    {
                        "image_url": "https://restronik.com/storage/156/conversions/Desserts-image-1024x1024.jpg",
                        "thumb_url": "https://restronik.com/storage/156/conversions/Desserts-thumb-300x300.jpg",
                        "original_url": "https://restronik.com/storage/156/Desserts.jpg",
                        "original_size": 541860
                    }
                ]
            }
        },
        {
            "id": 34,
            "is_active": 1,
            "is_hidden": 0,
            "translations": {
                "tr": {
                    "name": "Nargileler",
                    "description": null
                }
            },
            "media": {
                "image": []
            }
        }
    ]
}

Request   

GET api/v1/application/menu-item-categories

Response

Response Fields

id  integer  

is_active  boolean  

is_hidden  boolean  

If TRUE then only waiters should see this data and customers shouldn't.

translations.{lang}.name  string  

translations.{lang}.description  string  

media.image.image_url  string  

Max resolution: 1024 x 1024 px

media.image.thumb_url  string  

Max resolution: 300 x 300 px

media.image.original_url  string  

media.image.original_size  integer  

Flutter Restaurant

GET About

Restroid hakkında

Example request:
curl --request GET \
    --get "https://restronik.dev/api/v1/flutter-restaurant/Abouts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "about_id": "abt1",
        "about_title": "Restroid® Co.",
        "about_description": "Restaurant Management System",
        "about_email": "info@restroid.com",
        "about_phone": "+90 (850) 885 54 91",
        "about_website": "http://www.restroid.com",
        "ads_on": "0",
        "ads_client": "",
        "ads_slot": "",
        "analyt_on": "0",
        "analyt_track_id": "",
        "facebook": "",
        "google_plus": "",
        "instagram": "",
        "youtube": "",
        "pinterest": "",
        "twitter": "",
        "privacypolicy": "This Privacy Policy explains how your personal information is collected, used, and disclosed by #WEBSITE_NAME#.",
        "default_photo": {
            "img_id": "",
            "img_parent_id": "abt1",
            "img_type": "",
            "img_path": "https://restronik.com/assets/images/flutter-restaurant/about-1000x1000.jpg",
            "Img_width": "1000",
            "img_height": "1000",
            "img_desc": "",
            "added_date": "2022-03-19 03:00:00",
            "added_user_id": "",
            "updated_date": "2022-03-19 03:00:00",
            "updated_user_id": "",
            "is_default": "0"
        }
    }
]

Request   

GET api/v1/flutter-restaurant/Abouts

GET Categories

Example request:
curl --request GET \
    --get "https://restronik.dev/api/v1/flutter-restaurant/Categories?lang=architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "about_id": "abt1",
        "about_title": "Restroid® Co.",
        "about_description": "Restaurant Management System",
        "about_email": "info@restroid.com",
        "about_phone": "+90 (850) 885 54 91",
        "about_website": "http://www.restroid.com",
        "ads_on": "0",
        "ads_client": "",
        "ads_slot": "",
        "analyt_on": "0",
        "analyt_track_id": "",
        "facebook": "",
        "google_plus": "",
        "instagram": "",
        "youtube": "",
        "pinterest": "",
        "twitter": "",
        "privacypolicy": "This Privacy Policy explains how your personal information is collected, used, and disclosed by #WEBSITE_NAME#.",
        "default_photo": {
            "img_id": "randomId",
            "img_parent_id": "abt1",
            "img_type": "about",
            "img_path": "fmk",
            "Img_width": "1000",
            "img_height": "1000",
            "img_desc": "",
            "added_date": "2022-03-19 03:00:00",
            "added_user_id": "",
            "updated_date": "2022-03-19 03:00:00",
            "updated_user_id": "",
            "is_default": "0"
        }
    }
]

Request   

GET api/v1/flutter-restaurant/Categories

Query Parameters

lang  string optional  

GET Cod Types

Example request:
curl --request GET \
    --get "https://restronik.dev/api/v1/flutter-restaurant/Cod_types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


[
    {
        "about_id": "abt1",
        "about_title": "Restroid® Co.",
        "about_description": "Restaurant Management System",
        "about_email": "info@restroid.com",
        "about_phone": "+90 (850) 885 54 91",
        "about_website": "http://www.restroid.com",
        "ads_on": "0",
        "ads_client": "",
        "ads_slot": "",
        "analyt_on": "0",
        "analyt_track_id": "",
        "facebook": "",
        "google_plus": "",
        "instagram": "",
        "youtube": "",
        "pinterest": "",
        "twitter": "",
        "privacypolicy": "This Privacy Policy explains how your personal information is collected, used, and disclosed by #WEBSITE_NAME#.",
        "default_photo": {
            "img_id": "randomId",
            "img_parent_id": "abt1",
            "img_type": "about",
            "img_path": "fmk",
            "Img_width": "1000",
            "img_height": "1000",
            "img_desc": "",
            "added_date": "2022-03-19 03:00:00",
            "added_user_id": "",
            "updated_date": "2022-03-19 03:00:00",
            "updated_user_id": "",
            "is_default": "0"
        }
    }
]

Request   

GET api/v1/flutter-restaurant/Cod_types

Portal

GET Allergen Lists

Example request:
curl --request GET \
    --get "https://restronik.dev/api/v1/portal/allergens" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


{
    "data": [
        {
            "id": 1,
            "translations": {
                "tr": {
                    "name": "Gluten içeren tahıllar",
                    "description": "Gluten içeren tahıllar: buğday (ör. kılçıksız buğday ve kamut), çavdar, arpa, yulaf veya bunların hibrit türleri ve bunların ürünleri"
                },
                "en": {
                    "name": "Cereals containing gluten",
                    "description": "namely: wheat (such as spelt and khorasan wheat), rye, barley, oats or their hybridised strains, and products thereof, except: (a) wheat based glucose syrups including dextrose (b) wheat based maltodextrins (c) glucose syrups based on barley (d) cereals used for making alcoholic distillates including ethyl alcohol of agricultural origin"
                },
                "de-AT": {
                    "name": "Glutenhaltiges Getreide und daraus gewonnene Erzeugnisse",
                    "description": "z.B. Brot und Gebäck, Kuchen, Teigwaren, Suppen, Soßen, Paniermehl, Semmelbrösel, Wurstwaren, Backerbsen, Frischkornbreie, Desserts, Schokolade"
                }
            }
        },
        {
            "id": 2,
            "translations": {
                "tr": {
                    "name": "Kabuklular (Crustacea) ve bunların ürünleri",
                    "description": null
                },
                "en": {
                    "name": "Crustaceans and products thereof",
                    "description": null
                },
                "de-AT": {
                    "name": "Krebstiere und daraus gewonnene Erzeugnisse",
                    "description": "z.B. Feinkostsalate, Suppen, Soßen, Paella, Bouillabaisse, Sashimi, Surimi"
                }
            }
        }
    ]
}

Request   

GET api/v1/portal/allergens

Response

Response Fields

id  integer  

translations.{lang}.name  string  

translations.{lang}.description  string