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.
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.
These APIs are currently hosted on a mock server and return sample (dummy) data for testing and integration purposes.
Once you become an official Voosh partner, you will receive the actual Gateway URL along with a unique API key (partner token) for secure authentication and access to live data. For partnership inquiries, please contact us.
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.
Get Common Clients API: Fetches a list of clients shared between Voosh and its partners.
Client Details API: Provides detailed information about partner clients, including their associated restaurant locations.
Voosh provides each partner with a unique token ID, which must be included in API requests to authenticate and securely access client data.
This endpoint retrieves a list of common clients with a limit of 5 and an offset of 0.
limit (integer, required): The maximum number of common clients to retrieve.
offset (integer, required): The offset for pagination.
Example:
{{base-url}}/common-clients?limit=5&offset=0
status (boolean): Indicates the status of the response.
statusCode (integer): The status code of the response.
message (string): A message related to the response.
result (object): The result object containing the list of common clients.
numberOfCommonClients (integer): The number of common clients returned.
commonClients (array): An array of common client objects.
clientName (string): The name of the client.
brandId (string): The ID of the brand.
clientId (string): The ID of the client.
listings (integer): The number of listings.
listingIds (array): An array of listing IDs.
restaurantName (string): The name of the restaurant.
listingId (string): The ID of the listing.
storeIds (array): An array of store IDs.
channel (string): The channel of the store.
storeId (string): The ID of the store.
channels (array): An array of channels.
Example Response:
{
"status": true,
"statusCode": 0,
"message": "",
"result": {
"numberOfCommonClients": 0,
"commonClients": [
{
"clientName": "",
"brandId": "",
"clientId": "",
"listings": 0,
"listingIds": [
{
"restaurantName": "",
"listingId": "",
"storeIds": [
{
"channel": "",
"storeId": ""
}
],
"channels": [""]
}
]
}
]
},
"error": null
}
(optional) – Specifies the number of clients to fetch. If not provided, the default value is 5.
curl -i -X GET \
'https://api.voosh.ai/_mock/main/common-clients?limit=5&offset=0' \
-H 'Content-Type: application/json' \
-H 'access-token: {{access-token}}'{ "error": null, "message": "Common clients fetched successfully", "result": { "commonClients": [ … ], "numberOfCommonClients": 2 }, "status": true, "statusCode": 200 }
This endpoint makes an HTTP GET request to retrieve details of a specific client by providing the client ID as a query parameter. The request should be sent to {{base-url}}/common-clients/client-details with the clientId parameter set to the desired client ID.
This request does not require a request body.
The response will contain the details of the client, including the client name, brand ID, client ID, number of listings, and an array of listing IDs. Each listing ID includes the restaurant name, listing ID, and an array of store IDs, where each store ID contains the channel and store ID. Additionally, the response includes an array of channels associated with the client.
Example Response:
{
"clientName": "",
"brandId": "",
"clientId": "",
"listings": 0,
"listingIds": [
{
"restaurantName": "",
"listingId": "",
"storeIds": [
{
"channel": "",
"storeId": ""
}
],
"channels": [""]
}
]
}
curl -i -X GET \
'https://api.voosh.ai/_mock/main/common-clients/client-details?clientId=604517c0-fae8-41b7-8c20-0fe4778e415c' \
-H 'Content-Type: application/json' \
-H 'access-token: {{access-token}}'200
{ "brandId": "1289", "clientId": "604517c0-fae8-41b7-8c20-0fe4778e415c", "clientName": "Coramark Inc", "listingIds": [ { … }, { … } ], "listings": 2 }
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.
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:
AI Auto Disputes – Automate the dispute process by enabling AI-powered dispute submission for all locations.
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.
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:
Deductions Breakdown – Retrieve a detailed breakdown of deductions, including commissions, error charges, adjustments, and other fee components.
Estimated vs. Actual Payout – Access store-wise comparisons between estimated and actual payouts to identify discrepancies.
Tax Bifurcation – Retrieve store-level tax details, differentiating between taxes remitted to the merchant and those remitted to the state.
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.
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.
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.
Auto Reply Configuration – Enable automated responses for reviews across all supported channels, allowing the system to handle replies based on predefined logic.
This API helps partners streamline customer engagement, maintain brand reputation, and ensure timely responses to feedback across platforms.