Create a report
Request generation of a platform report for a date range and store scope. Asynchronous: the response returns the report before its files are ready, normally with status processing.
Failures beyond the document-wide codes: 422 when this (platform, type) is not available to your organization (this includes every DoorDash type, and a scope that resolves to no eligible store), or when the period is longer than the type allows or ends later than its data lag allows. fetchReportCoverage says in advance which requests are valid: read windowConstraint and dataLag together.
NOT safe to retry: this operation changes state and is not idempotent.
Request
- typestring
The platform's own report type, e.g.
PAYMENT_DETAILS_REPORTororder-details. - platformstring
Delivery platform slug, e.g.
ubereatsorgrubhub. - periodStartstring<date>
First day of the period, inclusive.
- periodEndstring<date>
Last day of the period, inclusive.
- locationIdsstring[]
Narrow to stores at these locations. Omit for all locations.
- storeIdsstring[]
Narrow to these stores. Omit for all stores in scope. Mutually exclusive with
locationIds.
{
"type": "<type>",
"platform": "<platform>",
"periodStart": "<periodStart>",
"periodEnd": "<periodEnd>",
"locationIds": [
"<locationIds>"
],
"storeIds": [
"<storeIds>"
]
}Responses
Headers
- x-mealco-tx-idstringoptional
The correlation id for this call, returned on every response that an operation produces, successful or not. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned, so that one response carries neither this header nor the txId field of the error body.
- reportReport
The newly recorded report request. Poll
fetchReportwith itsreportIdfor its status.
{
"report": {
"reportId": "00000000-0000-0000-0000-000000000000",
"type": "<type>",
"platform": "<platform>",
"status": "ready",
"periodStart": "<periodStart>",
"periodEnd": "<periodEnd>",
"requestedAt": "2026-01-01T00:00:00Z",
"completedAt": "2026-01-01T00:00:00Z",
"files": [
{
"downloadUrl": "<downloadUrl>",
"expiresAt": "2026-01-01T00:00:00Z",
"sizeBytes": 50,
"format": "csv"
}
],
"error": "<error>"
}
}About Reports
Partner reporting. Coverage and every report are tenant-scoped and never global: the organization is the one the API key authenticates, and no request field can name another.
createReport is a write: a read-only API key is refused with 403.
Idempotency-Key is accepted on createReport and ignored, so a retried createReport requests a second report with a new reportId. The duplicate uses platform request budget but does not affect the first report: each report is an independent file. Treat a timeout as "may have succeeded" and check fetchReports before retrying.