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

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

Get All Order Reviews

Request

Review Manager API - Fetch Reviews

This endpoint allows you to retrieve reviews associated with specific listings within a defined date range. You can specify the number of reviews to return, as well as pagination options.

Request

HTTP Method

POST

URL

{{base-url}}/v1/partnerApi/review-manager/reviews?limit=3&offset=1&order=-1

Request Body

The request body must be in JSON format and includes the following parameters:

KeyTypeDescription
startDatestringThe start date for filtering reviews (format: YYYY-MM-DD).
endDatestringThe end date for filtering reviews (format: YYYY-MM-DD).
listingIdsarrayAn array of listing IDs to filter the reviews.
channelarrayAn array specifying the channels from which to fetch reviews (e.g., DOORDASH).

Example Request Body

{
    "startDate": "2025-06-06",
    "endDate": "2025-07-06",
    "listingIds": [
        "P67071",
        "P67073"
    ],
    "channel": [
        "DOORDASH",
        "UBEREATS",
        "GRUBHUB"
    ]}

Response

Response Body

The response will be in JSON format and contains the following structure:

KeyTypeDescription
statusbooleanIndicates the success of the request.
statusCodeintegerA code representing the status of the request (0 for success).
messagestringA message providing additional information about the request.
resultobjectContains the main data returned from the API.
errorobjectContains error details if the request was unsuccessful.

Result Structure

The result object may contain the following keys:

KeyTypeDescription
totalintegerThe total number of reviews matching the criteria.
reviewsarrayAn array of review objects.
totalUnAnsweredintegerThe total number of unanswered reviews.
unAnsweredReviewsarrayAn array of unanswered review objects.
totalYelpintegerThe total number of Yelp reviews.
yelpReviewsarrayAn array of Yelp review objects.
unansweredYelpintegerThe total number of unanswered Yelp reviews.
unansweredReviewsYelparrayAn array of unanswered Yelp review objects.

Reviews Array Structure

Each object in the reviews array contains the following fields:

KeyTypeDescription
uuidstringUnique identifier for the review.
datestringThe date the review was created.
daysLeftToReplyintegerThe number of days left to respond to the review.
orderSubTotalnumberThe subtotal of the order associated with the review.
CustomerIdstringUnique identifier for the customer who left the review.
storeIdstringUnique identifier for the store associated with the review.
brandIdstringUnique identifier for the brand associated with the review.
deliveryUUIDstringUnique identifier for the order associated with the review.
toBeReviewedbooleanIndicates if the review is pending for a response.
reviewIdstringUnique identifier for the review.
CustomerNamestringName of the customer who left the review.
ListingIdstringUnique identifier for the listing associated with the review.
channelstringThe channel from which the review originated.
orderRatingintegerRating given by the customer for the order.
reviewReplyPromoValuenumberPromotional value associated with the review reply, if any.
orderFeedbackstringFeedback provided by the customer regarding the order.
reviewReplyCommentstringComment provided in response to the review, if any.
orderDatestringThe date the order was placed.
reviewCreatedstringThe timestamp when the review was created.
reviewReplyCreatedstringThe timestamp when the review reply was created, if applicable.
reviewRepliedbooleanIndicates if a reply has been made to the review.
yelpReplyApprovedbooleanIndicates if the Yelp reply has been approved.
customerTypestringType of the customer (e.g., new, returning).
autoReplybooleanIndicates if the reply was generated automatically.

Example Response

