Restaurant Catalog

POST https://services.onlinesales.ai/merchandiseFeedService/foodcommerce/restaurants

Query Parameters

Name	Type	Description
client_id*	number	Identifier provided by Onlinesales at the time of integration.
token*	string	Authentication token provided by Onlinesales at the time of integration
restaurants*	array	Array Of restaurants. Each restaurant should be uniquely identified by "restaurant_id" parameter. If the restaurant is already present in OnlineSales system, it will be updated with the new values else it will be created. For better response time use batch size of 50

200: OK

{
   "status": "SUCCESS",
   "status_msg": "Request Submitted Successfully",
   "error": null,
}

Sample API Call

curl --location --request POST 'https://services.onlinesales.ai/merchandiseFeedService/foodcommerce/restaurants' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client_id": <CLIENT ID>,
    "token": "<YOUR TOKEN HERE>",
    "restaurants": [
        {
            "restaurant_id": "12345",
            "name": "Domino's Pizza, Balewadi",
            "latitude": 11.11,
            "longitude": 11.11,
            "address": "Shop 5-10",
            "city": "Pune",
            "locality": "Balewadi High Street",
            "area": "Balewadi",
            "state": "Maharastra",
            "country": "India",
            "zip_code": "12345",
            "restaurant_link": "https://test-food-commerce.com/dominos-balewadi-pune",
            "opening_hours": [
                {
                    "day_of_week": "MONDAY",
                    "end_hour": 20,
                    "end_minute": "ZERO",
                    "start_hour": 9,
                    "start_minute": "THIRTY"
                },
                {
                    "day_of_week": "TUESDAY",
                    "end_hour": 20,
                    "end_minute": "ZERO",
                    "start_hour": 9,
                    "start_minute": "THIRTY"
                }
            ],
            "diet_categories": ["veg", "vegan"],
            "cuisines": [
                "Pizza"
            ],
            "logo_url": "https://test-food-commerce.com/dominos-balewadi-pune/logo.png",
            "average_rating": "4",
            "parent_restaurant_id": 123,
            "parent_restaurant_name": "Domino's Pizza",
            "total_ratings": 100,
            "serving_area_ids": ["123","234"],
            "offer_text": [
                "50% off on your first order"
            ],
            "rt_restaurant_status": "open",
	    "custom_label_0" : "",
            "custom_label_1" : "",
            "custom_label_2" : "",
            "custom_label_3" : "",
            "custom_label_4" : "",
            "rt_custom_label_0" : "",
            "rt_custom_label_1" : "",
            "rt_custom_label_2" : "",
            "rt_custom_label_3" : "",
            "rt_custom_label_4" : ""
        }
    ]
}'

Restaurant Object

Parameter	Data Type	Comment	Required?
restaurant_id	string	Id of the restaurant	Yes
name	string	Name of the restaurant	Yes
latitude	string	Latitude of the restaurant's location	Yes
longitude	string	Longitude of the restaurant's location	Yes
address	string	Address of the restaurant's location	No
city	string	City the restaurant is located at	Yes
locality	string	Locality the restaurant is located at	Yes
area	string	Area the restaurant is located at	Yes
state	string	State the restaurant is located in	Yes
country	string	Country the restaurant is located in	Yes
zip_code	string	Zip code of the area the restaurant is located in	Yes
restaurant_link	string	Restaurant link	Yes
parent_restaurant_id	string	Id of the parent restaurant like chains eg. McDonalds, Starkbucks	No
parent_restaurant_name	string	Name of the parent restaurant like chains eg. McDonalds, Starkbucks	No
opening_hour	array of objects	Operating hours of the restaurant Example: [ { "day_of_week": "MONDAY", "end_hour": 20, "end_minute": "ZERO", "start_hour": 9, "start_minute": "THIRTY" } ] Possible values of day_ofweek: Monday Tuesday Wednesday Thursday Friday Saturday Possible values of start_minute and end_minute: ZERO FIFTEEN THIRTY FORTY_FIVE Possible values of start_hour and end_hour will be 0 to 24 both inclusive	No
diet_categories	array of string	Example: ["Veg", "Non-Veg", "Vegan"]	No
cuisines	array of string	Cuisine the restaurant serves Example: ["Italian", "Indian", "Chinese"]	Yes
logo_url	string	Url of the restaurant's logo	No
average_rating	string	Average rating of the restaurant Example: 5	No
total_ratings	string	Total ratings on the restaurant	No
serving_area_ids	array of string	Area id of the area the restaurant serves to Example: ["452","567", "991"]	Yes
offer_text	string	Any promotional offers by the restaurant Example: 50% off on your first order	No
rt_restaurant_status	string	Real time serving status of the restaurant.	Yes
rt_custom_label_0	string	Real time custom parameter if any	No
rt_custom_label_1	string	Real time custom parameter if any	No
rt_custom_label_2	string	Real time custom parameter if any	No
rt_custom_label_3	string	Real time custom parameter if any	No
rt_custom_label_4	string	Real time custom parameter if any	No
custom_label_0	string	Custom parameter if any	No
custom_label_1	string	Custom parameter if any	No
custom_label_2	string	Custom parameter if any	No
custom_label_3	string	Custom parameter if any	No
custom_label_4	string	Custom parameter if any	No