v1

latestOpenAPI 3.0.32026-08-06150495.9 KB

Restaurant Details API

Get All Restaurant Details

Overview

This endpoint retrieves detailed information about all restaurants associated with a partner. It provides a comprehensive list of restaurant details, including their active delivery services and listing information.

HTTP Method

GET

URL

{{base-url}}/v1/partnerApi/restaurantDetails/getAllDetails

Request Parameters

This endpoint does not require any request body parameters.

Response

Summary

The response returns a JSON object containing the status of the request, a message, and the result which includes an array of restaurant details. Each restaurant detail includes information about the restaurant's name, brand, listing ID, and active delivery services.

Response Fields

Field	Type	Description
status	boolean	Indicates if the request was successful.
statusCode	integer	Code representing the status of the response.
message	string	Additional information about the request (if any).
result	object	Contains the details of the restaurants.
error	object	Contains error information if the request failed.

Detailed Breakdown of Result Field

Result Object

The result object may contain the following keys:

Field	Type	Description
restaurantDetails	array	An array of objects containing details for each restaurant.

Restaurant Details Array

The restaurantDetails object may contain the following keys:

Field	Type	Description
clientName	string	The name of the client associated with the restaurant.
clientId	string	Unique identifier for the client.
listingDetails	array	An array of objects containing listing information for the restaurant.

Listing Details Array

The listingDetails object may contain the following keys:

Field	Type	Description
restaurantName	string	The name of the restaurant.
brandName	string	The brand associated with the restaurant.
listingId	string	Unique identifier for the restaurant listing.
isDoordashActive	boolean	Indicates if the restaurant is active on DoorDash.
isGrubhubActive	boolean	Indicates if the restaurant is active on Grubhub.
isUbereatsActive	boolean	Indicates if the restaurant is active on UberEats.
doordashStoreName	string	The store name used on DoorDash.
ubereatsStoreName	string	The store name used on UberEats.
grubhubStoreName	string	The store name used on Grubhub.

Example Response

{
    "status": true,
    "statusCode": 200,
    "message": "All Restaurant details fetched successfully",
    "result": {
        "restaurantDetails": [
            {
                "clientName": "Chatmeter",
                "clientId": "CH4798",
                "listingDetails": [
                    {
                        "restaurantName": "Taco Bell - 35144",
                        "brandName": "Taco Bell",
                        "listingId": "P411",
                        "isDoordashActive": false,
                        "isGrubhubActive": false,
                        "isUbereatsActive": true,
                        "doordashStoreName": "",
                        "ubereatsStoreName": "Taco Bell (1209 N. Missouri St.)",
                        "grubhubStoreName": ""
                    },
                    {
                        "restaurantName": "Taco Bell - 039153",
                        "brandName": "Taco Bell",
                        "listingId": "P421",
                        "isDoordashActive": false,
                        "isGrubhubActive": true,
                        "isUbereatsActive": false,
                        "doordashStoreName": "",
                        "ubereatsStoreName": "",
                        "grubhubStoreName": "Taco Bell  - 039153"}
                ]
            }
        ]
    },
    "error": null
}

This structured documentation provides a clear understanding of the endpoint's purpose, request structure, and response format, enabling users to effectively integrate and utilize the API.

get/v1/partnerApi/restaurantDetails/getAllDetails

Headers

tokenstring

Example:{{access-token}}

Response

200

{"stackTrail":"paths:/v1/partnerApi/restaurantDetails/getAllDetails:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}

messagestring

statusboolean

statusCodenumber

Example response

{
  "message": "All Restaurant details fetched successfully",
  "result": {
    "restaurantDetails": [
      {
        "clientId": "CH4798",
        "clientName": "Chatmeter",
        "listingDetails": [
          {
            "brandName": "Taco Bell",
            "doordashStoreName": "",
            "grubhubStoreName": "",
            "isDoordashActive": false,
            "isGrubhubActive": false,
            "isUbereatsActive": true,
            "listingId": "P411",
            "restaurantName": "Taco Bell - 35144",
            "ubereatsStoreName": "Taco Bell (1209 N. Missouri St.)"
          },
          {
            "brandName": "Taco Bell",
            "doordashStoreName": "",
            "grubhubStoreName": "Taco Bell  - 039153",
            "isDoordashActive": false,
            "isGrubhubActive": true,
            "isUbereatsActive": false,
            "listingId": "P421",
            "restaurantName": "Taco Bell - 039153",
            "ubereatsStoreName": ""
          }
        ]
      }
    ]
  },
  "status": true,
  "statusCode": 200
}