API List

API Documentation

Environment

·   Staging  : https://api.hhstaging.dev.com/api/aoa/v1

LIST API

1. Authentication Private (https://app.clickup.com/9003122396/docs/8ca1fpw-15622/8ca1fpw-25662)

2. Restaurant Long-list Page

2**. Restaurant Detail Page**

Get Cities With Restaurant Active

Get Cities 

Request parameter

Response parameter

Example Request GET - {{ _.base_url }}/cities.json

Example Response

{
	"data": [
		{
			"id": "1",
			"type": "cities",
			"attributes": {
				"name": "Bangkok",
				"home_description": null,
				"icon": {
					"url": "https://hhstaging.hungryhub.com/uploads/city/icon/1/Bangkok.png"
				}
			}
		},
		{
			"id": "2",
			"type": "cities",
			"attributes": {
				"name": "Chiang Mai",
				"home_description": null,
				"icon": {
					"url": "https://hhstaging.hungryhub.com/uploads/city/icon/2/Chiangmai.png"
				}
			}
		}
	],
	"success": true,
	"message": null
}

Get Restaurants List

Get Restaurant List 

Path parameter

Response parameter

Example Request

{{ base_api }}/restaurants/search.json?page[size]=10&page[number]=1

Example Response

{
	"data": [
		{
			"id": "1555",
			"type": "restaurants",
			"attributes": {
				"lowest_ayce_price": "990฿",
				"lowest_pp_price": null,
				"lowest_xp_price": null,
				"lowest_hs_price": null,
				"lowest_bfp_price": null,
				"lowest_sm_price": null,
				"lowest_hah_price": null,
				"price_per_person": {
					"amount": "990.0",
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿"
				},
				"price_and_pricing_type": {
					"amount": 990,
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿",
					"pricing_type": "per_person"
				},
				"is_deleted": false,
				"lat": "13.805902",
				"lng": "100.524286",
				"largest_table": 10,
				"branch_id": 78,
				"min_party_size": 2,
				"name": "Orca Baker & Butcher Gateway Bangsue",
				"names": {
					"th": "Orca Baker & Butcher Lasalle's Avenue",
					"en": "Orca Baker & Butcher Gateway Bangsue"
				},
				"slug": "orca-baker-butcher-gateway-bangsue",
				"favorited": false,
				"allow_booking": true,
				"availability": "in stock",
				"reviews_score": 5.0,
				"reviews_count": 10,
				"map_location": "http://www.google.com/maps?q=13.805902,100.524286",
				"promoted_by_hh": true,
				"enable_big_group_feature": true,
				"location": "Lasalle",
				"primary_location": {
					"id": 315,
					"name": "Lasalle"
				},
				"cuisine": "Italian",
				"primary_cuisine": {
					"id": 8,
					"name": "Italian"
				},
				"image_cover_url": {
					"thumb": "",
					"large": "",
					"square": ""
				},
				"canonical_link": "https://hungryhub-build-staging.netlify.app/restaurants/orca-baker-butcher-gateway-bangsue?locale=th",
				"last_booking_was_made": "Tue, 15 Nov 2022 03:47:43 +0000",
				"total_covers": 96,
				"time_slots": {},
				"reservation_system_only": false,
				"phone": "023010210",
				"phone_for_delivery": "023010210"
			},
			"relationships": {
				"pictures": {
					"data": [
						{
							"id": "39832",
							"type": "restaurants-pictures"
						}
					]
				},
				"restaurant_packages": {
					"data": [
						{
							"id": "3576",
							"type": "restaurant-packages"
						},
						{
							"id": "3578",
							"type": "restaurant-packages"
						}
					]
				}
			}
		},
		{
			"id": "1554",
			"type": "restaurants",
			"attributes": {
				"lowest_ayce_price": "990฿",
				"lowest_pp_price": null,
				"lowest_xp_price": null,
				"lowest_hs_price": null,
				"lowest_bfp_price": null,
				"lowest_sm_price": null,
				"lowest_hah_price": null,
				"price_per_person": {
					"amount": "990.0",
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿"
				},
				"price_and_pricing_type": {
					"amount": 990,
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿",
					"pricing_type": "per_person"
				},
				"is_deleted": false,
				"lat": "13.741448",
				"lng": "100.511455",
				"largest_table": 10,
				"branch_id": 76,
				"min_party_size": 2,
				"name": "Ryoshi Sushi I'm Chinatown",
				"names": {
					"th": "เรียวชิ ซูชิ เกตเวย์ ไชน่าทาวน์",
					"en": "Ryoshi Sushi I'm Chinatown"
				},
				"slug": "ryoshi-sushi-i-m-chinatown",
				"favorited": false,
				"allow_booking": true,
				"availability": "in stock",
				"reviews_score": 5.0,
				"reviews_count": 1,
				"map_location": "http://www.google.com/maps?q=13.741448,100.511455",
				"promoted_by_hh": true,
				"enable_big_group_feature": true,
				"location": "Lasalle",
				"primary_location": {
					"id": 315,
					"name": "Lasalle"
				},
				"cuisine": "Japanese",
				"primary_cuisine": {
					"id": 11,
					"name": "Japanese"
				},
				"image_cover_url": {
					"thumb": "",
					"large": "",
					"square": ""
				},
				"canonical_link": "https://hungryhub-build-staging.netlify.app/restaurants/ryoshi-sushi-i-m-chinatown?locale=th",
				"last_booking_was_made": "Mon, 06 Jul 2020 08:18:26 +0000",
				"total_covers": 19,
				"time_slots": {},
				"reservation_system_only": false,
				"phone": "020666742",
				"phone_for_delivery": "020666742"
			},
			"relationships": {
				"pictures": {
					"data": [
						{
							"id": "39797",
							"type": "restaurants-pictures"
						},
						{
							"id": "39798",
							"type": "restaurants-pictures"
						}
					]
				},
				"restaurant_packages": {
					"data": [
						{
							"id": "3571",
							"type": "restaurant-packages"
						},
						{
							"id": "3573",
							"type": "restaurant-packages"
						}
					]
				}
			}
		}
	],
	"links": {
		"self": "/api/v5/restaurants/search.json?page%5Bnumber%5D=1&page%5Bsize%5D=2",
		"first": "/api/v5/restaurants/search.json?page%5Bnumber%5D=1&page%5Bsize%5D=2",
		"prev": null,
		"next": "/api/v5/restaurants/search.json?page%5Bnumber%5D=2&page%5Bsize%5D=2",
		"last": "/api/v5/restaurants/search.json?page%5Bnumber%5D=149&page%5Bsize%5D=2"
	},
	"success": true,
	"message": null,
	"meta_data": {
		"price_ranges": {},
		"total_restaurants": 2
	},
	"ads": {
		"data": []
	}
}

Get Restaurants By City (Bangkok)

Get Restaurant By city (bangkok) 

Path parameter

Response parameter (the response same as restaurant list) Response parameter

Example Request JSON

{
	"page": {
		"number": "1",
		"size": "2"
	},
	"minor_version": "{{ minor_version  }}",
	"sort": "new",
	"city_id": "1",
	"include_packages": false,
	"include_pictures": false,
	"preview_mode": false
}

Example Response (the response same as restaurant list)

{
	"data": [
		{
			"id": "1555",
			"type": "restaurants",
			"attributes": {
				"lowest_ayce_price": "990฿",
				"lowest_pp_price": null,
				"lowest_xp_price": null,
				"lowest_hs_price": null,
				"lowest_bfp_price": null,
				"lowest_sm_price": null,
				"lowest_hah_price": null,
				"price_per_person": {
					"amount": "990.0",
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿"
				},
				"price_and_pricing_type": {
					"amount": 990,
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿",
					"pricing_type": "per_person"
				},
				"is_deleted": false,
				"lat": "13.805902",
				"lng": "100.524286",
				"largest_table": 10,
				"branch_id": 78,
				"min_party_size": 2,
				"name": "Orca Baker & Butcher Gateway Bangsue",
				"names": {
					"th": "Orca Baker & Butcher Lasalle's Avenue",
					"en": "Orca Baker & Butcher Gateway Bangsue"
				},
				"slug": "orca-baker-butcher-gateway-bangsue",
				"favorited": false,
				"allow_booking": true,
				"availability": "in stock",
				"reviews_score": 5.0,
				"reviews_count": 10,
				"map_location": "http://www.google.com/maps?q=13.805902,100.524286",
				"promoted_by_hh": true,
				"enable_big_group_feature": true,
				"location": "Lasalle",
				"primary_location": {
					"id": 315,
					"name": "Lasalle"
				},
				"cuisine": "Italian",
				"primary_cuisine": {
					"id": 8,
					"name": "Italian"
				},
				"image_cover_url": {
					"thumb": "",
					"large": "",
					"square": ""
				},
				"canonical_link": "https://hungryhub-build-staging.netlify.app/restaurants/orca-baker-butcher-gateway-bangsue?locale=th",
				"last_booking_was_made": "Tue, 15 Nov 2022 03:47:43 +0000",
				"total_covers": 96,
				"time_slots": {},
				"reservation_system_only": false,
				"phone": "023010210",
				"phone_for_delivery": "023010210"
			},
			"relationships": {
				"pictures": {
					"data": [
						{
							"id": "39832",
							"type": "restaurants-pictures"
						}
					]
				},
				"restaurant_packages": {
					"data": [
						{
							"id": "3576",
							"type": "restaurant-packages"
						},
						{
							"id": "3578",
							"type": "restaurant-packages"
						}
					]
				}
			}
		},
		{
			"id": "1554",
			"type": "restaurants",
			"attributes": {
				"lowest_ayce_price": "990฿",
				"lowest_pp_price": null,
				"lowest_xp_price": null,
				"lowest_hs_price": null,
				"lowest_bfp_price": null,
				"lowest_sm_price": null,
				"lowest_hah_price": null,
				"price_per_person": {
					"amount": "990.0",
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿"
				},
				"price_and_pricing_type": {
					"amount": 990,
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿",
					"pricing_type": "per_person"
				},
				"is_deleted": false,
				"lat": "13.741448",
				"lng": "100.511455",
				"largest_table": 10,
				"branch_id": 76,
				"min_party_size": 2,
				"name": "Ryoshi Sushi I'm Chinatown",
				"names": {
					"th": "เรียวชิ ซูชิ เกตเวย์ ไชน่าทาวน์",
					"en": "Ryoshi Sushi I'm Chinatown"
				},
				"slug": "ryoshi-sushi-i-m-chinatown",
				"favorited": false,
				"allow_booking": true,
				"availability": "in stock",
				"reviews_score": 5.0,
				"reviews_count": 1,
				"map_location": "http://www.google.com/maps?q=13.741448,100.511455",
				"promoted_by_hh": true,
				"enable_big_group_feature": true,
				"location": "Lasalle",
				"primary_location": {
					"id": 315,
					"name": "Lasalle"
				},
				"cuisine": "Japanese",
				"primary_cuisine": {
					"id": 11,
					"name": "Japanese"
				},
				"image_cover_url": {
					"thumb": "",
					"large": "",
					"square": ""
				},
				"canonical_link": "https://hungryhub-build-staging.netlify.app/restaurants/ryoshi-sushi-i-m-chinatown?locale=th",
				"last_booking_was_made": "Mon, 06 Jul 2020 08:18:26 +0000",
				"total_covers": 19,
				"time_slots": {},
				"reservation_system_only": false,
				"phone": "020666742",
				"phone_for_delivery": "020666742"
			},
			"relationships": {
				"pictures": {
					"data": [
						{
							"id": "39797",
							"type": "restaurants-pictures"
						},
						{
							"id": "39798",
							"type": "restaurants-pictures"
						}
					]
				},
				"restaurant_packages": {
					"data": [
						{
							"id": "3571",
							"type": "restaurant-packages"
						},
						{
							"id": "3573",
							"type": "restaurant-packages"
						}
					]
				}
			}
		}
	],
	"links": {
		"self": "/api/v5/restaurants/search.json?page%5Bnumber%5D=1&page%5Bsize%5D=2",
		"first": "/api/v5/restaurants/search.json?page%5Bnumber%5D=1&page%5Bsize%5D=2",
		"prev": null,
		"next": "/api/v5/restaurants/search.json?page%5Bnumber%5D=2&page%5Bsize%5D=2",
		"last": "/api/v5/restaurants/search.json?page%5Bnumber%5D=149&page%5Bsize%5D=2"
	},
	"success": true,
	"message": null,
	"meta_data": {
		"price_ranges": {},
		"total_restaurants": 2
	},
	"ads": {
		"data": []
	}
}

Search Restaurants By Name

Path parameter

Response parameter

Example Request JSON

{
	"page": {
		"number": "1",
		"size": "2"
	},
	"minor_version": 3,
	"sort": "new",
	"name_like": "Cafe",
	"include_packages": false,
	"include_pictures": false,
	"preview_mode": false
}

Example Response JSON

{
	"data": [
		{
			"id": "1555",
			"type": "restaurants",
			"attributes": {
				"lowest_ayce_price": "990฿",
				"lowest_pp_price": null,
				"lowest_xp_price": null,
				"lowest_hs_price": null,
				"lowest_bfp_price": null,
				"lowest_sm_price": null,
				"lowest_hah_price": null,
				"price_per_person": {
					"amount": "990.0",
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿"
				},
				"price_and_pricing_type": {
					"amount": 990,
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿",
					"pricing_type": "per_person"
				},
				"is_deleted": false,
				"lat": "13.805902",
				"lng": "100.524286",
				"largest_table": 10,
				"branch_id": 78,
				"min_party_size": 2,
				"name": "Orca Baker & Butcher Gateway Bangsue",
				"names": {
					"th": "Orca Baker & Butcher Lasalle's Avenue",
					"en": "Orca Baker & Butcher Gateway Bangsue"
				},
				"slug": "orca-baker-butcher-gateway-bangsue",
				"favorited": false,
				"allow_booking": true,
				"availability": "in stock",
				"reviews_score": 5.0,
				"reviews_count": 10,
				"map_location": "http://www.google.com/maps?q=13.805902,100.524286",
				"promoted_by_hh": true,
				"enable_big_group_feature": true,
				"location": "Lasalle",
				"primary_location": {
					"id": 315,
					"name": "Lasalle"
				},
				"cuisine": "Italian",
				"primary_cuisine": {
					"id": 8,
					"name": "Italian"
				},
				"image_cover_url": {
					"thumb": "",
					"large": "",
					"square": ""
				},
				"canonical_link": "https://hungryhub-build-staging.netlify.app/restaurants/orca-baker-butcher-gateway-bangsue?locale=th",
				"last_booking_was_made": "Tue, 15 Nov 2022 03:47:43 +0000",
				"total_covers": 96,
				"time_slots": {},
				"reservation_system_only": false,
				"phone": "023010210",
				"phone_for_delivery": "023010210"
			},
			"relationships": {
				"pictures": {
					"data": [
						{
							"id": "39832",
							"type": "restaurants-pictures"
						}
					]
				},
				"restaurant_packages": {
					"data": [
						{
							"id": "3576",
							"type": "restaurant-packages"
						},
						{
							"id": "3578",
							"type": "restaurant-packages"
						}
					]
				}
			}
		},
		{
			"id": "1554",
			"type": "restaurants",
			"attributes": {
				"lowest_ayce_price": "990฿",
				"lowest_pp_price": null,
				"lowest_xp_price": null,
				"lowest_hs_price": null,
				"lowest_bfp_price": null,
				"lowest_sm_price": null,
				"lowest_hah_price": null,
				"price_per_person": {
					"amount": "990.0",
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿"
				},
				"price_and_pricing_type": {
					"amount": 990,
					"currency": "THB",
					"symbol": "฿",
					"format": "990฿",
					"pricing_type": "per_person"
				},
				"is_deleted": false,
				"lat": "13.741448",
				"lng": "100.511455",
				"largest_table": 10,
				"branch_id": 76,
				"min_party_size": 2,
				"name": "Ryoshi Sushi I'm Chinatown",
				"names": {
					"th": "เรียวชิ ซูชิ เกตเวย์ ไชน่าทาวน์",
					"en": "Ryoshi Sushi I'm Chinatown"
				},
				"slug": "ryoshi-sushi-i-m-chinatown",
				"favorited": false,
				"allow_booking": true,
				"availability": "in stock",
				"reviews_score": 5.0,
				"reviews_count": 1,
				"map_location": "http://www.google.com/maps?q=13.741448,100.511455",
				"promoted_by_hh": true,
				"enable_big_group_feature": true,
				"location": "Lasalle",
				"primary_location": {
					"id": 315,
					"name": "Lasalle"
				},
				"cuisine": "Japanese",
				"primary_cuisine": {
					"id": 11,
					"name": "Japanese"
				},
				"image_cover_url": {
					"thumb": "",
					"large": "",
					"square": ""
				},
				"canonical_link": "https://hungryhub-build-staging.netlify.app/restaurants/ryoshi-sushi-i-m-chinatown?locale=th",
				"last_booking_was_made": "Mon, 06 Jul 2020 08:18:26 +0000",
				"total_covers": 19,
				"time_slots": {},
				"reservation_system_only": false,
				"phone": "020666742",
				"phone_for_delivery": "020666742"
			},
			"relationships": {
				"pictures": {
					"data": [
						{
							"id": "39797",
							"type": "restaurants-pictures"
						},
						{
							"id": "39798",
							"type": "restaurants-pictures"
						}
					]
				},
				"restaurant_packages": {
					"data": [
						{
							"id": "3571",
							"type": "restaurant-packages"
						},
						{
							"id": "3573",
							"type": "restaurant-packages"
						}
					]
				}
			}
		}
	],
	"links": {
		"self": "/api/v5/restaurants/search.json?page%5Bnumber%5D=1&page%5Bsize%5D=2",
		"first": "/api/v5/restaurants/search.json?page%5Bnumber%5D=1&page%5Bsize%5D=2",
		"prev": null,
		"next": "/api/v5/restaurants/search.json?page%5Bnumber%5D=2&page%5Bsize%5D=2",
		"last": "/api/v5/restaurants/search.json?page%5Bnumber%5D=149&page%5Bsize%5D=2"
	},
	"success": true,
	"message": null,
	"meta_data": {
		"price_ranges": {},
		"total_restaurants": 2
	},
	"ads": {
		"data": []
	}
}

Filter Restaurants By Service Type (Dine In)

Path parameter

Response parameter(the response same as restaurant list)

Example Request JSON

{
	"page": {
		"number": "1",
		"size": "2"
	},
	"minor_version": 3,
	"sort": "new",
"service_type": "delivery", -> change this to "service_type": "dine_in" if you search dine in restaurant
	"include_packages": false,
	"include_pictures": false,
	"preview_mode": false
}

Example Response

(the response same as restaurant list)

Filter Restaurants By Service Type (Delivery)

Path parameter

Response parameter(the response same as restaurant list)

Example Request JSON

{
	"page": {
		"number": "1",
		"size": "2"
	},
	"minor_version": 3,
	"sort": "new",
"service_type": "delivery", -> change this to "service_type": "dine_in" if you search dine in restaurant
	"include_packages": false,
	"include_pictures": false,
	"preview_mode": false
}

Example Response

(the response same as restaurant list)

Filter Restaurants By Cuisines (Cuisine IDs)

Filter Restaurants By Cuisines (Cuisine IDs)

Path parameter

Response parameter(the response same as restaurant list)

Example Request JSON

{
	"page": {
		"number": "1",
		"size": "2"
	},
	"minor_version": 3,
	"sort": "new",
 "tag_ids": [191,37],
	"include_packages": false,
	"include_pictures": false,
	"preview_mode": false
}

Example Response

(the response same as restaurant list)

Filter Restaurants By Price Range (1000 - 15000)

Filter Restaurants By Price Range (1000 - 15000)

Path parameter

Response parameter(the response same as restaurant list)

Example Request JSON

{
	"page": {
		"number": "1",
		"size": "2"
	},
	"minor_version": 3,
	"sort": "new",
"price":{
	"operator": "between",
	"x": 1000,
	"y": 15000
},
	"include_packages": false,
	"include_pictures": false,
	"preview_mode": false
}

Example Response

(the response same as restaurant list)

Filter Restaurants By Package Type (All You Can Eat & Party Pack)

Get package type

Path parameter

Response parameter

Example Request: -

Example Response

{
	"data": [
		{
			"id": "1",
			"type": "package_type",
			"attributes": {
				"title": "All You Can Eat",
				"description": "สั่งได้ไม่อั้น ทานได้เต็มที่ ที่ร้านโปรดของคุณ!",
				"cover_img": {
					"url": "/uploads/package_type/cover_img/1/Frame_39852.png"
				},
				"color_code": "FBEE4D",
				"package_type_code": "ayce",
				"alt_text": null
			}
		},
		{
			"id": "2",
			"type": "package_type",
			"attributes": {
				"title": "Party Pack",
				"description": "ชุดอาหารสุดคุ้ม เลือกเมนูได้ตามที่ต้องการ แถมคุมงบได้ง่ายขึ้น!",
				"cover_img": {
					"url": "/uploads/package_type/cover_img/2/Group_40052.png"
				},
				"color_code": "00D3C2",
				"package_type_code": "pp",
				"alt_text": null
			}
		}
	],
	"success": true,
	"message": null
}

Get Locations By City (Bangkok)

Get All Locations

Path parameter

Response parameter

Example Request

{{ _.base_url }}/api/v5/locations.json?page[size]=100&page[number]=1&sort=name_asc

Example Response

{
	"data": [
		{
			"id": "324",
			"type": "locations",
			"attributes": {
				"name": "กัลปพฤกษ์",
				"name_en": "Kalapapruek",
				"total_restaurants": 312
			}
		},
		{
			"id": "386",
			"type": "locations",
			"attributes": {
				"name": "กาญจนาภิเษก",
				"name_en": "kanchanaphisek",
				"total_restaurants": 312
			}
		},
		{
			"id": "420",
			"type": "locations",
			"attributes": {
				"name": "กิ่งแก้ว",
				"name_en": "King Keaw",
				"total_restaurants": 312
			}
		},
		
		
	],
	"links": {
		"self": "/api/v5/locations.json?page%5Bnumber%5D=1&page%5Bsize%5D=100&page%5Bnumber%5D=1&page%5Bsize%5D=100&sort=name_asc",
		"first": "/api/v5/locations.json?page%5Bnumber%5D=1&page%5Bsize%5D=100&page%5Bnumber%5D=1&page%5Bsize%5D=100&sort=name_asc",
		"prev": null,
		"next": "/api/v5/locations.json?page%5Bnumber%5D=1&page%5Bsize%5D=100&page%5Bnumber%5D=2&page%5Bsize%5D=100&sort=name_asc",
		"last": "/api//v5/locations.json?page%5Bnumber%5D=1&page%5Bsize%5D=100&page%5Bnumber%5D=2&page%5Bsize%5D=100&sort=name_asc"
	},
	"success": true,
	"message": null
}

Get Locations By City (Bangkok)

Get All Cuisines

Path parameter

Response parameter

Example Request

{{ _.base_url }}/api/v5/cuisines.json?page[size]=100&page[number]=1&sort=name_asc

Example Response

{
	"data": [
		{
			"id": "454",
			"type": "cuisines",
			"attributes": {
				"name": "Staycation",
				"name_en": "Staycation",
				"total_restaurants": 312,
				"cover": {
					"url": "https://hhstaging.hungryhub.com/uploads/restaurant_tag/cover/454/bromo.jpeg",
					"thumb_url": "https://hhstaging.hungryhub.com/uploads/restaurant_tag/cover/454/bromo.jpeg"
				}
			}
		},
		{
			"id": "762",
			"type": "cuisines",
			"attributes": {
				"name": "Testing",
				"name_en": "Testing",
				"total_restaurants": 312,
				"cover": {
					"url": "https://hhstaging.hungryhub.com/uploads/restaurant_tag/cover/762/825.jpg",
					"thumb_url": "https://hhstaging.hungryhub.com/uploads/restaurant_tag/cover/762/825.jpg"
				}
			}
		},
		{
			"id": "14",
			"type": "cuisines",
			"attributes": {
				"name": "ก๋วยเตี๋ยว",
				"name_en": "Noodle",
				"total_restaurants": 312,
				"cover": {
					"url": "https://hhstaging.hungryhub.com/uploads/restaurant_tag/cover/14/cuisine-noodle.jpeg",
					"thumb_url": "https://hhstaging.hungryhub.com/uploads/restaurant_tag/cover/14/cuisine-noodle.jpeg"
				}
			}
		},
		
	],
	"links": {
		"self": "/api/v5/cuisines.json?page%5Bnumber%5D=1&page%5Bsize%5D=100&page%5Bnumber%5D=1&page%5Bsize%5D=100&sort=name_asc",
		"first": "/api/v5/cuisines.json?page%5Bnumber%5D=1&page%5Bsize%5D=100&page%5Bnumber%5D=1&page%5Bsize%5D=100&sort=name_asc",
		"prev": null,
		"next": null,
		"last": "/api/v5/cuisines.json?page%5Bnumber%5D=1&page%5Bsize%5D=100&page%5Bnumber%5D=1&page%5Bsize%5D=100&sort=name_asc"
	},
	"success": true,
	"message": null
}

Filter Restaurants By Locations (Location IDs)

Path parameter

Response parameter(the response same as restaurant list)

Example Request JSON

{
	"page": {
		"number": "1",
		"size": "2"
	},
	"minor_version": 3,
	"sort": "new",
"tag_ids": [191,37],
	"include_packages": false,
	"include_pictures": false,
	"preview_mode": false
}

Example Response

(the response same as restaurant list)

Get Locations By City (Bangkok)

Get Package Types

Get Package types

Path parameter

Response parameter

Example Request

{{ _.base_url }}/api/v5/package_types.json?city_id=1

Example Response

{
	"data": [
		{
			"id": "1",
			"type": "package_type",
			"attributes": {
				"id": 1,
				"title": "All You Can Eat",
				"description": "Unlimited dining at your favorite restaurants!",
				"cover_img": {
					"url": "https://hhstaging.hungryhub.com/uploads/package_type/cover_img/1/preview-gallery-Frame_3981__1_.png"
				},
				"color_code": "FBEE4D",
				"package_type_code": "ayce",
				"alt_text": "text in en"
			}
		},
		{
			"id": "2",
			"type": "package_type",
			"attributes": {
				"id": 2,
				"title": "Party Pack",
				"description": "Pick and choose from a large menu at a controlled price!",
				"cover_img": {
					"url": "https://hhstaging.hungryhub.com/uploads/package_type/cover_img/2/PP.png"
				},
				"color_code": "00D3C2",
				"package_type_code": "pp",
				"alt_text": "Coba"
			}
		},
		{
			"id": "3",
			"type": "package_type",
			"attributes": {
				"id": 3,
				"title": "Xperience",
				"description": "Pair dining deals with your favorite experiences!",
				"cover_img": {
					"url": "https://hhstaging.hungryhub.com/uploads/package_type/cover_img/3/XP.png"
				},
				"color_code": "8FDCE4",
				"package_type_code": "xp",
				"alt_text": null
			}
		},
		{
			"id": "4",
			"type": "package_type",
			"attributes": {
				"id": 4,
				"title": "Hungry Lunch",
				"description": "Pair dining deals with your favorite experiences!",
				"cover_img": {
					"url": "https://hhstaging.hungryhub.com/uploads/package_type/cover_img/4/default-restaurant-logo.png"
				},
				"color_code": "6ABFFF",
				"package_type_code": "hs",
				"alt_text": null
			}
		},
		{
			"id": "5",
			"type": "package_type",
			"attributes": {
				"id": 5,
				"title": "Buffet Plus",
				"description": "Special buffets with exclusive perks!",
				"cover_img": {
					"url": "https://hhstaging.hungryhub.com/uploads/package_type/cover_img/5/BY.png"
				},
				"color_code": "FFAA4B",
				"package_type_code": "bfp",
				"alt_text": null
			}
		},
		{
			"id": "7",
			"type": "package_type",
			"attributes": {
				"id": 7,
				"title": "Hungry@Home",
				"description": "Exclusive deals ready for delivery and self pick-up!",
				"cover_img": {
					"url": "https://hhstaging.hungryhub.com/uploads/package_type/cover_img/7/HH__1_.png"
				},
				"color_code": "BC64FF",
				"package_type_code": "hah",
				"alt_text": null
			}
		}
	]
}

Get Detail Booking Based On UUID

Path parameter

Response parameter

Example Request

curl --request GET \
  --url https://hhstaging.hungryhub.com/api/v5/reservations/555026.json \
  --header 'Content-Type: application/json' \
  --header 'X-HH-Language: en-US' \
  --data '{

		"token": "M2Y4N2ZiYjljLTgxYTUtMTFlZC1hMWViLTAyNDJhYzEyMDAwMg=="

}'