{
  "status": true,
  "statusCode": 200,
  "message": "Reviews fetched successfully",
  "result": {
    "total": 33,
    "reviews": [
      {
        "uuid": "cfcd296b-214b-3001-923f-9a406df4424b",
        "date": "2025-07-05T01:08:44.000Z",
        "daysLeftToReply": 3,
        "orderSubTotal": 15.49,
        "CustomerId": "524823061",
        "storeId": "P6707",
        "brandId": "393",
        "deliveryUUID": "cfcd296b-214b-3001-923f-9a406df4424b",
        "toBeReviewed": null,
        "reviewId": null,
        "CustomerName": "Camilo T",
        "ListingId": "P67071",
        "channel": "DOORDASH",
        "orderRating": 5,
        "reviewReplyPromoValue": null,
        "orderFeedback": "",
        "reviewReplyComment": null,
        "orderDate": null,
        "reviewCreated": "2025-07-05T01:08:44.000Z",
        "reviewReplyCreated": null,
        "reviewReplied": false,
        "yelpReplyApproved": false,
        "customerType": "new",
        "autoReply": false
      }
    ],
    "totalUnAnswered": 5,
    "unAnsweredReviews": [
      {
        "uuid": "cfcd296b-214b-3001-923f-9a406df4424b",
        "date": "2025-07-05T01:08:44.000Z",
        "daysLeftToReply": 3,
        "orderSubTotal": 15.49,
        "CustomerId": "524823061",
        "storeId": "P6707",
        "brandId": "393",
        "deliveryUUID": "cfcd296b-214b-3001-923f-9a406df4424b",
        "toBeReviewed": null,
        "reviewId": null,
        "CustomerName": "Camilo T",
        "ListingId": "P67071",
        "channel": "DOORDASH",
        "orderRating": 5,
        "reviewReplyPromoValue": null,
        "orderFeedback": "",
        "reviewReplyComment": null,
        "orderDate": null,
        "reviewCreated": "2025-07-05T01:08:44.000Z",
        "reviewReplyCreated": null,
        "reviewReplied": false,
        "yelpReplyApproved": false,
        "customerType": "new",
        "autoReply": false
      }
    ],
    "totalYelp": 0,
    "yelpReviews": [],
    "unansweredYelp": 0,
    "unansweredReviewsYelp": []
  },
  "error": null
}

Status Codes

  • 200 OK: The request was successful, and the response contains the requested data.

  • Other Status Codes: Refer to the API documentation for additional status codes and their meanings.

This endpoint is essential for managing and analyzing reviews across different channels, helping businesses to respond effectively to customer feedback.

Security
apiKey
Query
limitstring
Example: limit=3
offsetstring
Example: offset=1
orderstring
Example: order=-1
Headers
tokenstring
Example: {{access-token}}
Bodyapplication/json
channelArray of strings
Example: ["DOORDASH","UBEREATS","GRUBHUB"]
endDatestring
Example: "2025-07-06"
listingIdsArray of strings
Example: ["P67071","P67073"]
startDatestring
Example: "2025-06-06"
curl -i -X POST \
  'https://api.voosh.ai/_mock/main/v1/partnerApi/review-manager/reviews?limit=3&offset=1&order=-1' \
  -H 'Content-Type: application/json' \
  -H 'token: {{access-token}}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "channel": [
      "DOORDASH",
      "UBEREATS",
      "GRUBHUB"
    ],
    "endDate": "2025-07-06",
    "listingIds": [
      "P67071",
      "P67073"
    ],
    "startDate": "2025-06-06"
  }'

Responses

200

Headers
Access-Control-Allow-Originstring
Example: "*"
Connectionstring
Example: "keep-alive"
Content-Lengthstring
Example: "5067"
Datestring
Example: "Tue, 08 Jul 2025 13:15:15 GMT"
ETagstring
Example: "W/\"13cb-kkLVEfqPz7SresAvRGrmkleHnDY\""
Keep-Alivestring
Example: "timeout=5"
X-Powered-Bystring
Example: "Express"
Bodyapplication/json
errorany or null
Example: null
messagestring
Example: "Reviews fetched successfully"
resultobject
statusboolean
Example: true
statusCodenumber
Example: 200
Response
application/json
{
  "error": null,
  "message": "Reviews fetched successfully",
  "result": {
    "reviews": [ … ],
    "total": 33,
    "totalUnAnswered": 5,
    "totalYelp": 0,
    "unAnsweredReviews": [ … ],
    "unansweredReviewsYelp": [],
    "unansweredYelp": 0,
    "yelpReviews": []
  },
  "status": true,
  "statusCode": 200
}

Reply To Review

Request

Review Reply API

This endpoint allows partners to submit replies to reviews for their listings. It is designed to facilitate communication with customers by enabling businesses to respond to feedback directly.

