Sign in
RevenueByCentre

Queue an export of the revenue by centre report (v1)

Queues a CSV export of the v1 revenue by centre report to be generated asynchronously.

get/shop/reports/revenue-by-centre/queue

Query parameters

site_idstring uuid required

Filter the summary of revenue by centre by site.

revenue_date_fromstring date
Example:2024-05-01

Filter to baskets with revenues on or after this date.

revenue_date_tostring date
Example:2024-05-31

Filter to baskets with revenues on or before this date.

emailboolean

If true, email the completed CSV to the authenticated user when the background job finishes. Defaults to false, in which case the queued job's output URL must be polled via the queued-jobs endpoint.

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

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