Example Response

{
	"data": {
		"id": "539495",
		"type": "reservations",
		"attributes": {
			"restaurant_id": 816,
			"date": "2021-03-05",
			"name": monyta,
			"special_request": "กระเพราเนื้อไม่ใส่น้ำมันนะครับ ผัดน้ำเปล่าเลยครับ ( แกงเขียวหวานไก่ (พร้อมข้าวสวยหอมมะลิ) X1,ข้าวกะเพราเนื้อวากิว + ไข่ออนเซ็น X1,สลัดซีซ่าร์ X1,ซุปเห็ดทรัฟเฟิล 1 ถ้วย + ขนมปังกระเทียม X1,สเต๊กปลาแซลมอน เสิร์ฟพร้อมซอสเทอริยากิ X1,กุ้งแม่น้ำย่าง 4 ตัว + น้ำจิ้มซีฟู้ด X1,ช็อคโกแลตลาวา เสิร์ฟพร้อมซอสราสเบอร์รี่ X1)",
			"adult": 1,
			"kids": 0,
			"qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAfQAAAH0AQAAAADjreInAAACE0lEQVR4nO3cQW7CMBBAURsq0R3cINwkvVnIzcpNyA3Krkilbjy2aztEFRIJxeh70ybhaVhZ48kMC3PT+lio2xYej8fj8Xg8Ho/H4/F4PP5Kb3S2Xuy9cLFRp/zpZvr4eDy+aB/Lup9KNhR3cZCHy/j0MFN8PB5fsm+T7KLfPbTeqb3e+oc+Q3mbMT4ej38i3+omSzfuHR+Px5fsY/7xP/HxeHwhvnFNbfK/1D92qv694csh7zPGx+Pxpfr4fuU1/UgnBZFzfLqdKT4ejy/U67yx/kvuSf207vOP1aDtfvr4eDz+CXzns4xlOK50vv/DfzQviDze98fj8Xf3Rmv3/nbbX6xi/lGn6YbdVxr6P/B4/KivZXc4uf5TWz/N+j/sjVAQmSc+Ho8v09v9ofXljiT/2Pfbha1/fKcFkTni4/H4Qn2/d9g/druozFGvzNmlGzH/kE80viAyeXw8Hl+0d6eTaph/HNQxDNS5VZF/4PH41I/N34b8Yy0DdX65A83k8fF4fNE+n7+V5eZfjnptTvH9LfUPPB5/6dP5WxXLpclAv52/pf6Bx+P/9r5cauS4Yl/oyu7B/Asej7/Kh4JqJwMxvsOsoX8dj8eP+GYw3eIPNFV/flna/o/8he708fF4fKn+Yv429K+7/MN3iNB/isfjB35s/jb83Mc63LjMUB7m++PxeDwej8fj8Xg8Ho/H40fXD9X1YqrKyLVOAAAAAElFTkSuQmCC",
			"phone": "+66857732771",
			"email": "hihihi@gmail.com",
			"service_type": "dine_in",
			"service_type_humanize": "Dine In",
			"delivery_address_humanize": null,
			"distance_to_restaurant": null,
			"encrypted_id": "6gmO1",
			"qr_code_for_payment": null,
			"charge_price": 2980,
			"total_price": 1000,
			"charge_amount_type": "relative",
			"charge_percent": 100,
			"charge_type": "on_charge",
			"delivery_fee_in_baht": "0",
			"delivery_fee_per_km_in_baht": "20",
			"skip_start_time": false,
			"true_wallet_url": "",
			"shopee_pay_url": "",
			"corporate_event_id": null,
			"reservation_encrypted_id": "6gmO1",
			"partner_user_id": null
		}
	},
	"success": true
}

