---
title: "Request a business report for multiple stores"
method: POST
path: "/v1/reports/generate"
tags: ["reports_endpoints"]
deprecated: true
---

# Request a business report for multiple stores

`POST /v1/reports/generate`

## Request

- Base URL: `https://partners.tryotter.com`
- URL: `https://partners.tryotter.com/v1/reports/generate`
- Auth: OAuth 2
  - Authorization code: `/v1/auth/oauth2/authorize`
  - Client credentials
  - Token URL: `/v1/auth/token` scopes: `reports.generate_report`
- TypeScript: <https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/reports/generate/post.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

## Request body

- GenerateReportMultiRequest: The request to generate a report for multiple stores.
  - `reportType` 'ORDER_STORES' | 'ORDER_ITEMS' | 'PAYOUT_TRANSACTIONS' | 'RATINGS_AND_REVIEWS': Type of report to generate
  - `start` string, date: Inclusive report start date.
  - `end` string, date: Inclusive report end date.
  - `externalStoreIds` string[]: List of external store IDs to filter the orders with. At least one value is required. Max is 5000. Fails the requests if one or more invalid external store ID is passed
  - `externalServiceSlugs` string[], nullable: List of external service slugs to fetch orders from. Default to all services
  - `language` string, nullable: Language of the report. Ignored by ORDER_STORES report Optional. Falls back to English if empty.

## Response `200`

The request was successfully processed and report is being generated

- GenerateReportResponse: The response to a generate report request
  - `jobId` string: ID used to track the job created for generating report.

## Other responses

- `400`: The request is malformed.
- `401`: Invalid authorization.
- `403`: Authorization not valid for the requested resource.
- `404`: Resource not found.
- `422`: The request body is not valid.

---

[API](https://skmtc.dev/cloudkitchens/apis/otter-api.md) - [All operations](https://skmtc.dev/cloudkitchens/apis/otter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudkitchens/apis/otter-api/revisions/4c868194a467?raw)