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.
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.
This endpoint retrieves the financial overview for a specific client.
Method: GET
Base URL: {{base-url}}
Path: /finance-manager/financial/overview
Query Parameters:
Type: Raw (JSON)
Description: The request body includes the following parameters:
startDate (string): The start date for the overview.
endDate (string): The end date for the overview.
listingIds (array): An array of listing IDs.
channel (array): An array of channels.
payoutDates (array): An array of payout dates.
Status: 200
Content-Type: application/json
Description: The response will be a JSON object with the following schema:
{
"status": boolean,
"statusCode": number,
"message": string,
"result": {
"dashboard": string,
"startDate": string,
"endDate": string,
"previousStartDate": string,
"previousEndDate": string,
"overview": {
"payout": {
"totalRevenue": number,
"deductions": {
"total": number,
"commission": number,
"merchantFee": number,
"promoValue": {
"promoValue": number,
"ezReward": number,
"preferredPartnerProgram": number
},
"paymentTransactionFee": number,
"deliveryFee": {
"deliveryFee": number,
"deliveryCommission": number
},
"marketing": {
"marketingAdjustments": number
},
"miscellaneous": {
"tips": number,
"taxWithHeld": number,
"commissionTax": number,
"otherPayments": number
}
},
"tax": {
"taxToBePaid": number
},
"estimatedPayout": number,
"differenceBifurcation": {
"total": number,
"errorCharges": {
"total": number,
"itemValue": number,
"itemTax": number
},
"adjustments": {
"total": number,
"itemValue": number,
"itemTax": number
}
},
"netPayout": {
"total": number,
"refundByVoosh": number
},
"payoutDiff": {
"total": number,
"itemValue": number,
"itemTax": number
}
},
"tax": {
"taxRemittedToState": number,
"taxRemittedToMerchant": number
}
},
"graph": [
{
"key": string,
"range": [number],
"value": number,
"type": string,
"bifurcation": {}
}
]
},
"error": string
}
curl -i -X GET \
'https://api.voosh.ai/_mock/main/finance-manager/financial/overview?clientId=604517c0-fae8-41b7-8c20-0fe4778e415c' \
-H 'Content-Type: application/json' \
-H 'access-token: {{access-token}}' \
-d '{
"channel": [
"DOORDASH",
"UBEREATS",
"GRUBHUB",
"EZCATER"
],
"endDate": "2025-03-25",
"listingIds": [
"P5441",
"P5461",
"P5471",
"P5481",
"P5491",
"P5501",
"P5511",
"P5531",
"P5541",
"P5551",
"P5561",
"P5571",
"P5581",
"P8191"
],
"payoutDates": [],
"startDate": "2025-02-23"
}'
{
"status": true,
"statusCode": 200,
"message": "Financial reconciliation overview generated successfully",
"result": {
"startDate": "2025-02-23 00:00:00",
"endDate": "2025-03-25 23:59:59",
"previousStartDate": "2025-01-23 00:00:00",
"previousEndDate": "2025-02-22 23:59:59",
"overview": {
"payout": {
"totalRevenue": 377441.24,
"deductions": {
"total": -112975.35,
"commission": -68035.54,
"merchantFee": -11869.56,
"promoValue": {
"promoValue": -36631.45,
"ezReward": -1378.49,
"preferredPartnerProgram": -3781.28
},
"paymentTransactionFee": -1475.95,
"deliveryFee": {
"deliveryFee": 1883.4,
"deliveryCommission": -319.72
},
"marketing": {
"marketingAdjustments": 14136.63
},
"miscellaneous": {
"tips": 1867.44,
"taxWithHeld": -379.87,
"commissionTax": -13.38,
"otherPayments": -6977.54
}
},
"tax": {
"taxToBePaid": 17329.57
},
"estimatedPayout": 281358.17,
"differenceBifurcation": {
"total": 48650.45,
"errorCharges": {
"total": -1470.85,
"itemValue": -911.25,
"itemTax": -33.39
},
"adjustments": {
"total": 50121.3,
"itemValue": 636.66,
"itemTax": 37.21
}
},
"netPayout": {
"total": 331042.99,
"refundByVoosh": 1034.37
},
"payoutDiff": {
"total": 49684.82,
"itemValue": 274.58,
"itemTax": -3.82
}
},
"tax": {
"taxRemittedToState": 12251.42,
"taxRemittedToMerchant": 17329.57
}
},
},
"error": null
}
This endpoint makes an HTTP GET request to retrieve tax details for provide stores(listingIds). The request should include the client ID as a query parameter. The request body should be in raw format and include the start date, end date, listing IDs, channel, and payout dates.
startDate (string): The start date for the tax details.
endDate (string): The end date for the tax details.
listingIds (array): An array of listing IDs.
channel (array): An array of channels.
payoutDates (array): An array of payout dates.
{
"startDate": "2025-02-23",
"endDate": "2025-03-26",
"listingIds": ["P5441"],
"channel": ["DOORDASH"],
"payoutDates": []
}
Upon a successful execution, the endpoint returns a status code of 200 and a JSON response in the format below:
{
"status": true,
"statusCode": 0,
"message": "",
"result": {
"storeWise": [
{
"storeId": "",
"taxRemittedToState": 0,
"taxRemittedToMerchant": 0
}
]
},
"error": null
}
The response includes the status, status code, message, and tax details for each store, including the store ID, tax remitted to the state, and tax remitted to the merchant.
This endpoint retrieves tax details for a specific client based on the provided start date, end date, listing IDs, and channel. The response includes the status, status code, message, and tax details for each store, including the store ID, tax remitted to the state, and tax remitted to the merchant.
curl -i -X GET \
'https://api.voosh.ai/_mock/main/finance-manager/financial/tax-details?clientId=604517c0-fae8-41b7-8c20-0fe4778e415c' \
-H 'Content-Type: application/json' \
-H 'access-token: {{access-token}}' \
-d '{
"channel": [
"DOORDASH",
"UBEREATS"
],
"endDate": "2025-03-26",
"listingIds": [
"P5441",
"P5461",
"P5471",
"P5481",
"P5491",
"P5501",
"P5511",
"P5531",
"P5541",
"P5551",
"P5561",
"P5571",
"P5581",
"P8191"
],
"payoutDates": [],
"startDate": "2025-02-23"
}'
{ "error": null, "message": "Financial reconciliation Tax details generated successfully", "result": { "storeWise": [ … ] }, "status": true, "statusCode": 200 }
This endpoint retrieves deposit details for stores.
Method: GET
URL: {{base-url}}/finance-manager/financial/deposit-details
Query Parameters:
clientId
: 604517c0-fae8-41b7-8c20-0fe4778e415cType: Raw
{ "startDate": "2025-02-23", "endDate": "2025-03-26", "listingIds": ["P5441"], "channel": ["DOORDASH"], "payoutDates": []}
Status: 200
Content-Type: application/json
{
"status": true,
"statusCode": 0,
"message": "",
"result": {
"result": [
{
"storeId": "",
"channel": [""],
"startDate": "",
"endDate": "",
"netPayout": 0,
"payouts": [
{
"storeId": "",
"payoutId": null,
"channel": "",
"startDate": "",
"endDate": "",
"payoutDate": "",
"netPayout": 0
}
]
}
]
},
"error": null
}
curl -i -X GET \
'https://api.voosh.ai/_mock/main/finance-manager/financial/deposit-details?clientId=604517c0-fae8-41b7-8c20-0fe4778e415c' \
-H 'Content-Type: application/json' \
-H 'access-token: {{access-token}}' \
-d '{
"channel": [
"DOORDASH",
"UBEREATS",
"GRUBHUB",
"EZCATER"
],
"endDate": "2025-03-26",
"listingIds": [
"P5441",
"P5461",
"P5471",
"P5481",
"P5491",
"P5501",
"P5511",
"P5531",
"P5541",
"P5551",
"P5561",
"P5571",
"P5581",
"P8191"
],
"payoutDates": [],
"startDate": "2025-02-23"
}'
{ "error": null, "message": "Financial reconciliation Deposit details generated successfully", "result": { "result": [ … ] }, "status": true, "statusCode": 200 }
This endpoint retrieves the financial estimate versus actual payouts details for a specific client.
GET /finance-manager/financial/estimate-vs-actual-payouts-details
clientId
(string, required): The unique identifier of the client.{
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD",
"listingIds": ["string"],
"channel": ["string"],
"payoutDates": []
}
startDate
(string): The start date for the financial estimate.
endDate
(string): The end date for the financial estimate.
listingIds
(array of strings): The listing IDs for which the estimate is being calculated.
channel
(array of strings): The channels for which the estimate is being calculated.
payoutDates
(array): The payout dates.
{
"type": "object",
"properties": {
"status": {"type": "boolean"},
"statusCode": {"type": "integer"},
"message": {"type": "string"},
"result": {
"type": "object",
"properties": {
"storeWise": {
"type": "array",
"items": {
"type": "object",
"properties": {
"store": {"type": "string"},
"revenue": {"type": "number"},
"deductions": {
"type": "object",
"properties": {
"total": {"type": "number"},
"commission": {"type": "number"},
"promoValue": {"type": "number"},
"deliveryFee": {"type": "number"},
"tips": {"type": "number"},
"marketingFees": {"type": "number"},
"paymentTransactionFee": {"type": "number"},
"ezReward": {"type": "number"},
"preferredPartnerProgram": {"type": "number"},
"deliveryCommission": {"type": "number"},
"marketingAdjustments": {"type": "number"},
"otherPayments": {"type": "number"},
"taxWithHeld": {"type": "number"},
"commissionTax": {"type": "number"},
"merchantFee": {"type": "number"}
}
},
"tax": {"type": "number"},
"estimatedPayout": {"type": "number"},
"difference": {
"type": "object",
"properties": {
"total": {
"type": "object",
"properties": {
"total": {"type": "number"},
"itemValue": {"type": "number"},
"itemTax": {"type": "number"}
}
},
"errorCharges": {
"type": "object",
"properties": {
"total": {"type": "number"},
"itemValue": {"type": "number"},
"itemTax": {"type": "number"}
}
},
"adjustments": {
"type": "object",
"properties": {
"total": {"type": "number"},
"itemValue": {"type": "number"},
"itemTax": {"type": "number"}
}
},
"refundByVoosh": {
"type": "object",
"properties": {
"total": {"type": "number"},
"itemValue": {"type": "number"},
"itemTax": {"type": "number"}
}
}
}
},
"netPayout": {
"type": "object",
"properties": {
"total": {"type": "number"}
}
}
}
}
},
"error": {"type": "null"}
}
}
}
}
The response returns the status of the request, along with the financial estimate versus actual payouts details for the specified client.
curl -i -X GET \
'https://api.voosh.ai/_mock/main/finance-manager/financial/estimate-vs-actual-payouts-details?clientId=604517c0-fae8-41b7-8c20-0fe4778e415c' \
-H 'Content-Type: application/json' \
-H 'access-token: {{access-token}}' \
-d '{
"channel": [
"DOORDASH",
"UBEREATS",
"GRUBHUB",
"EZCATER"
],
"endDate": "2025-03-26",
"listingIds": [
"P5441",
"P5461",
"P5471",
"P5481",
"P5491",
"P5501",
"P5511",
"P5531",
"P5541",
"P5551",
"P5561",
"P5571",
"P5581",
"P8191"
],
"payoutDates": [],
"startDate": "2025-02-23"
}'
{ "error": null, "message": "Financial reconciliation Estimate vs Actual payout details", "result": { "storeWise": [ … ] }, "status": true, "statusCode": 200 }
This endpoint retrieves the details of point of sale (POS) versus off-premise financial data for a specific client.
Method: GET
Base URL: {{base-url}}
Path: /finance-manager/financial/pos-vs-off-premise-details
Query Parameters:
Type: Raw
{ "startDate": "2025-02-23", "endDate": "2025-03-26", "listingIds": ["P5441"], "channel": ["DOORDASH"], "payoutDates": [] }
Status: 200
Content-Type: application/json
{ "status": true, "statusCode": 0, "message": "", "result": { "up_sell": true, "pos": { "name": "", "color": "", "icon": "" }, "is_incomplete": true, "first_date": "", "last_updated": "", "is_pos_available": true, "first_date_off_premise": "", "last_date_off_premise": "", "is_off_premise_available": true, "storeWise": [ { "storeId": "", "orderDiff": { "offPremise": 0, "pos": 0, "missedOffPremise": 0, "missedPos": 0, "totalMissedOrders": 0 }, "subTotalDiff": { "pos": 0, "offPremise": 0, "diffOffPremise": 0, "diffPos": 0, "totalDiff": 0 }, "statusDifference": { "totalDiff": 0 }, "revenueToClaimBack": 0 } ] }, "error": null }
curl -i -X GET \
'https://api.voosh.ai/_mock/main/finance-manager/financial/pos-vs-off-premise-details?clientId=604517c0-fae8-41b7-8c20-0fe4778e415c' \
-H 'Content-Type: application/json' \
-H 'access-token: {{access-token}}' \
-d '{
"channel": [
"DOORDASH",
"UBEREATS",
"GRUBHUB",
"EZCATER"
],
"endDate": "2025-03-26",
"listingIds": [
"P5441",
"P5461",
"P5471",
"P5481",
"P5491",
"P5501",
"P5511",
"P5531",
"P5541",
"P5551",
"P5561",
"P5571",
"P5581",
"P8191"
],
"payoutDates": [],
"startDate": "2025-02-23"
}'
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.