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

Key Features:

  • Retrieve a comprehensive list of restaurant IDs (listing IDs) associated with a client.

  • Access details of all partner clients within the Voosh system, including their respective locations.

  • Ensure secure authentication and data retrieval using a unique token ID provided by Voosh.

  • Maintain accurate client mappings and streamline partner integrations.

Available APIs:

  • Get Intial Access Token API: Fetches access tokens necessary to authenticate Voosh API's.

  • Get Refresh Token API: Refreshes access tokens.

Voosh provides each partner with a unique token ID, which must be included in API requests to authenticate and securely access client data.

Get Initial Access Tokens

Request

Sign In Endpoint

This endpoint is used to authenticate a user and initiate a session by providing the user's credentials. Upon successful authentication, the user receives a token that has a 24-hour expiry and can be used for subsequent requests.

HTTP Method

POST

Request URL

POST {{base-url}}/v1/partnerApi/auth/signin

Request Body

ParameterTypeDescription
emailstringThe email address of the user.
passwordstringThe password for the user.

Example Request Body:

{
  "email": "YourEmail",
  "password": "YourPassword"
}

Response

The response will indicate the success or failure of the authentication attempt.

Response Structure

ParameterTypeDescription
statusbooleanIndicates if the request was successful.
statusCodeintegerCode representing the status of the response.
messagestringA message providing additional information (if any).
resultobjectContains the authentication result.
profileobjectUser profile information.
idstringUnique identifier for the user.
emailstringEmail address of the user.
usernamestringUsername of the user.
tokenstringAuthentication token for the session (expires in 24 hours).
refreshstringRefresh token for obtaining a new access token.
errorobjectContains error information if authentication fails.

Example Response:

{
    "status": true,
    "statusCode": 200,
    "message": "User signed-in successfully",
    "result": {
        "profile": {
            "id": "c369fc58-48ecc4d5790db1",
            "email": "email@voosh.in",
            "username": "Chatmeter"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzU4LTM",
        "refresh": "eyJhbGciOjttRc.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9OiJIUzI1NiIsInR5cCI6IkpXVCJ9"
    },
    "error": null
}

This endpoint allows users to authenticate and sign in to the partner API.

Security
apiKey
Bodyapplication/json
emailstring
Example: "YourEmail"
passwordstring
Example: "YourPassword"
curl -i -X POST \
  https://api.voosh.ai/_mock/main/v1/partnerApi/auth/signin \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "YourEmail",
    "password": "YourPassword"
  }'

Responses

200

Headers
Access-Control-Allow-Originstring
Example: "*"
Connectionstring
Example: "keep-alive"
Content-Lengthstring
Example: "789"
Datestring
Example: "Tue, 08 Jul 2025 05:53:00 GMT"
ETagstring
Example: "W/\"315-f66xc0hVvBALyN4N+rLTzuWM6ko\""
Keep-Alivestring
Example: "timeout=5"
X-Powered-Bystring
Example: "Express"
X-RateLimit-Limitstring
Example: "5"
X-RateLimit-Remainingstring
Example: "4"
X-RateLimit-Resetstring
Example: "1751957581"
Bodyapplication/json
errorany or null
Example: null
messagestring
Example: "User signed-in successfully"
resultobject
statusboolean
Example: true
statusCodenumber
Example: 200
Response
application/json
{
  "error": null,
  "message": "User signed-in successfully",
  "result": {
    "profile": { … },
    "refresh": "eyJhbGciOjttRI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUc",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzU4LTM"
  },
  "status": true,
  "statusCode": 200
}

Refresh Access Tokens

Request

Refresh Token API

Request URL

POST {{base-url}}/v1/partnerApi/auth/refresh

Request Body

The request body must be in JSON format and should include the following parameter:

FieldTypeDescription
refreshstringThe refresh token that is used to obtain a new access token.

Example Request Body:

{
  "refresh": "YourToken"
}

Response

Upon a successful request, the API returns a JSON response with the following structure:

FieldTypeDescription
statusbooleanIndicates whether the request was successful.
statusCodeintegerThe status code of the response.
messagestringA message providing additional information about the response.
resultobjectContains the result of the request.
tokenstringThe newly issued access token.
errornull or objectContains error information if any occurred during the request.

Example Response:

{
    "status": true,
    "statusCode": 200,
    "message": "Token refreshed successfully",
    "result": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzU4LTQ4NDg3V5cyIsImlhdCI6MTc1MTk4MDA4OSwiZXhwIjoxNzUyMDY2NDg5fQ.TLm0D4ZO4tNwNTCygFIzg0QwXZmeD_3KEKWpWkU"
    },
    "error": null
}

Status Codes

  • 200 OK: The request was successful, and the token has been refreshed.

  • Other status codes may indicate different types of errors or issues with the request.

This endpoint is essential for maintaining user sessions without requiring frequent logins, enhancing user experience while ensuring security.

Security
apiKey
Bodyapplication/json
refreshstring
Example: "YourToken"
curl -i -X POST \
  https://api.voosh.ai/_mock/main/v1/partnerApi/auth/refresh \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "refresh": "YourToken"
  }'

Responses

200

Headers
Access-Control-Allow-Originstring
Example: "*"
Connectionstring
Example: "keep-alive"
Content-Lengthstring
Example: "487"
Datestring
Example: "Tue, 08 Jul 2025 13:08:09 GMT"
ETagstring
Example: "W/\"1e7-Wsqo0ZtWkFUXkbXdeTtBJkl11Hk\""
Keep-Alivestring
Example: "timeout=5"
X-Powered-Bystring
Example: "Express"
Bodyapplication/json
errorany or null
Example: null
messagestring
Example: "Token refreshed successfully"
resultobject
statusboolean
Example: true
statusCodenumber
Example: 200
Response
application/json
{
  "error": null,
  "message": "Token refreshed successfully",
  "result": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzU4LTQ4NDg3V5cyIsImlhdCI6MTc1MTk4MDA4OSwiZXhwIjoxNzUyMDY2NDg5fQ.TLm0D4ZO4tNwNTCygFIzg0QwXZmeD_3JHRNKEKWpWkU"
  },
  "status": true,
  "statusCode": 200
}

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

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