Skip to content

Voosh API Documentation (1.0.0)

Overview

Voosh aggregates data from multiple platforms, including DoorDash, Uber Eats, ezCater, Grubhub, and others, to provide a unified system that enables restaurant owners to analyze their listed restaurants across various platforms and locations.

This API documentation outlines the available endpoints that facilitate seamless access to key operational data. These APIs empower restaurants to efficiently manage operations and make data-driven decisions.

API Environment & Access

Once you become an official Voosh partner, you will receive a unique API key (partner token) for secure authentication and access to live data. For partnership inquiries, please contact us.

Rate Limiting

Voosh uses a request Rate Limiter to limit the number of requests received by the API within a time frame. Rate Limiter helps maintain system stability during heavy traffic loads.

Download OpenAPI description
main.json
main.yaml
Overview
Languages
Servers
Mock server

https://api.voosh.ai/_mock/main/

https://growapiservicesv2server.voosh.ai/

Partner Authentication

The Partner Authentication APIs enable Voosh and its partners to securely fetch and manage shared client data. These APIs facilitate seamless integration by providing access to common clients across platforms.

Operations

Restaurant Details API

The Restaurant Details API enables partners to retrieve all restaurant listings associated with Voosh, including delivery platform mappings (DoorDash, Uber Eats, Grubhub) and store-level availability, grouped by client. There is also support to retrieve specific client restaurant details.

This API provides:

  • All Restaurant Listings – Fetches restaurant details for all clients, including listing IDs, restaurant names, and platform-specific store names.

  • Platform Availability Flags – Indicates if each restaurant is listed on DoorDash, Uber Eats, or Grubhub.

  • Client-Based Grouping – Organizes listings under each clientId and clientName for easier management.

Operations

Get All Restaurant Details

Request

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

FieldTypeDescription
statusbooleanIndicates if the request was successful.
statusCodeintegerCode representing the status of the response.
messagestringAdditional information about the request (if any).
resultobjectContains the details of the restaurants.
errorobjectContains error information if the request failed.

Detailed Breakdown of Result Field

Result Object

The result object may contain the following keys:

FieldTypeDescription
restaurantDetailsarrayAn array of objects containing details for each restaurant.

Restaurant Details Array

The restaurantDetails object may contain the following keys:

FieldTypeDescription
clientNamestringThe name of the client associated with the restaurant.
clientIdstringUnique identifier for the client.
listingDetailsarrayAn array of objects containing listing information for the restaurant.
Listing Details Array

The listingDetails object may contain the following keys:

FieldTypeDescription
restaurantNamestringThe name of the restaurant.
brandNamestringThe brand associated with the restaurant.
listingIdstringUnique identifier for the restaurant listing.
isDoordashActivebooleanIndicates if the restaurant is active on DoorDash.
isGrubhubActivebooleanIndicates if the restaurant is active on Grubhub.
isUbereatsActivebooleanIndicates if the restaurant is active on UberEats.
doordashStoreNamestringThe store name used on DoorDash.
ubereatsStoreNamestringThe store name used on UberEats.
grubhubStoreNamestringThe 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.

Security
apiKey
Headers
tokenstring
Example: {{access-token}}
curl -i -X GET \
  https://api.voosh.ai/_mock/main/v1/partnerApi/restaurantDetails/getAllDetails \
  -H 'token: {{access-token}}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

200

Headers
Access-Control-Allow-Originstring
Example: "*"
Connectionstring
Example: "keep-alive"
Content-Lengthstring
Example: "2170"
Datestring
Example: "Tue, 08 Jul 2025 17:52:36 GMT"
ETagstring
Example: "W/\"87a-OquYQ16VVIpxKSRgx7jdRUYhIPo\""
Keep-Alivestring
Example: "timeout=5"
X-Powered-Bystring
Example: "Express"
Bodyapplication/json
errorany or null
Example: null
messagestring
Example: "All Restaurant details fetched successfully"
resultobject
statusboolean
Example: true
statusCodenumber
Example: 200
Response
application/json
{
  "error": null,
  "message": "All Restaurant details fetched successfully",
  "result": {
    "restaurantDetails": [ … ]
  },
  "status": true,
  "statusCode": 200
}

Reviews API

The Reviews API enables partners to access, manage, and respond to customer reviews for common clients across multiple platforms. This API provides:

  • Reviews Data – Retrieve detailed reviews submitted by customers across integrated platforms, including ratings, comments, and timestamps.

  • Manual Reply to Reviews – Submit replies manually to individual customer reviews directly through the API.

This API helps partners streamline customer engagement, maintain brand reputation, and ensure timely responses to feedback across platforms.

Operations

Orders API

The Orders API enables seamless aggregation of order data from multiple third-party platforms for clients common to Voosh and its partners. This API provides:

  • Order Details: Retrieves comprehensive order information from integrated platforms, including order status, timestamps, and itemized breakdowns.

  • Financial Insights: Fetches order-level financial data, offering visibility into revenue, taxes, fees, and other cost components.

By consolidating order data across platforms, this API empowers partners to efficiently analyze performance, optimize operations, and ensure accurate financial tracking.

Operations

Dispute Manager API

The Dispute Manager API enables partners to track and manage disputed orders for common clients across multiple platforms. This API provides:

  • Disputed Order Data: Retrieves details of disputed orders, including their current status (approved, denied, or expired) and the total number of orders eligible for dispute.

  • Dispute Resolution Methods:

    1. AI Auto Disputes – Automate the dispute process by enabling AI-powered dispute submission for all locations.

    2. Manual Disputes – Manually select and submit disputes for specific orders as needed.

This API streamlines dispute management, ensuring accurate tracking and efficient resolution of charge discrepancies.

Operations

Financial Reconciliation API

The Financial Reconciliation API provides a comprehensive view of financial transactions across multiple locations, enabling accurate tracking and reconciliation of payments, deductions, and discrepancies. This API includes:

  1. Deductions Breakdown – Retrieve a detailed breakdown of deductions, including commissions, error charges, adjustments, and other fee components.

  2. Estimated vs. Actual Payout – Access store-wise comparisons between estimated and actual payouts to identify discrepancies.

  3. Tax Bifurcation – Retrieve store-level tax details, differentiating between taxes remitted to the merchant and those remitted to the state.

  4. POS vs. Third-Party Reconciliation – Compare POS data with third-party platform records to identify order mismatches, status differences, and unclaimed revenue at the store level.

  5. Deposit Data – Get store-wise deposit details to track payment settlements and ensure financial accuracy.

This API helps partners maintain financial transparency and optimize reconciliation processes across platforms.

Operations