Get Booking Histories

Path parameter

Response parameter

Example Request

curl --request GET \
  --url https://hhstaging.hungryhub.com/api/v5/reservations/history.json \
  --header 'Content-Type: application/json' \
  --header 'X-HH-Language: en-US' \
  --data '{
	"token": "M2Y4N2ZiYjljLTgxYTUtMTFlZC1hMWViLTAyNDJhYzEyMDAwMg=="
}'

Example Response

{
	"data": [
		{
			"id": "555026",
			"type": "reservation",
			"attributes": {
				"id": 555026,
				"restaurant_id": 643,
				"date": "2022-11-18",
				"name": "Monyta",
				"special_request": "",
				"adult": 2,
				"kids": 0,
				"phone": "+66628212472",
				"email": "monyta@hungryhub.com",
				"service_type": "dine_in",
				"service_type_humanize": "Dine In",
				"delivery_address_humanize": null,
				"distance_to_restaurant": "0.0",
				"encrypted_id": "y3J8P",
				"qr_code_for_payment": null,
				"charge_price": 1780,
				"total_price": 1780,
				"charge_amount_type": "relative",
				"charge_percent": 100,
				"charge_type": "on_charge",
				"delivery_fee_in_baht": "0",
				"delivery_fee_per_km_in_baht": "10",
				"skip_start_time": false,
				"true_wallet_url": "",
				"shopee_pay_url": "",
				"corporate_event_id": null,
				"reservation_encrypted_id": "y3J8P",
				"aoa_user_id": "3f87fbb9c-81a5-11ed-a1eb-0242ac120002",
				"delivery_fee": {
					"amount": 0,
					"format": "฿0",
					"currency": "THB"
				},
                "image_cover_url": {
					"thumb":              "https://images.hungryhub.com/uploads/restaurants/3958/photos/99187/RackMultipart20230621-211-1r7uiyi.jpg",
					"large": "https://images.hungryhub.com/uploads/restaurants/3958/photos/99187/RackMultipart20230621-211-1r7uiyi.jpg",
					"square": "https://images.hungryhub.com/uploads/restaurants/3958/photos/99187/RackMultipart20230621-211-1r7uiyi.jpg"
				},
				"original_delivery_fee": {
					"amount": 0,
					"format": "฿0",
					"currency": "THB"
				},
				"start_time": "18:15",
				"status": "Arrived",
				"status_as_symbol": "arrived",
				"share_url": "https://hhstaging.hungryhub.com/share-to-friends.html?reservation_id=y3J8P",
				"modify_url": "https://hhstaging.hungryhub.com/reservations/my-reservation/y3J8P.html",
				"estimation_delivered_at": "",
				"driver_tracking_link": "",
				"review_url": "https://hhstaging.hungryhub.com/bookings/y3J8P/reviews/new.html",
				"packages": [
					{
						"name": "Mojjo All You Can Eat with Free Flow Mocktail",
						"amount": "890.0",
						"net_price": "฿890",
						"quantity": 1,
						"id": 1149,
						"is_add_on": false,
						"pricing_type": "per_person",
						"sections": [],
						"kids_price_rate": 50,
						"kids_price_v2": [
							{
								"price_policy": "Height not over 80 cm",
								"price_value": "Free"
							},
							{
								"price_policy": "Height between 81-100 cm",
								"price_value": "฿99"
							},
							{
								"price_policy": "Height between 101-130 cm",
								"price_value": "฿445"
							}
						],
						"use_kids_price": true,
						"rules": [
							{
								"price_description": "",
								"price": "฿900",
								"min_seat": 2,
								"max_seat": "Infinity",
								"per_pack": 1,
								"duration": 90
							}
						],
						"skip_time_selection": false,
						"is_accept_many_quantity": false,
						"custom_net_price": ""
					}
				],
				"delivery_status": "",
				"driver": {},
				"price_amount": "1780.0",
				"price_currency": "THB",
				"type": "All You Can Eat",
				"pricing_type": "per_person",
				"type_short": "ayce",
				"restaurant_name": "Mojjo Rooftop Lounge & Bar",
				"restaurant_name_en": "Mojjo Rooftop Lounge & Bar",
				"my_rating": 0,
				"hungry_points": 25,
				"has_prepayment": false,
				"used_vouchers": [],
				"payment_type": null,
				"redeemed_points": 0,
				"dining_occasion": "",
				"map_location": "http://www.google.com/maps?q=13.729206,100.569088"
			}
		}
	],
	"metadata": {
		"scaffold_url": "https://hhstaging.hungryhub.com/api/v5/reservations/history.json?page=__pagy_page__",
		"first_url": "https://hhstaging.hungryhub.com/api/v5/reservations/history.json?page=1",
		"prev_url": "https://hhstaging.hungryhub.com/api/v5/reservations/history.json?page=",
		"page_url": "https://hhstaging.hungryhub.com/api/v5/reservations/history.json?page=1",
		"next_url": "https://hhstaging.hungryhub.com/api/v5/reservations/history.json?page=",
		"last_url": "https://hhstaging.hungryhub.com/api/v5/reservations/history.json?page=1",
		"count": 1,
		"page": 1,
		"items": 1,
		"vars": {
			"page": 1,
			"items": 20,
			"outset": 0,
			"size": [
				1,
				4,
				4,
				1
			],
			"page_param": "page",
			"params": {},
			"anchor": "",
			"link_extra": "",
			"i18n_key": "pagy.item_name",
			"cycle": false,
			"metadata": [
				"scaffold_url",
				"first_url",
				"prev_url",
				"page_url",
				"next_url",
				"last_url",
				"count",
				"page",
				"items",
				"vars",
				"pages",
				"last",
				"from",
				"to",
				"prev",
				"next",
				"series"
			],
			"steps": false,
            "overflow": "empty_page",
			"count": 1
		},
		"pages": 1,
		"last": 1,
		"from": 1,
		"to": 1,
		"prev": null,
		"next": null,
		"series": [
			"1"
		]
	}
}

