Sign in
RevenueByCentre

Revenue by centre summary queue

This endpoint queues an export of the summary of revenue by reporting centre for the given parameters.

get/shop/reports/revenue-by-centre-v2/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.

labelsstring[]

Filter to baskets with the given labels. This can be a comma separated list of label IDs, or 'none' to filter on baskets that don't have any labels.

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.