Restaurant Menu Items Catalog

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

Query Parameters

NameTypeDescription

client_id*

number

Identifier provided by Onlinesales at the time of integration.

token*

string

Authentication token provided by Onlinesales at the time of integration

menu_items*

array

Array Of Menu Items. Each menu item should be uniquely identified by "id" parameter. If the menu item 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.

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

Sample API Call

curl --location --request POST 'https://services.onlinesales.ai/merchandiseFeedService/foodcommerce/menu_items' \
--header 'Content-Type: application/json' \
--data-raw '{
   "client_id": <CLIENT ID>,
   "token": "<YOUR TOKEN HERE>",
   "menu_items": [
       {
           "id": "30948997",
           "name": "Mexican Green Wave",
           "description": "Mexican herbs sprinkled on onion, capsicum, tomato & jalapeno",
           "product_category": "Pizza > Veg Pizza",
           "product_category_ids" : "1 > 98"
           "link": "https://www.test-foodcomm-marketplace.com/<product_link>", #if not available provide restaurant link
           "mobile_link": "https://www.my-foodcomm-marketplace.com/<product_link_mobile>",
           "image_link": "https://media.myfoodcomm.com/covers/30948997/5371a53c51d5f-21312313adb.jpg",
           "image_link_1": "https://media.myfoodcomm.com/covers/30948997/5371a53c51d5f-21312313adb.jpg",
           "image_link_2": "https://media.myfoodcomm.com/covers/30948997/5371a53c51d5f-21312313adb.jpg",
           "image_link_3": "https://media.myfoodcomm.com/covers/30948997/5371a53c51d5f-21312313adb.jpg",
           "brand": "Dominos",
           "brand_id": 1792,
           "availability": "in stock",
           "price": "USD 5.55",
           "sale_price": "USD 3.99",
           "restaurant_id": "RES-1779",
           "diet_categories" : ["veg"],
           "item_group_id" : "664",
           "cuisines" : ["Pizza"],
	   "is_popular" : true,
	   "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" : ""
       }
   ]
}'
ParametersData TypeCommentsRequired?

id

string

sku_id

Yes

name

string

Name of the item

Yes

description

string

Description of the item

Yes

product_category

string

Category of the item, in breadcrumb format Example: Pizza > Veg Pizza

Yes

product_category_ids

string

Category id the item belongs to, in breadcrumb format Example: 1 > 98

No

link

string

Link of the item

Yes

mobile_link

string

Deep link of the item for mobile

No

image_link

string

Link of the item's image

No

image_link_1

string

Link of the item's image

No

image_link_2

string

Link of the item's image

No

image_link_3

string

Link of the item's image

No

brand

string

Name of the brand the item belongs to

No

brand_id

string

Id of the brand the item belongs to

No

availability

string

Availability status of the item Example: in_stock; out_of_stock

Yes

price

string

Price of the item

Yes

sale_price

string

Discounted price of the item

No

restaurant_id

string

Id of the restaurant the items belongs to

Yes

diet_categories

array of string

Example: veg, non-veg, vegan

No

item_group_id

string

Id of the group item variants in your data

No

cuisines

array of string

Cuisines the item belongs to Example: Italian, Dessert

No

is_popular

boolean

Example: true; false

No

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

Any custom parameter

No

custom_label_1

string

Any custom parameter

No

custom_label_2

string

Any custom parameter

No

custom_label_3

string

Any custom parameter

No

custom_label_4

string

Any custom parameter

No

Last updated