Get Reservation Detail

Path parameter

Response parameter

Example Response

{
	"data": {
		"id": "555026",
		"type": "reservation",
		"attributes": {
			"id": 555026,
			"restaurant_id": 643,
			"date": "2022-11-18",
			"name": "Monyta",
			"special_request": "",
			"adult": 2,
			"kids": 0,
			"phone": "66628212472",
			"email": "monyta@hungryhub.com",
			"service_type": "dine_in",
			"service_type_humanize": "Dine In",
			"delivery_address_humanize": null,
			"distance_to_restaurant": "0.0",
			"encrypted_id": "y3J8P",
			"qr_code_for_payment": null,
			"charge_price": 1780,
			"total_price": 1780,
			"charge_amount_type": "relative",
			"charge_percent": 100,
			"charge_type": null,
			"delivery_fee_in_baht": "0",
			"delivery_fee_per_km_in_baht": "10",
			"skip_start_time": false,
			"true_wallet_url": "",
			"shopee_pay_url": "",
			"corporate_event_id": null,
			"reservation_encrypted_id": "y3J8P",
			"partner_user_id": "3f87fbb9c-81a5-11ed-a1eb-0242ac120002",
			"delivery_fee": {
				"amount": 0,
				"format": "฿0",
				"currency": "THB"
			},
			"original_delivery_fee": {
				"amount": 0,
				"format": "฿0",
				"currency": "THB"
			},
			"start_time": "18:15",
			"status": "Arrived",
			"status_as_symbol": "arrived",
			"share_url": "https://hhstaging.hungryhub.com/share-to-friends.html?reservation_id=y3J8P",
			"modify_url": "https://hhstaging.hungryhub.com/reservations/my-reservation/y3J8P.html",
			"estimation_delivered_at": "",
			"driver_tracking_link": "",
			"review_url": "https://hhstaging.hungryhub.com/bookings/y3J8P/reviews/new.html",
			"packages": [
				{
					"name": "Mojjo All You Can Eat with Free Flow Mocktail",
					"amount": "890.0",
					"net_price": "฿890",
					"quantity": 1,
					"id": 1149,
					"is_add_on": false,
					"pricing_type": "per_person",
					"sections": [],
					"kids_price_rate": 50,
					"kids_price_v2": [
						{
							"price_policy": "Height not over 80 cm",
							"price_value": "Free"
						},
						{
							"price_policy": "Height between 81-100 cm",
							"price_value": "฿99"
						},
						{
							"price_policy": "Height between 101-130 cm",
							"price_value": "฿445"
						}
					],
					"use_kids_price": true,
					"rules": [
						{
							"price_description": "",
							"price": "฿900",
							"min_seat": 2,
							"max_seat": "Infinity",
							"per_pack": null,
							"duration": 90
						}
					],
					"skip_time_selection": null,
					"is_accept_many_quantity": false,
					"custom_net_price": ""
				}
			],
			"delivery_status": "",
			"driver": {},
			"price_amount": "1780.0",
			"price_currency": "THB",
			"type": "All You Can Eat",
			"pricing_type": "per_person",
			"type_short": "ayce",
			"restaurant_name": "Mojjo Rooftop Lounge & Bar",
			"restaurant_name_en": "Mojjo Rooftop Lounge & Bar",
			"my_rating": 0,
			"hungry_points": 17,
			"has_prepayment": false,
			"used_vouchers": [],
			"payment_type": null,
			"redeemed_points": 0,
			"dining_occasion": "",
			"map_location": "http://www.google.com/maps?q=13.729206,100.569088"
		}
	}
}