Request

HTTP Method

POST

URL

{{base-url}}/v1/partnerApi/review-manager/reply

Request Parameters

The request body must be sent in JSON format and includes the following parameters:

FieldTypeDescription
promoValueintegerA value representing any promotional offer associated with the reply.
commentstringThe text of the reply to the customer's review.
deliveryUUIDstringA unique identifier for the delivery associated with the review.
customerIdstringThe unique identifier of the customer who left the review.
feedbackstringAny additional feedback that may be relevant.
listingIdstringThe unique identifier of the listing being reviewed.
ratingintegerThe rating given by the customer (scale typically from 1 to 5).
channelstringThe platform through which the review was received (e.g., DOORDASH).
customerNamestringThe name of the customer who left the review.
reviewCreatedstringThe date when the review was created.

Example Request Body

{
  "promoValue": 0,
  "comment": "Hello Jessica, We appreciate ...",
  "deliveryUUID": "5d594684-e433-3001-bece-56a015 ...",
  "customerId": "",
  "feedback": "",
  "listingId": "P1351",
  "rating": 5,
  "channel": "DOORDASH",
  "customerName": "Jessica W",
  "reviewCreated": "2025-04-12"
}

Expected Response

Upon a successful request, the API will return a response with the following structure:

FieldTypeDescription
statusbooleanIndicates whether the request was successful.
statusCodeintegerA code representing the status of the response.
messagestringA message providing additional information about the response.
resultobjectContains further details about the result of the operation.
result.messagestringAny relevant message related to the result.
errornull or objectWill be null if there is no error; otherwise, it will contain error details.

Example Response Body

{
    "status": true,
    "statusCode": 200,
    "message": "Review respond request initiated",
    "result": {
        "message": "review respond request initiated"},
    "error": null
}

Notes

  • A successful request will typically return a 200 status code.

  • The response structure is consistent across various endpoints of this API, allowing ease of integration and understanding.

  • Ensure that all required fields are populated correctly to avoid errors in submission.

Security
apiKey
Headers
tokenstring
Example: {{access-token}}
user-agentstring
Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36
Bodyapplication/json
channelstring
Example: "DOORDASH"
commentstring
Example: "Hello Jessica, We appreciate your 5-star rating! Thank you for choosing us through DoorDash!"
customerIdstring
Example: ""
customerNamestring
Example: "Jessica W"
deliveryUUIDstring
Example: "5d594684-e433-0152e47b0"
feedbackstring
Example: ""
listingIdstring
Example: "P1351"
promoValuenumber
Example: 0
ratingnumber
Example: 5
reviewCreatedstring
Example: "2025-04-12"
curl -i -X POST \
  https://api.voosh.ai/_mock/main/v1/partnerApi/review-manager/reply \
  -H 'Content-Type: application/json' \
  -H 'token: {{access-token}}' \
  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "channel": "DOORDASH",
    "comment": "Hello Jessica,  We appreciate your 5-star rating! Thank you for choosing us through DoorDash!",
    "customerId": "",
    "customerName": "Jessica W",
    "deliveryUUID": "5d594684-e433-0152e47b0",
    "feedback": "",
    "listingId": "P1351",
    "promoValue": 0,
    "rating": 5,
    "reviewCreated": "2025-04-12"
  }'

Responses

200

Headers
Access-Control-Allow-Originstring
Example: "*"
Connectionstring
Example: "keep-alive"
Content-Lengthstring
Example: "260"
Datestring
Example: "Mon, 14 Apr 2025 09:08:36 GMT"
ETagstring
Example: "W/\"104-AdgUinoVtChafowolD+N9x77f+U\""
X-Powered-Bystring
Example: "Express"
Bodyapplication/json
errorany or null
Example: null
messagestring
Example: "Review respond request initiated"
resultobject
statusboolean
Example: true
statusCodenumber
Example: 200
Response
application/json
{
  "error": null,
  "message": "Review respond request initiated",
  "result": {
    "message": "review respond request initiated"
  },
  "status": true,
  "statusCode": 200
}

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