Reports

Revenue By Centre

The revenue by centre report provides a summary of revenue by reporting centre.

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

Revenue by centre report

listRevenueByCentreSummary

This endpoint provides a summary of revenue by reporting centre for the given parameters.

Query parameters

site_iduuidrequired
Filter the summary of revenue by centre by site.
revenue_date_fromdateoptional
Filter to baskets with revenues on or after this date.
revenue_date_todateoptional
Filter to baskets with revenues on or before this date.
labelsstring[]optional
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.

Responses

200
The revenue by centre summary was successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/revenue-by-centre-v2?site_id=00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/revenue-by-centre-v2?site_id=00000000-0000-0000-0000-000000000000', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/reports/revenue-by-centre-v2?site_id=00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/reports/revenue-by-centre-v2?site_id=00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/reports/revenue-by-centre-v2?site_id=00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The revenue by centre summary was successfully retrieved

{
  "data": {
    "by_day": [
      {
        "date": "2026-01-15",
        "items_paid": {
          "by_revenue_centre": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "num_items": 35,
          "total_gross": 8000,
          "total_net": 6000,
          "item_average_gross": 5000,
          "item_average_net": 3000
        },
        "items_unpaid": {
          "by_revenue_centre": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "num_items": 35,
          "total_gross": 8000,
          "total_net": 6000,
          "item_average_gross": 5000,
          "item_average_net": 3000
        },
        "totals": {
          "by_revenue_centre": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "num_items": 35,
          "total_gross": 8000,
          "total_net": 6000,
          "item_average_gross": 5000,
          "item_average_net": 3000
        }
      }
    ],
    "totals": {
      "items_paid": {
        "by_revenue_centre": [
          {
            "revenue_centre_id": "fb",
            "revenue_centre_label": "Food & Beverage",
            "gross_revenue": 10000,
            "net_revenue": 8000,
            "num_items": 5
          }
        ],
        "num_items": 35,
        "total_gross": 8000,
        "total_net": 6000,
        "item_average_gross": 5000,
        "item_average_net": 3000
      },
      "items_unpaid": {
        "by_revenue_centre": [
          {
            "revenue_centre_id": "fb",
            "revenue_centre_label": "Food & Beverage",
            "gross_revenue": 10000,
            "net_revenue": 8000,
            "num_items": 5
          }
        ],
        "num_items": 35,
        "total_gross": 8000,
        "total_net": 6000,
        "item_average_gross": 5000,
        "item_average_net": 3000
      },
      "totals": {
        "by_revenue_centre": [
          {
            "revenue_centre_id": "fb",
            "revenue_centre_label": "Food & Beverage",
            "gross_revenue": 10000,
            "net_revenue": 8000,
            "num_items": 5
          }
        ],
        "num_items": 35,
        "total_gross": 8000,
        "total_net": 6000,
        "item_average_gross": 5000,
        "item_average_net": 3000
      }
    }
  },
  "meta": {
    "revenue_centres": [
      {
        "key": "string",
        "name": "Website"
      }
    ]
  }
}

{
  "message": "Unauthenticated"
}

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

Revenue by centre summary queue

getRevenueByCentreSummaryQueue

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

Query parameters

site_iduuidrequired
Filter the summary of revenue by centre by site.
revenue_date_fromdateoptional
Filter to baskets with revenues on or after this date.
revenue_date_todateoptional
Filter to baskets with revenues on or before this date.
labelsstring[]optional
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.

Responses

200
The job was successfully queued
400
The request failed.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/revenue-by-centre-v2/queue?site_id=00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/revenue-by-centre-v2/queue?site_id=00000000-0000-0000-0000-000000000000', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/reports/revenue-by-centre-v2/queue?site_id=00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/reports/revenue-by-centre-v2/queue?site_id=00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/reports/revenue-by-centre-v2/queue?site_id=00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The job was successfully queued

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "output": {},
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

get/shop/reports/revenue-by-centre

Revenue by centre report (v1)

listRevenueByCentre

Display-formatted version of the revenue by centre summary, returning two TableReport blocks: data (one row per day) and totals (the combined totals row).

Prefer /shop/reports/revenue-by-centre-v2 for programmatic / JSON consumption. For large date ranges or background CSV delivery use /shop/reports/revenue-by-centre/queue.

Query parameters

site_iduuidrequired
Filter the summary of revenue by centre by site.
revenue_date_fromdateoptional
Filter to baskets with revenues on or after this date.
revenue_date_todateoptional
Filter to baskets with revenues on or before this date.

Responses

200
The report was successfully generated.
400
The request failed.

curl "https://api.playground.try.be/shop/reports/revenue-by-centre?site_id=00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/revenue-by-centre?site_id=00000000-0000-0000-0000-000000000000', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/reports/revenue-by-centre?site_id=00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/reports/revenue-by-centre?site_id=00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/reports/revenue-by-centre?site_id=00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The report was successfully generated.

{
  "data": {
    "rows": [
      {
        "cells": [
          {
            "format": "th",
            "value": "string"
          }
        ]
      }
    ]
  },
  "totals": {
    "rows": [
      {
        "cells": [
          {
            "format": "th",
            "value": "string"
          }
        ]
      }
    ]
  }
}

{
  "message": "string"
}

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

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

queueRevenueByCentreExport

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

Query parameters

site_iduuidrequired
Filter the summary of revenue by centre by site.
revenue_date_fromdateoptional
Filter to baskets with revenues on or after this date.
revenue_date_todateoptional
Filter to baskets with revenues on or before this date.
emailbooleanoptional
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.

Responses

200
The job was successfully queued
400
The request failed.

curl "https://api.playground.try.be/shop/reports/revenue-by-centre/queue?site_id=00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/revenue-by-centre/queue?site_id=00000000-0000-0000-0000-000000000000', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/reports/revenue-by-centre/queue?site_id=00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/reports/revenue-by-centre/queue?site_id=00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/reports/revenue-by-centre/queue?site_id=00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The job was successfully queued

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "output": {},
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

{
  "message": "string"
}