Request Report
POSThttps://api.uber.com/v1/eats/report
This endpoint will allow a developer to request standardized batch reports (e.g. Payment Details Report) to be generated by Uber Eats. Once the report has been generated, a eats.report.success
webhook notification will be sent to the URL configured in the app dashboard. This webhook notification will contain URL(s) you can use for downloading each section of the report.
¶ Authorization
OAuth 2.0 Bearer token with the eats.report
scope. For more information, see Authentication.
¶ Request Query/Body Parameters
Name | Type | Description |
---|---|---|
report_type |
string (enum) |
9 type of reports are supported by this API. The list is given below:
|
store_uuids |
[]string |
Uber Eats Store UUID(s) against which the report should be generated. One way to enumerate these is by calling the GET /stores endpoint. |
group_uuids |
[]string |
Uber Eats Group UUID(s) against which the report should be generated. This can be used to fetch reports of all stores under the Group |
start_date |
string (YYYY-MM-DD) |
The start date from which this report should contain data. This is store’s local timezone. Note: PAYMENT_DETAILS_REPORT also supports YYYY-MM-DDThh:mm:ss format. |
end_date |
string (YYYY-MM-DD) |
The end date up to which this report should contain data. This is store’s local timezone. Note: PAYMENT_DETAILS_REPORT also supports YYYY-MM-DDThh:mm:ss format. |
¶ Response Fields
Name | Type | Description |
---|---|---|
workflow_id |
string |
A reference ID used to identify this report generation job in subsequent API calls or webhook notifications. There will be a future API that takes this workflow_id as argument and returns the job status/data. |
¶ Endpoint Specific Errors
HTTP Status Code | Description |
---|---|
400 Bad Request |
Invalid request parameter. |
403 Forbidden |
User unauthorized to view data for this restaurant or store. |
414 Precondition Failed |
There was an input validation issue, e.g. start-date is after the end-date. |
413 Payload Too Large |
The generated report is too large limit. Try requesting a smaller date-range. |
416 Out of Range |
|
429 Rate Limited |
Exceeded rate limit. Please wait before trying again. |