Get Detail Restaurant

Path parameter

Response parameter

Example Request

{{ _.base_url }}/api/v5/restaurants/32.json

Example Response

{
	"data": { -> object
		"id": "32", -> integer
		"type": "restaurants", -> string
		"attributes": { -> object
			"price_and_pricing_type": { -> object
				"amount": 0, -> integer
				"currency": "THB", -> string
				"symbol": "฿",  -> string
				"format": "0฿",  -> string
				"pricing_type": "per_person"  -> string
			},
			"lat": "13.741754",  -> string
			"lng": "100.585404",  -> string
			"name": "Fifty/Fifty Restaurant and Bar",  -> string
			"slug": "fifty-fifty-restaurant-and-bar",  -> string
			"reviews_score": 0.0, -> float
			"reviews_count": 0, -> integer
			"primary_location": { -> object
				"id": null, -> integer
				"name": null  -> string
			},
			"primary_cuisine": { -> object
				"id": null, -> integer
				"name": null  -> string
			},
			"image_cover_url": { -> object
				"thumb": "",  -> string
				"original": "",  -> string
				"square": ""  -> string
			},
			"last_booking_was_made": "Fri, 19 Sep 2014 11:17:13 +0000",  -> date
			"expiry_date": "2022-12-31",  ->date
			"locations": [], -> array object
			"is_staycation": false, -> boolean
			"tags": [], -> array object
			"logo_url": { -> object
				"medium": "",  -> string
				"thumb": ""  -> string
			},
			"opening_hours_short": "closed",  -> string
			"hashtags": [], -> array object
			"available_package_types": [], -> array object
			"link": "https://hungryhub-build-staging.netlify.app/en/restaurants/fifty-fifty-restaurant-and-bar",  -> string
			"covid19_rating": { -> object
				"overall_cleanliness": "0.0",  -> string
				"social_distancing": "0.0",  -> string
				"staff_protection": "0.0"  -> string
			}
		},
		"relationships": { -> object
			"pictures": { -> object
				"data": [ -> array object
					{
						"id": "2313", -> string
						"type": "restaurants-pictures"  -> string
					},
				]
			}
		}
	},
	"success": true -> boolean
}

