Request a business report for multiple stores

post/v1/reports/generate

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesreports.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.

Request body

reportType'ORDER_STORES' | 'ORDER_ITEMS' | 'PAYOUT_TRANSACTIONS' | 'RATINGS_AND_REVIEWS'

Type of report to generate

startstring date

Inclusive report start date.

endstring date

Inclusive report end date.

externalStoreIdsstring[]

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

externalServiceSlugsstring[] nullable

List of external service slugs to fetch orders from. Default to all services

languagestring nullable

Language of the report. Ignored by ORDER_STORES report Optional. Falls back to English if empty.

Example request

{
  "reportType": "ORDER_STORES",
  "start": "2021-10-01T00:00:00.000Z",
  "end": "2021-10-01T00:00:00.000Z",
  "externalStoreIds": [
    "brand1-acbdef",
    "brand1-fghjkl",
    "brand2-qwerty"
  ],
  "externalServiceSlugs": [
    "ubereats",
    "postmates"
  ]
}

Response

The request was successfully processed and report is being generated

jobIdstring

ID used to track the job created for generating report.

Example response

{
  "jobId": "38ab397f-b142-4b06-b70c-40c68a408bea"
}

Changes

No recorded changes to this operation across all 1 revision of this API.