# Restaurant Catalog

<mark style="color:green;">`POST`</mark> `https://services.onlinesales.ai/merchandiseFeedService/foodcommerce/restaurants`

#### Query Parameters

| Name                                          | Type   | Description                                                                                                                                                                                                                                                                                                    |
| --------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| client\_id<mark style="color:red;">\*</mark>  | number | Identifier provided by Onlinesales at the time of integration.                                                                                                                                                                                                                                                 |
| token<mark style="color:red;">\*</mark>       | string | Authentication token provided by Onlinesales at the time of integration                                                                                                                                                                                                                                        |
| restaurants<mark style="color:red;">\*</mark> | array  | <p>Array Of <strong>restaurants.</strong> <br>Each restaurant should be uniquely identified by "restaurant\_id" parameter.<br>If the restaurant is already present in OnlineSales system, it will be updated with the new values else it will be created.<br>For better response time use batch size of 50</p> |

{% tabs %}
{% tab title="200: OK " %}

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

{% endtab %}
{% endtabs %}

### Sample API Call&#x20;

```javascript
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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://foodcommerce-api-help.onlinesales.ai/catalog-sync/restaurant-catalog.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.