-
Notifications
You must be signed in to change notification settings - Fork 0
CT Local Eatouts Fetch Eatout Details API
SoumyaSian edited this page Mar 15, 2018
·
5 revisions
fetch_eatout_details
KEYWORD | DESCRIPTION |
---|---|
CITY_ID | City ID |
VARIATION_ID | Selected Variant ID from activity list API |
ACTIVITY_ID | Selected Activity ID from activity list API |
{
"city_id":"$CITY_ID",
"variation_id":"$VARIATION_ID",
"activity_id":"$ACTIVITY_ID"
}
KEY | DESCRIPTION |
---|---|
ISGSTAPPLICABLE | True or false (true represent GST applicable and false represent GST not applicable) |
IMAGES | URL path of image for this eat out or variant |
IMAGES.IMAGE | URL path for this eat out or variant |
ACTIVITY_ID | Cleartrip ID for an eat out |
VARIATION_NAME | Name of the variation |
CUISINE | Name of cuisine |
INCLUSIONS | List of inclusions |
ADDRESS | Restaurant Address Information Object |
ADDRESS.COUNTRY | Country Name of the restaurant |
ADDRESS.ADDRESS_TYPE | Address type (Restaurant address or pickup address of this restaurant) |
ADDRESS.ADDRESS2 | Secondary Address if restaurant exists in more than one place |
ADDRESS.CITY | City of a restaurant |
ADDRESS.ADDRESS1 | Primary address of a restaurant |
ADDRESS.LATITUDE | Latitude of the location of a restaurant |
ADDRESS.STATE | State pertaining to the restaurant |
ADDRESS.LONGITUDE | Longitude of the location of a restaurant |
ADDRESS.LOCALITY_NAME | locality name of a restaurant |
ONE_LINE_DESCRIPTION | One line description of a restaurant or variant |
DRESS_CODE | Dress code for a restaurant |
IS_VEG | True or false (true represent veg and false represent nonveg) |
IS_NON_VEG | True or false (true represent nonveg and false represent veg) |
MIN_PRICE | Minimum price of an eat out |
VARIATION_ID | Cleartrip ID for a variation(null if no variation exists) |
EATOUT_NAME | Name of Eatout |
RATES | List of all rates available for this eat out or variant |
RATES.CHEAPEST_RATES | This is cheapest price we will use to show on UI for adult(adt), child(chd) and group(un |
RATES.IS_UNIT_TYPE | True or false, true represents existence of any unit type besides adults or children |
RATES.RATE_ID | Id of rates |
RATES.CANCELLATION | List of cancellation policy available |
RATES.CANCELLATION.CHARGE_TYPE | 1 or 2, 1 represents flat cancellation charge in a given currency and 2 represent flat cancellation in percentage. |
RATES.CANCELLATION.LEAD_HOUR | Refund Time slots (From 0 to given hour value) |
RATES.CANCELLATION.VALUE | Cancellation value depends on charge_type currency or percentage |
RATES.PRICES | List of pricing available for an eat out (weekday and weekends price) |
RATES.WHEN | List of time and duration |
RATES.WHEN.DURATION | Duration of the eat out |
RATES.WHEN.IS_AVALIABLE_TODAY | True or false (true represents restaurant is available for the current date and false represent restaurant is not available) |
RATES.WHEN.EXPAND | True or false (true represents eat out timings are flexible and false represents eat out timings are not flexible |
RATES.WHEN.TIMINGS | Timings of an eat out |
RATES.INCLUSIONS | Inclusions for an eat out |
RATES.RATE_NAME | Name of the rates |
WEB_URL | Cleartrip website page for Eatout details |
{
"is_gst_applicable": $IS_GST_APPLICABLE,
"images": [
{
"order_no": "$ORDER_NO",
"image": "$IMAGE"
}..],
"activity_id": $ACTIVITY_ID,
"variation_name": $VARIATION_NAME,
"cuisine": [
"$CUISINE"
...
],
"one_line_description": "$ONE_LINE_DESCRIPTION",
"inclusions": [$INCLUSIONS],
"is_veg": $IS_VEG,
"is_non_veg": $IS_NON_VEG,
"highlights": [
$HIGHLIGHTS
...
]
"min_price": $MINPRICE,
"rates": [
{
"cheapest_rates": {
"adt": $ADT,
"unit": $UNIT,
"chd": $CHD
},
"is_unit_type": $IS_UNIT_TYPE,
"cancellation": [
{
"charge_type": "$CHARGE_TYPE",
"rate_id": $RATE_ID,
"lead_hour": $LEAD_HOUR,
"value": $VALUE
}
...,
],
"rate_id": $RATE_ID,
"about": [$ABOUT],
"prices": [$PRICES],
"when": {
"duration": "$DURATION",
"isAvailableToday": $IS_AVALIABLE_TODAY,
"expand": $EXPAND,
"timings": "$TIMINGS"
},
"inclusions": [$INCLUSIONS],
"rate_name": "{$RATE_NAME}",
}
],
"variation_id": $VARIATION_ID,
"eatout_name": "$EATOUT_NAME",
"address": {
"country": "$COUNTRY",
"address_type": "$ADDRESS_TYPE",
"address2": $ADDRESS2,
"city": "$CITY",
"address1": "$ADDRESS1",
"pin_code": "$PINCODE",
"latitude": "$LATITUDE",
"state": "$STATE",
"longitude": "$LONGITUDE",
"city_id": $CITY_ID,
"locality_name": "$LOCALITY_NAME"
},
"ratings": {$RATINGS},
"web_url": "$WEB_URL"
}
Some error messages, you might get an invalid search request. The HTTP response code, in this case, will be 400.
Status | Error message | Description |
---|---|---|
400 | fields are required | city_id, variation_id and activity_id are missing. |
400 | city_id is required field | city_id is missing. |
400 | variation_id is required field | variation_id is missing. |
400 | activity_id is required field | activity_id is missing. |