Example Request with picture

{{ _.base_url }}/api/v5/restaurants/32?&include_pictures=true

Example Response

https://gist.github.com/nesyaafreeda/6a2323061c01099484c0ee2196e25e21

Get Detail Restaurant with image

Get Restaurant Packages

UPDATES

we add new attribute max_package_quantity_str to store the max package quantity string Example: if the max_package_quantity is 23 on max_package_quantity_str will be "23" if the max_package_quantity is 1000000 on max_package_quantity_str will be "No Limit"

Path parameter

Response parameter

Example Request

{{ _.base_url }}/api/v5/restaurant_packages.json?restaurant_id=837

Example Response

https://gist.github.com/nesyaafreeda/a8ef456554fb2b7b42c66de56f55ce03

Get Restaurant Reviews

Path parameter

Response parameter

Example Request

{{ _.base_url }}/api/v5/reviews.json?restaurant_id=837&sort=newest&page[number]=1&page[size]=10

Example Response

{
	"data": [
		{
			"id": "52740",
			"type": "reviews",
			"attributes": {
				"rating": 5,
				"title": null,
				"created_at": "2022-06-21T05:24:31.000Z",
				"user_name": "Christian’s messi ",
				"review_recommended_fors": [
					{
						"id": 59247,
						"review_id": 52740,
						"dimension_id": 10,
						"created_at": "2022-06-21T05:24:48.000Z",
						"updated_at": "2022-06-21T05:24:48.000Z"
					}
				],
				"review": "Wadu",
				"encrypted_id": "lz26r",
				"user_avatar": {
					"thumb": "https://hhstaging.hungryhub.com/uploads/user/avatar/188164/1625285240824_image.jpeg",
					"medium": "https://hhstaging.hungryhub.com/uploads/user/avatar/188164/1625285240824_image.jpeg",
					"original": "https://hhstaging.hungryhub.com/uploads/user/avatar/188164/1625285240824_image.jpeg"
				},
				"pictures": [
					{
						"thumb": "https://hhstaging.hungryhub.com/uploads/review_photo/photo/39040/00.jpeg",
						"original": "https://hhstaging.hungryhub.com/uploads/review_photo/photo/39040/00.jpeg",
						"caption": "Copper Buffet The Sense Pinklao Review"
					}
				],
				"avatar": "https://hhstaging.hungryhub.com/assets/v2/mr_hungry-09b1fe8ac22e6907bae45ba17a49a4b3566ab6e9663380a56e35176d803b4466.png",
				"restaurant": {
					"id": 837,
					"name": "Copper Buffet The Sense Pinklao",
					"link": "copper-buffet-the-sense-pinklao"
				},
				"link": "https://hhstaging.hungryhub.com/restaurants/copper-buffet-the-sense-pinklao/reviews/lz26r"
			}
		},

	],
	"links": {
		"self": "/api/v5/reviews.json?page%5Bnumber%5D=1&page%5Bsize%5D=10&page%5Bnumber%5D=1&page%5Bsize%5D=10&restaurant_id=837&sort=newest",
		"first": "/api/v5/reviews.json?page%5Bnumber%5D=1&page%5Bsize%5D=10&page%5Bnumber%5D=1&page%5Bsize%5D=10&restaurant_id=837&sort=newest",
		"prev": null,
		"next": "/api/v5/reviews.json?page%5Bnumber%5D=1&page%5Bsize%5D=10&page%5Bnumber%5D=2&page%5Bsize%5D=10&restaurant_id=837&sort=newest",
		"last": "/api/v5/reviews.json?page%5Bnumber%5D=1&page%5Bsize%5D=10&page%5Bnumber%5D=129&page%5Bsize%5D=10&restaurant_id=837&sort=newest"
	},
	"meta": {
		"total": 1282,
		"average": 4.7,
		"stars_count": {
			"one": 8,
			"two": 11,
			"three": 53,
			"four": 214,
			"five": 996
		}
	},
	"success": true,
	"message": null
}

Authentication

Params

Sample Request POST: {{ _.base_url }}/api/aoa/v1/authentication.json

{
"contact_id":"78fa2024-5895-e411-b3d5-005056a92b14",
"first_name":"นวลทิพ",
"last_name":"ดาบเ ริญช",
"phone":"0845501895",
"phone_code":"66",
"phone_country_code":"th",
"email":"jitanan@yahoo.com"
}

Sample Response

{
	"data": {
		"token": "YXNkYWFzZGFzYXNkZA=="
	},
	"success": true
}