Payments & Vouchers

Discount Usage

The DiscountUsage group of reports cover the usage of promo codes and discount types across individual orders and across all orders.

get/shop/reports/promo-code-usage/summary

Promo code usage summary

listUsedPromoCodesSummary

This endpoint summarises the total discount usage by promo code across all orders matching the given parameters.

Query parameters

site_iduuidrequired
Filter the summary list of used promo codes by site.
revenue_date_fromdateoptional
Filter the summary list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or after this date.
revenue_date_todateoptional
Filter the summary list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or before this date.
submitted_at_fromdateoptional
Filter the summary list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or after this date.
submitted_at_todateoptional
Filter the summary list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or before this date.

Responses

200
The summary of Used Promo Codes was successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/promo-code-usage/summary?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/promo-code-usage/summary?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/promo-code-usage/summary?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/promo-code-usage/summary?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/promo-code-usage/summary?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 summary of Used Promo Codes was successfully retrieved

{
  "data": [
    {
      "discount_type_id": "00000000-0000-0000-0000-000000000000",
      "discount_type_code": "SUMMER23",
      "total_times_used": 1120,
      "total_discount_across_orders": 10000,
      "currency": "gbp",
      "is_archived": false,
      "site_id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

{
  "message": "Unauthenticated"
}

get/shop/reports/promo-code-usage/summary/queue

Promo code usage summary queue

getUsedPromoCodesSummaryQueue

This endpoint queues an export of the summary of the total discount usage by promo code across all orders matching the given parameters.

Query parameters

site_iduuidrequired
Filter the summary list of used promo codes by site.
revenue_date_fromdateoptional
Filter the summary list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or after this date.
revenue_date_todateoptional
Filter the summary list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or before this date.
submitted_at_fromdateoptional
Filter the summary list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or after this date.
submitted_at_todateoptional
Filter the summary list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or before this date.

Responses

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

curl "https://api.playground.try.be/shop/reports/promo-code-usage/summary/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/promo-code-usage/summary/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/promo-code-usage/summary/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/promo-code-usage/summary/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/promo-code-usage/summary/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/promo-code-usage/breakdown

Promo code usage breakdown

listUsedPromoCodesBreakdown

This endpoint provides a breakdown of discount usage by promo code for individual orders matching the given parameters.

Query parameters

site_iduuidrequired
Filter the breakdown list of used promo codes by site.
revenue_date_fromdateoptional
Filter the breakdown list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or after this date.
revenue_date_todateoptional
Filter the breakdown list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or before this date.
submitted_at_fromdateoptional
Filter the breakdown list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or after this date.
submitted_at_todateoptional
Filter the breakdown list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or before this date.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page
sortstringoptional
The field to order results by.
sort_orderstringoptional
The direction to order results by.
Possible values:ascdesc
applied_byuuidoptional
Filter the breakdown list of used promo codes by the user who applied the promo code. This can be either 'Customer' or a member of staff.

Responses

200
The breakdown of UsedPromoCodes was successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/promo-code-usage/breakdown?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/promo-code-usage/breakdown?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/promo-code-usage/breakdown?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/promo-code-usage/breakdown?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/promo-code-usage/breakdown?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 breakdown of `UsedPromoCodes` was successfully retrieved

{
  "data": [
    {
      "discount_type_id": "00000000-0000-0000-0000-000000000000",
      "discount_type_code": "SUMMER23",
      "order_id": "00000000-0000-0000-0000-000000000000",
      "order_ref": "TRY00",
      "order_total": 1000,
      "total_discount_on_order": 1000,
      "currency": "gbp",
      "applied_by": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "avatar": {
          "id": "00000000-0000-0000-0000-000000000000",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "email": "guest@example.com",
        "first_name": "Jane",
        "full_name": "Jane Smith",
        "last_name": "Smith"
      },
      "applied_at": "2026-01-15T09:30:00+00:00",
      "is_archived": false,
      "site_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

get/shop/reports/promo-code-usage/breakdown/queue

Promo code usage breakdown queue

getUsedPromoCodesBreakdownQueue

This endpoint queues an export of the breakdown of discount usage by promo code for individual orders matching the given parameters.

Query parameters

site_iduuidrequired
Filter the breakdown list of used promo codes by site.
revenue_date_fromdateoptional
Filter the breakdown list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or after this date.
revenue_date_todateoptional
Filter the breakdown list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or before this date.
submitted_at_fromdateoptional
Filter the breakdown list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or after this date.
submitted_at_todateoptional
Filter the breakdown list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or before this date.
sortstringoptional
The field to order results by.
sort_orderstringoptional
The direction to order results by.
Possible values:ascdesc
applied_byuuidoptional
Filter the breakdown list of used promo codes by the user who applied the promo code. This can be either 'Customer' or a member of staff.

Responses

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

curl "https://api.playground.try.be/shop/reports/promo-code-usage/breakdown/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/promo-code-usage/breakdown/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/promo-code-usage/breakdown/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/promo-code-usage/breakdown/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/promo-code-usage/breakdown/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/discount-type-usage/summary

Discount type usage summary

listUsedDiscountTypesSummary

This endpoint summarises the total discount usage by discount type across all orders matching the given parameters.

Query parameters

site_iduuidrequired
Filter the summary list of used discount types by site.
revenue_date_fromdateoptional
Filter the summary list of used discount types by revenue date of the order. The discount type must have been used on orders with bookings on or after this date.
revenue_date_todateoptional
Filter the summary list of used discount types by revenue date of the order. The discount type must have been used on orders with bookings on or before this date.
submitted_at_fromdateoptional
Filter the summary list of used discount types by submitted date of the order. The discount type must have been used on orders submitted on or after this date.
submitted_at_todateoptional
Filter the summary list of used discount types by submitted date of the order. The discount type must have been used on orders submitted on or before this date.
discount_typestring[]optional
Filter the summary list of used discount types by the applied discount(s).

Responses

200
The summary of Used Discount Types was successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/discount-type-usage/summary?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/discount-type-usage/summary?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/discount-type-usage/summary?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/discount-type-usage/summary?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/discount-type-usage/summary?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 summary of Used Discount Types was successfully retrieved

{
  "data": [
    {
      "discount_type_id": "00000000-0000-0000-0000-000000000000",
      "discount_type_code": "AMT",
      "total_times_used_on_orders": 64,
      "total_times_used_on_items": 20,
      "total_discount_across_items": 10000,
      "total_discount_across_orders": 10000,
      "total_discount": 20000,
      "currency": "gbp",
      "is_archived": false,
      "site_id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

{
  "message": "Unauthenticated"
}

get/shop/reports/discount-type-usage/summary/queue

Discount type usage summary queue

getUsedDiscountTypesSummaryQueue

This endpoint queues an export of the summary of the total discount usage by discount type across all orders matching the given parameters.

Query parameters

site_iduuidrequired
Filter the summary list of used discount types by site.
revenue_date_fromdateoptional
Filter the summary list of used discount types by revenue date of the order. The discount type must have been used on orders with bookings on or after this date.
revenue_date_todateoptional
Filter the summary list of used discount types by revenue date of the order. The discount type must have been used on orders with bookings on or before this date.
submitted_at_fromdateoptional
Filter the summary list of used discount types by submitted date of the order. The discount type must have been used on orders submitted on or after this date.
submitted_at_todateoptional
Filter the summary list of used discount types by submitted date of the order. The discount type must have been used on orders submitted on or before this date.
discount_typestring[]optional
Filter the summary list of used discount types by the applied discount(s).

Responses

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

curl "https://api.playground.try.be/shop/reports/discount-type-usage/summary/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/discount-type-usage/summary/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/discount-type-usage/summary/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/discount-type-usage/summary/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/discount-type-usage/summary/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/discount-type-usage/breakdown

Discount type usage breakdown

listUsedDiscountTypesBreakdown

This endpoint provides a breakdown of discount usage by discount type for individual orders matching the given parameters.

Query parameters

site_iduuidrequired
Filter the breakdown list of used discount types by site.
revenue_date_fromdateoptional
Filter the breakdown list of used discount types by revenue date of the order. The discount type must have been used on orders with bookings on or after this date.
revenue_date_todateoptional
Filter the breakdown list of used discount types by revenue date of the order. The discount type must have been used on orders with bookings on or before this date.
submitted_at_fromdateoptional
Filter the breakdown list of used discount types by submitted date of the order. The discount type must have been used on orders submitted on or after this date.
submitted_at_todateoptional
Filter the breakdown list of used discount types by submitted date of the order. The discount type must have been used on orders submitted on or before this date.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page
sortstringoptional
The field to order results by.
sort_orderstringoptional
The direction to order results by.
Possible values:ascdesc
applied_byuuidoptional
Filter the breakdown list of used discount types by the user who applied the discount type.

Responses

200
The breakdown of UsedDiscountTypes was successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/discount-type-usage/breakdown?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/discount-type-usage/breakdown?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/discount-type-usage/breakdown?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/discount-type-usage/breakdown?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/discount-type-usage/breakdown?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 breakdown of `UsedDiscountTypes` was successfully retrieved

{
  "data": [
    {
      "discount_type_id": "00000000-0000-0000-0000-000000000000",
      "discount_type_code": "AMT",
      "order_id": "00000000-0000-0000-0000-000000000000",
      "order_ref": "TRY00",
      "discount_applied_to_item": 1000,
      "discount_applied_to_order": 1000,
      "currency": "gbp",
      "applied_by": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "avatar": {
          "id": "00000000-0000-0000-0000-000000000000",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "email": "guest@example.com",
        "first_name": "Jane",
        "full_name": "Jane Smith",
        "last_name": "Smith"
      },
      "applied_at": "2026-01-15T09:30:00+00:00",
      "is_archived": false,
      "site_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

get/shop/reports/discount-type-usage/breakdown/queue

Discount type usage breakdown queue

getUsedDiscountTypesBreakdownQueue

This endpoint queues an export of the breakdown of discount usage by discount type for individual orders matching the given parameters.

Query parameters

site_iduuidrequired
Filter the breakdown list of used discount types by site.
revenue_date_fromdateoptional
Filter the breakdown list of used discount types by revenue date of the order. The discount type must have been used on orders with bookings on or after this date.
revenue_date_todateoptional
Filter the breakdown list of used discount types by revenue date of the order. The discount type must have been used on orders with bookings on or before this date.
submitted_at_fromdateoptional
Filter the breakdown list of used discount types by submitted date of the order. The discount type must have been used on orders submitted on or after this date.
submitted_at_todateoptional
Filter the breakdown list of used discount types by submitted date of the order. The discount type must have been used on orders submitted on or before this date.
applied_byuuidoptional
Filter the breakdown list of used discount types by the user who applied the discount type.
discount_typestring[]optional
Filter the summary list of used discount types by the applied discount(s).

Responses

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

curl "https://api.playground.try.be/shop/reports/discount-type-usage/breakdown/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/discount-type-usage/breakdown/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/discount-type-usage/breakdown/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/discount-type-usage/breakdown/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/discount-type-usage/breakdown/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/discount-usage

Display-formatted table of how each discount type has been used across orders in the filter range. For JSON-native consumption use /shop/reports/discount-usage-v2; for large exports use /shop/reports/discount-usage/queue.

Query parameters

site_iduuidoptional
Restrict to baskets at the given site.
revenue_date_fromdateoptional
Restrict to baskets with a revenue date on or after this date.
revenue_date_todateoptional
Restrict to baskets with a revenue date on or before this date.
submitted_at_fromdateoptional
Restrict to baskets submitted on or after this date.
submitted_at_todateoptional
Restrict to baskets submitted on or before this date.

Responses

200
The report was successfully generated.
400
The request failed.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/discount-usage" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/discount-usage', {
  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/discount-usage",
    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/discount-usage', [
    '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/discount-usage", 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.

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

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

get/shop/reports/discount-usage-v2

Discount usage report (v2)

listDiscountUsageV2

Returns discount usage as a JSON-native list: one row per discount type, with counts and total amounts (in minor units) for baskets, items, and the combined total.

Prefer this endpoint over /shop/reports/discount-usage when integrating with another system.

Query parameters

site_iduuidoptional
Restrict to baskets at the given site.
revenue_date_fromdateoptional
Restrict to baskets with a revenue date on or after this date.
revenue_date_todateoptional
Restrict to baskets with a revenue date on or before this date.
submitted_at_fromdateoptional
Restrict to baskets submitted on or after this date.
submitted_at_todateoptional
Restrict to baskets submitted on or before this date.

Responses

200
The report was successfully generated.
400
The request failed.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/discount-usage-v2" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/discount-usage-v2', {
  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/discount-usage-v2",
    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/discount-usage-v2', [
    '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/discount-usage-v2", 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": [
    {
      "discount_type_id": "60a8c0901d210625e3a87667",
      "is_deleted": true,
      "site_id": "00000000-0000-0000-0000-000000000000",
      "discount_type_name": "Member Discount",
      "discount_type_code": "MEMBER10",
      "num_baskets": 1,
      "num_items": 1,
      "basket_discount_total": 1,
      "item_discount_total": 1,
      "discount_total": 1
    }
  ]
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

get/shop/reports/discount-usage/queue

Queue an export of the discount usage report

queueDiscountUsageExport

Queues a CSV export of the discount usage report to be generated asynchronously.

Query parameters

site_iduuidoptional
Restrict to baskets at the given site.
revenue_date_fromdateoptional
Restrict to baskets with a revenue date on or after this date.
revenue_date_todateoptional
Restrict to baskets with a revenue date on or before this date.
submitted_at_fromdateoptional
Restrict to baskets submitted on or after this date.
submitted_at_todateoptional
Restrict to baskets submitted 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.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/discount-usage/queue" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/discount-usage/queue', {
  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/discount-usage/queue",
    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/discount-usage/queue', [
    '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/discount-usage/queue", 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"
}