Menu

End Point URL

https://api.ipos247.com/v1/service/menu  

Header

Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}

Parameter

Name	Data Type	Description
hotel_code *	INT	The unique identifier for the hotel. This is essential for retrieving relevant data.
outlet_name	String	The name of the specific outlet within the hotel. If not provided, the query will retrieve data from all outlets.

Request

{
    "hotel_code": "XXXX", // Required
    "outlet_name": "MainOutlet" // Optional
}

Response

Name	Data Type	Description
status	String	Status of the request, indicating whether it was successful.
statusCode	Integer	HTTP status code indicating the result of the request.
data	Object	Contains all data related to outlets, categories, subcategories, and items.
outlets	Array	Contains the list of outlets available in the hotel.
outlets.ref_id	Integer	Reference ID of the outlet.
outlets.outlet_name	String	Name of the outlet.
categories	Array	Contains the list of categories with names and reference IDs.
categories.ref_id	Integer	Reference ID of the category.
categories.category_name	String	Name of the category.
subcategories	Array	Contains the list of subcategories with names and reference IDs.
subcategories.ref_id	Integer	Reference ID of the subcategory.
subcategories.subcategory_name	String	Name of the subcategory.
items	Array	Contains the list of items with details like name, code, and price.
items.item_name	String	Name of the item.
items.item_code	String	Code of the item.
items.food_type	String	VEG, NONVEG, EGG
items.unit_price	items. description	Price of the item.
items.category_ref_id	Array of Strings	List of reference IDs corresponding to the categories.
items.subcategory_ref_id	Array of Strings	List of reference IDs corresponding to the subcategories.
items.outlet_ref_id	Array of Strings	List of reference IDs corresponding to the outlets.
items.description	String	Description of the item (if any).

Success

{
    "status": "success",
    "statusCode": 200,
    "data": {
        "outlets": [
            {
                "outlet_name": "MainOutlet",
                "ref_id": "10000000001"
            }
        ],
        "categories": [
            {
                "category_name": "Hot Drinks",
                "ref_id": "10000000001"
            },
            {
                "category_name": "Cold Drinks",
                "ref_id": "10000000002"
            },
            {
                "category_name": "Fresh Juice",
                "ref_id": "10000000003"
            },
            {
                "category_name": "Soft Drinks",
                "ref_id": "10000000004"
            }
        ],
        "subcategories": [
            {
                "subcategory_name": "Classic",
                "ref_id": "10000000001"
            },
            {
                "subcategory_name": "Coffee",
                "ref_id": "10000000002"
            },
            {
                "subcategory_name": "Tea",
                "ref_id": "10000000003"
            },
            {
                "subcategory_name": "Other Drinks",
                "ref_id": "10000000004"
            }
        ],
        "items": [
            {
                "item_name": "Blueberry",
                "Item Code": "376",
                "Unit Price": "75.2381",
                "category_ref_id": [
                    "10000000001"
                ],
                "subcategory_ref_id": [
                    "10000000001"
                ],
                "outlet_ref_id": [
                    "10000000001"
                ],
                "description": ""
            },
            {
                "item_name": "Double Apple",
                "Item Code": "377",
                "Unit Price": "75.2381",
                "category_ref_id": [
                    "10000000001"
                ],
                "subcategory_ref_id": [
                    "10000000001"
                ],
                "outlet_ref_id": [
                    "10000000001"
                ],
                "description": ""
            }
        ]
    }
}

Error

{
    "status": "warning",
    "statusCode": 400,
    "message": "Please Enter Valid Outlet Name"
}