OrganisationReports
Queue an export of the organisation revenue by sales channel report.
This endpoint queues an export of the organisation revenue by sales channel report.
get/shop/reports/organisation/revenue-by-sales-channel/queue
Query parameters
revenue_date_fromstring date
Example:2024-03-01
Include revenues on or after this date.
revenue_date_tostring date
Example:2024-03-31
Include revenues on or before this date.
submitted_at_fromstring date
Example:2024-03-31
Include revenues for orders submitted on or after this date.
submitted_at_tostring date
Example:2024-03-31
Include revenues for orders submitted on or before this date.
item_date_fromstring date
Example:2024-03-01
Include items taking place on or after this date.
item_date_tostring date
Example:2024-03-31
Include items taking place on or before this date.
sales_channelstring[]
Include revenues from the given sales channel(s).
revenue_centrestring[]
Include revenues with the selected revenue centre(s).
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.