Sites & Organisation

Organisations

An Organisation is the top-level account that owns one or more Brands and their Sites — the unit of contract, billing, and cross-site user-access management. The endpoints in this section cover the resources that belong to an organisation rather than to any single site (categories, labels, custom payment types, revenue centres, etc.).

The Organisation object

Attributes

iduuidrequired
Stable identifier for the organisation.
namestringrequired
Display name of the organisation as it appears in Trybe-internal tooling and on contracts. Not normally surfaced to end customers, who see the brand or site name instead.
created_atdate-timerequired
When the organisation was provisioned in Trybe.

get/shop/organisations/{organisationId}/categories

List Categories

listOrganisationCategories

Returns an array of all categories the current user has permission to view.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Query parameters

voucher_applicablebooleanoptional
Only return voucher categories.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The categories were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories', {
  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/organisations/00000000-0000-0000-0000-000000000000/categories",
    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/organisations/00000000-0000-0000-0000-000000000000/categories', [
    '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/organisations/00000000-0000-0000-0000-000000000000/categories", 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 categories were successfully retrieved.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Alex Morgan",
      "organisation_id": "00000000-0000-0000-0000-000000000000",
      "voucher_applicable": false
    }
  ],
  "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"
}

{
  "message": "The requested resource could not be found"
}

post/shop/organisations/{organisationId}/categories

Create a Category

createOrganisationCategory

Create a new category that belongs to the given organisation.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Request body

namestringoptional
Display name of the category, shown to customers on the storefront and to staff in the admin UI. Categories group offerings (treatments, classes, products) for navigation and reporting. 1-120 characters; must not contain HTML.
voucher_applicablebooleanoptional
Whether the category can be selected when issuing vouchers.

Responses

201
The category was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Massages",
  "voucher_applicable": false
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Massages",
    "voucher_applicable": false
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Massages",
        "voucher_applicable": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Massages',
            'voucher_applicable' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Massages",
		"voucher_applicable": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 category was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Alex Morgan",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "voucher_applicable": false
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/organisations/{organisationId}/categories/order

List Categories In Order

listOrganisationCategoryOrder

Returns all categories the current user has permission to view, in their persisted display order.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Query parameters

voucher_applicablebooleanoptional
Only return voucher categories.

Responses

200
The ordered categories were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/order" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/order', {
  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/organisations/00000000-0000-0000-0000-000000000000/categories/order",
    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/organisations/00000000-0000-0000-0000-000000000000/categories/order', [
    '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/organisations/00000000-0000-0000-0000-000000000000/categories/order", 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 ordered categories were successfully retrieved.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Alex Morgan",
      "organisation_id": "00000000-0000-0000-0000-000000000000",
      "voucher_applicable": false
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/shop/organisations/{organisationId}/categories/order

Update Category Order

updateOrganisationCategoryOrder

Persists the display order of categories. The position of each ID in the category_ids array is stored as that category's order.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Request body

category_idsstring[]required
The category IDs in their desired display order.

Responses

200
The ordered categories were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/order" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "category_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/order', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "category_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/order",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "category_ids": [
            "00000000-0000-0000-0000-000000000000"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/order', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'category_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"category_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/order", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 ordered categories were successfully retrieved.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Alex Morgan",
      "organisation_id": "00000000-0000-0000-0000-000000000000",
      "voucher_applicable": false
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/organisations/{organisationId}/categories/order/all

List All Categories

listAllOrganisationCategories

Returns every category belonging to the organisation in its persisted display order, regardless of voucher_applicable.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Responses

200
The ordered categories were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/order/all" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/order/all', {
  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/organisations/00000000-0000-0000-0000-000000000000/categories/order/all",
    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/organisations/00000000-0000-0000-0000-000000000000/categories/order/all', [
    '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/organisations/00000000-0000-0000-0000-000000000000/categories/order/all", 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 ordered categories were successfully retrieved.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Alex Morgan",
      "organisation_id": "00000000-0000-0000-0000-000000000000",
      "voucher_applicable": false
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

get/shop/organisations/{organisationId}/categories/{categoryId}

Get Category

getOrganisationCategory

Returns the details of a single category.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
categoryIduuidrequired
The ID of the Category.

Responses

200
The category was successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/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/organisations/00000000-0000-0000-0000-000000000000/categories/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/organisations/00000000-0000-0000-0000-000000000000/categories/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/organisations/00000000-0000-0000-0000-000000000000/categories/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/organisations/00000000-0000-0000-0000-000000000000/categories/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 category was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Alex Morgan",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "voucher_applicable": false
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/shop/organisations/{organisationId}/categories/{categoryId}

Update a Category

updateOrganisationCategory

Update an existing category.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
categoryIduuidrequired
The ID of the Category.

Request body

namestringoptional
Display name of the category, shown to customers on the storefront and to staff in the admin UI. Categories group offerings (treatments, classes, products) for navigation and reporting. 1-120 characters; must not contain HTML.
voucher_applicablebooleanoptional
Whether the category can be selected when issuing vouchers.

Responses

200
The category was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Massages",
  "voucher_applicable": false
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Massages",
    "voucher_applicable": false
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Massages",
        "voucher_applicable": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Massages',
            'voucher_applicable' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Massages",
		"voucher_applicable": false,
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 category was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Alex Morgan",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "voucher_applicable": false
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/organisations/{organisationId}/categories/{categoryId}

Delete a Category

deleteOrganisationCategory

Delete the given category.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
categoryIduuidrequired
The ID of the Category.

Responses

204
The category was successfully deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/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/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/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('DELETE', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/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("DELETE", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/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 category was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/organisations/{organisationId}/categories/{categoryId}/copy

Copy a Category

copyOrganisationCategory

Copies the given category. Any properties supplied in the request body will override the corresponding values on the new category.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
categoryIduuidrequired
The ID of the Category.

Request body

namestringoptional
Display name to give the duplicated category. The new category inherits the source's offerings and settings; the name distinguishes the copy from the original. 1-120 characters; must not contain HTML.
voucher_applicablebooleanoptional
Whether the new category can be selected when issuing vouchers.

Responses

201
The category was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000/copy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Massages (Summer 2026)",
  "voucher_applicable": false
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000/copy', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Massages (Summer 2026)",
    "voucher_applicable": false
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000/copy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Massages (Summer 2026)",
        "voucher_applicable": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000/copy', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Massages (Summer 2026)',
            'voucher_applicable' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Massages (Summer 2026)",
		"voucher_applicable": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/categories/00000000-0000-0000-0000-000000000000/copy", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 category was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Alex Morgan",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "voucher_applicable": false
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/organisations/{organisationId}/custom-payment-types

List custom payment types

listOrganisationCustomPaymentTypes

Returns all CustomPaymentTypes defined on the named Organisation. Custom payment types are shared across the organisation's Sites; assign them to individual sites via updateShopSite using the custom_payment_type_ids field.

The response is currently un-paginated — every custom payment type on the organisation is returned in one shot regardless of the page / per_page query parameters. The parameters are accepted (so a generic paginated-list helper can be pointed at this endpoint without special-casing) but treated as no-ops by the backend. Pass per_page=-1 for the same effect.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Query parameters

pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The custom payment types were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types', {
  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/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types",
    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/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types', [
    '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/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types", 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 custom payment types were successfully retrieved.

{
  "data": [
    {
      "id": "5f8d944e79c9f341846e807a",
      "name": "Hotel Folio",
      "kind": "pms_prepaid",
      "fiscalisation_type": "cash"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

post/shop/organisations/{organisationId}/custom-payment-types

Create a custom payment type

createOrganisationCustomPaymentType

Create a new CustomPaymentType on the named Organisation.

The newly created payment type is not automatically enabled on any Site — add it to a site's custom_payment_type_ids via updateShopSite to make it selectable at the till.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Request body

namestringrequired
Display name shown to staff when accepting payment. 1-120 characters; required.
kindstringoptionalnullable
Optional classification used to drive special handling. See the kind field on CustomPaymentType for the full meaning of each value.
Possible values:pms_prepaidvoucherprepayment
fiscalisation_typestringoptionalnullable
Optional mapping used when posting to fiscalisation integrations that require a tender-type code.
Possible values:unknowncashdebit_cardcredit_cardvoucheronline

Responses

201
The custom payment type was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Hotel Folio",
  "kind": "pms_prepaid",
  "fiscalisation_type": "cash"
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Hotel Folio",
    "kind": "pms_prepaid",
    "fiscalisation_type": "cash"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Hotel Folio",
        "kind": "pms_prepaid",
        "fiscalisation_type": "cash"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Hotel Folio',
            'kind' => 'pms_prepaid',
            'fiscalisation_type' => 'cash'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Hotel Folio",
		"kind": "pms_prepaid",
		"fiscalisation_type": "cash",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 custom payment type was successfully retrieved.

{
  "data": {
    "id": "5f8d944e79c9f341846e807a",
    "name": "Hotel Folio",
    "kind": "pms_prepaid",
    "fiscalisation_type": "cash"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/organisations/{organisationId}/custom-payment-types/{customPaymentTypeId}

Get a custom payment type

getOrganisationCustomPaymentType

Returns the details of a single CustomPaymentType.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
customPaymentTypeIduuidrequired
The ID of the CustomPaymentType.

Responses

200
The custom payment type was successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/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/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/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/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/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/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/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/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/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 custom payment type was successfully retrieved.

{
  "data": {
    "id": "5f8d944e79c9f341846e807a",
    "name": "Hotel Folio",
    "kind": "pms_prepaid",
    "fiscalisation_type": "cash"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/shop/organisations/{organisationId}/custom-payment-types/{customPaymentTypeId}

Update a custom payment type

updateOrganisationCustomPaymentType

Update an existing CustomPaymentType. Changes apply immediately to every Site that has the payment type attached.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
customPaymentTypeIduuidrequired
The ID of the CustomPaymentType.

Request body

namestringoptional
Updated display name. When omitted the existing name is preserved.
kindstringoptionalnullable
Updated classification. Pass null to clear back to the generic-tender default.
Possible values:pms_prepaidvoucherprepayment
fiscalisation_typestringoptionalnullable
Updated fiscalisation mapping.
Possible values:unknowncashdebit_cardcredit_cardvoucheronline

Responses

200
The custom payment type was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Hotel Folio",
  "kind": "pms_prepaid",
  "fiscalisation_type": "cash"
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Hotel Folio",
    "kind": "pms_prepaid",
    "fiscalisation_type": "cash"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Hotel Folio",
        "kind": "pms_prepaid",
        "fiscalisation_type": "cash"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Hotel Folio',
            'kind' => 'pms_prepaid',
            'fiscalisation_type' => 'cash'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Hotel Folio",
		"kind": "pms_prepaid",
		"fiscalisation_type": "cash",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 custom payment type was successfully retrieved.

{
  "data": {
    "id": "5f8d944e79c9f341846e807a",
    "name": "Hotel Folio",
    "kind": "pms_prepaid",
    "fiscalisation_type": "cash"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/organisations/{organisationId}/custom-payment-types/{customPaymentTypeId}

Delete a custom payment type

deleteOrganisationCustomPaymentType

Delete a CustomPaymentType. Trybe will also remove the payment type's ID from custom_payment_type_ids on every Site in the organisation, so the tender stops appearing at the till.

Historical orders that recorded the payment type are preserved via soft-delete.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
customPaymentTypeIduuidrequired
The ID of the CustomPaymentType.

Responses

204
The custom payment type was successfully deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/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/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/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('DELETE', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/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("DELETE", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/custom-payment-types/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 custom payment type was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/organisations/{organisationId}/date-sets

Get a list of all date sets belonging to the organisation.

listDateSets

Returns an array of all date sets the current user has permission to view.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Query parameters

fromdateoptional
Retrieve DataSets after this value.
limitintegeroptional
The number of DataSets to retrieve.

Responses

200
DateSets were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets', {
  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/organisations/00000000-0000-0000-0000-000000000000/date-sets",
    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/organisations/00000000-0000-0000-0000-000000000000/date-sets', [
    '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/organisations/00000000-0000-0000-0000-000000000000/date-sets", 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)
}

`DateSet`s were successfully retrieved.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "dates": [
        {
          "date": "2026-01-15",
          "label": "string"
        }
      ],
      "name": "Bank holidays",
      "organisation_id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

post/shop/organisations/{organisationId}/date-sets

Create a new DateSet

createDateSet

Use this endpoint to create a new DateSet.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Query parameters

fromdateoptional
Retrieve DataSets after this value.
limitintegeroptional
The number of DataSets to retrieve.

Request body

datesobject[]optional
The dates in the date set.
namestringoptional
Label for the date set, shown wherever the set is referenced in the admin UI (date pickers, coupon validity, opening exceptions). Use a meaningful label like "Bank holidays" or "Closed for refurb". 1-120 characters.

Responses

201
The date set was successfully created.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "dates": [
    {
      "date": "2026-01-15",
      "label": "string"
    }
  ],
  "name": "Bank holidays"
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "dates": [
      {
        "date": "2026-01-15",
        "label": "string"
      }
    ],
    "name": "Bank holidays"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "dates": [
            {
                "date": "2026-01-15",
                "label": "string"
            }
        ],
        "name": "Bank holidays"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'dates' => [
                [
                    'date' => '2026-01-15',
                    'label' => 'string'
                ]
            ],
            'name' => 'Bank holidays'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"dates": []interface{}{
			map[string]interface{}{
				"date": "2026-01-15",
				"label": "string",
			},
		},
		"name": "Bank holidays",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 date set was successfully created.

{}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/organisations/{organisationId}/date-sets/{dateSetId}

Retrieve a DateSet

getDateSet

Use this endpoint to retrieve a DateSet.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
dateSetIdobject-idrequired
The ID of the DateSet.

Responses

200
The date set details were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123', {
  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/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123",
    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/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123', [
    '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/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123", 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 date set details were successfully retrieved.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "dates": [
      {
        "date": "2026-01-15",
        "label": "string"
      }
    ],
    "name": "Bank holidays",
    "organisation_id": "00000000-0000-0000-0000-000000000000"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

patch/shop/organisations/{organisationId}/date-sets/{dateSetId}

Update a DateSet

updateDateSet

Use this endpoint to update a DateSet.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
dateSetIdobject-idrequired
The ID of the DateSet.

Request body

datesobject[]optional
The dates in the date set.
namestringoptional
Label for the date set, shown wherever the set is referenced in the admin UI (date pickers, coupon validity, opening exceptions). Use a meaningful label like "Bank holidays" or "Closed for refurb". 1-120 characters.

Responses

201
The date set was successfully updated.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PATCH "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "dates": [
    {
      "date": "2026-01-15",
      "label": "string"
    }
  ],
  "name": "Bank holidays"
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "dates": [
      {
        "date": "2026-01-15",
        "label": "string"
      }
    ],
    "name": "Bank holidays"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.patch(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "dates": [
            {
                "date": "2026-01-15",
                "label": "string"
            }
        ],
        "name": "Bank holidays"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'dates' => [
                [
                    'date' => '2026-01-15',
                    'label' => 'string'
                ]
            ],
            'name' => 'Bank holidays'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"dates": []interface{}{
			map[string]interface{}{
				"date": "2026-01-15",
				"label": "string",
			},
		},
		"name": "Bank holidays",
	})
	req, _ := http.NewRequest("PATCH", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 date set was successfully updated.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "dates": [
      {
        "date": "2026-01-15",
        "label": "string"
      }
    ],
    "name": "Bank holidays",
    "organisation_id": "00000000-0000-0000-0000-000000000000"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

put/shop/organisations/{organisationId}/date-sets/{dateSetId}

Replace a DateSet

actionReplaceDateSet

Replaces the name and dates of a DateSet with the supplied values. Functionally equivalent to the PATCH route — both end up routed to the same handler — exposed as PUT for legacy API clients that prefer the verb's "full replacement" semantics. Any field omitted from the body is treated as unchanged, matching the PATCH behaviour.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
dateSetIdobject-idrequired
The ID of the DateSet.

Request body

datesobject[]optional
The dates in the date set.
namestringoptional
Label for the date set, shown wherever the set is referenced in the admin UI (date pickers, coupon validity, opening exceptions). Use a meaningful label like "Bank holidays" or "Closed for refurb". 1-120 characters.

Responses

200
The date set was successfully updated.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "dates": [
    {
      "date": "2026-01-15",
      "label": "string"
    }
  ],
  "name": "Bank holidays"
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "dates": [
      {
        "date": "2026-01-15",
        "label": "string"
      }
    ],
    "name": "Bank holidays"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "dates": [
            {
                "date": "2026-01-15",
                "label": "string"
            }
        ],
        "name": "Bank holidays"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'dates' => [
                [
                    'date' => '2026-01-15',
                    'label' => 'string'
                ]
            ],
            'name' => 'Bank holidays'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"dates": []interface{}{
			map[string]interface{}{
				"date": "2026-01-15",
				"label": "string",
			},
		},
		"name": "Bank holidays",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 date set was successfully updated.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "dates": [
      {
        "date": "2026-01-15",
        "label": "string"
      }
    ],
    "name": "Bank holidays",
    "organisation_id": "00000000-0000-0000-0000-000000000000"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/organisations/{organisationId}/date-sets/{dateSetId}

Delete a DateSet

deleteDateSet

Permanently deletes the DateSet. The dates the set contained are no longer treated as restricted/special, but any bookings that were placed while the set was active remain unaffected.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
dateSetIdobject-idrequired
The ID of the DateSet.

Responses

204
The date set was successfully deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123', [
    '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("DELETE", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/date-sets/abc123", 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 date set was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/organisations/{organisationId}/appointment-tags

List Appointment Tags

listOrganisationAppointmentTags

Returns a paginated list of every appointment tag that belongs to the organisation. Tags are returned in creation order; use the pagination parameters to walk through large result sets.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Query parameters

pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The appointment tags were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags', {
  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/organisations/00000000-0000-0000-0000-000000000000/appointment-tags",
    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/organisations/00000000-0000-0000-0000-000000000000/appointment-tags', [
    '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/organisations/00000000-0000-0000-0000-000000000000/appointment-tags", 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 appointment tags were successfully retrieved.

{
  "data": [
    {
      "id": "6630f7a8e1a4c2b1d4d5e7c1",
      "name": "Signature",
      "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
    }
  ],
  "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"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/organisations/{organisationId}/appointment-tags

Create an Appointment Tag

createOrganisationAppointmentTag

Create a new appointment tag against the given organisation. The tag becomes immediately available to every site under the organisation and can subsequently be attached to appointment types.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Request body

namestringrequired
Display name of the tag, shown to staff in the admin UI and used when grouping appointment types in reports. 1-120 characters; must not contain HTML.

Responses

201
The appointment tag was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Signature"
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Signature"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Signature"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Signature'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Signature",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 appointment tag was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "Signature",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/organisations/{organisationId}/appointment-tags/{appointmentTagId}

Get an Appointment Tag

getOrganisationAppointmentTag

Returns the details of a single appointment tag, including its display name and the organisation it belongs to.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
appointmentTagIduuidrequired
The unique identifier of the appointment tag. Tag IDs are stable once issued and can be referenced from appointment-type payloads.

Responses

200
The appointment tag was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/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/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/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/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/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/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/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/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/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 appointment tag was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "Signature",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/organisations/{organisationId}/appointment-tags/{appointmentTagId}

Update an Appointment Tag

updateOrganisationAppointmentTag

Updates the display name of an existing appointment tag. The new name is reflected immediately wherever the tag is used in the admin UI and in reports.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
appointmentTagIduuidrequired
The unique identifier of the appointment tag. Tag IDs are stable once issued and can be referenced from appointment-type payloads.

Request body

namestringrequired
Display name of the tag, shown to staff in the admin UI and used when grouping appointment types in reports. 1-120 characters; must not contain HTML.

Responses

200
The appointment tag was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Signature"
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Signature"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Signature"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Signature'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Signature",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 appointment tag was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "Signature",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/organisations/{organisationId}/appointment-tags/{appointmentTagId}

Delete an Appointment Tag

deleteOrganisationAppointmentTag

Permanently deletes the appointment tag. The tag is removed from every appointment type it was previously attached to; existing bookings are not affected.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
appointmentTagIduuidrequired
The unique identifier of the appointment tag. Tag IDs are stable once issued and can be referenced from appointment-type payloads.

Responses

204
The appointment tag was successfully deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/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/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/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('DELETE', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/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("DELETE", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/appointment-tags/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 appointment tag was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/organisations/{organisationId}/labels

List Labels

listOrganisationLabels

Returns a paginated list of every label that belongs to the organisation. Labels are coloured tags used to highlight or categorise records (customers, bookings, orders) in the admin UI. Use the pagination parameters to walk through large result sets.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Query parameters

site_iduuidoptional
Optional filter restricting the response to labels visible at the given site. When set, the response includes both labels with no site restriction (visible everywhere in the organisation) and labels explicitly scoped to this site via the label's site_ids list. When omitted, every label in the organisation is returned.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The labels were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels', {
  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/organisations/00000000-0000-0000-0000-000000000000/labels",
    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/organisations/00000000-0000-0000-0000-000000000000/labels', [
    '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/organisations/00000000-0000-0000-0000-000000000000/labels", 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 labels were successfully retrieved.

{
  "data": [
    {
      "id": "6630f7a8e1a4c2b1d4d5e7c1",
      "name": "VIP",
      "color": "#ff5733",
      "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9",
      "site_ids": [
        "65a0c2e5b3a7d2f8c1d4e7ba",
        "65a0c2e5b3a7d2f8c1d4e7bb"
      ]
    }
  ],
  "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"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/organisations/{organisationId}/labels

Create a Label

createOrganisationLabel

Create a new label against the given organisation. Labels can be restricted to a subset of the organisation's sites by passing the relevant site_ids; staff at other sites won't see the label in the admin UI.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Request body

namestringrequired
Display name of the label. 1-40 characters; must not contain HTML.
colorstringoptionalnullable
Hex colour used to render the label in the admin UI, including the leading #. Lower-case hexadecimal; must match #rrggbb. Defaults to #f1f1f1 when omitted.
site_idsstring[]required
Identifiers of the sites within the organisation that should be allowed to see and apply this label. Every site ID must belong to the same organisation as the label.

Responses

201
The label was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP",
  "color": "#ff5733",
  "site_ids": [
    "65a0c2e5b3a7d2f8c1d4e7ba"
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "VIP",
    "color": "#ff5733",
    "site_ids": [
      "65a0c2e5b3a7d2f8c1d4e7ba"
    ]
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "VIP",
        "color": "#ff5733",
        "site_ids": [
            "65a0c2e5b3a7d2f8c1d4e7ba"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'VIP',
            'color' => '#ff5733',
            'site_ids' => [
                '65a0c2e5b3a7d2f8c1d4e7ba'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "VIP",
		"color": "#ff5733",
		"site_ids": []interface{}{
			"65a0c2e5b3a7d2f8c1d4e7ba",
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 label was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "VIP",
    "color": "#ff5733",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9",
    "site_ids": [
      "65a0c2e5b3a7d2f8c1d4e7ba",
      "65a0c2e5b3a7d2f8c1d4e7bb"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/organisations/{organisationId}/labels/{labelId}

Get a Label

getOrganisationLabel

Returns the details of a single label, including its colour, the organisation it belongs to, and the sites it is visible to.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
labelIduuidrequired
The unique identifier of the label. Label IDs are stable once issued and can be referenced from any record the label is attached to.

Responses

200
The label was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/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/organisations/00000000-0000-0000-0000-000000000000/labels/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/organisations/00000000-0000-0000-0000-000000000000/labels/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/organisations/00000000-0000-0000-0000-000000000000/labels/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/organisations/00000000-0000-0000-0000-000000000000/labels/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 label was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "VIP",
    "color": "#ff5733",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9",
    "site_ids": [
      "65a0c2e5b3a7d2f8c1d4e7ba",
      "65a0c2e5b3a7d2f8c1d4e7bb"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/organisations/{organisationId}/labels/{labelId}

Update a Label

updateOrganisationLabel

Update an existing label. Pass the fields you want to change; site_ids is required and replaces the stored list of sites the label is visible to.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
labelIduuidrequired
The unique identifier of the label. Label IDs are stable once issued and can be referenced from any record the label is attached to.

Request body

namestringoptional
Display name of the label. 1-40 characters; must not contain HTML.
colorstringoptionalnullable
Hex colour used to render the label in the admin UI, including the leading #. Lower-case hexadecimal; must match #rrggbb.
site_idsstring[]required
Identifiers of the sites within the organisation that should be allowed to see and apply this label. Every site ID must belong to the same organisation as the label. The provided list replaces any previously stored list.

Responses

200
The label was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP",
  "color": "#ff5733",
  "site_ids": [
    "65a0c2e5b3a7d2f8c1d4e7ba"
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "VIP",
    "color": "#ff5733",
    "site_ids": [
      "65a0c2e5b3a7d2f8c1d4e7ba"
    ]
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "VIP",
        "color": "#ff5733",
        "site_ids": [
            "65a0c2e5b3a7d2f8c1d4e7ba"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'VIP',
            'color' => '#ff5733',
            'site_ids' => [
                '65a0c2e5b3a7d2f8c1d4e7ba'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "VIP",
		"color": "#ff5733",
		"site_ids": []interface{}{
			"65a0c2e5b3a7d2f8c1d4e7ba",
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 label was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "VIP",
    "color": "#ff5733",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9",
    "site_ids": [
      "65a0c2e5b3a7d2f8c1d4e7ba",
      "65a0c2e5b3a7d2f8c1d4e7bb"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/organisations/{organisationId}/labels/{labelId}

Delete a Label

deleteOrganisationLabel

Soft-delete the label. Records previously tagged with the label keep the historical association but the label will no longer appear in pickers or filters.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
labelIduuidrequired
The unique identifier of the label. Label IDs are stable once issued and can be referenced from any record the label is attached to.

Responses

204
The label was successfully deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/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/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/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('DELETE', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/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("DELETE", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/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 label was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/organisations/{organisationId}/revenue-centres

List Revenue Centres

listOrganisationRevenueCentres

Returns every revenue centre defined for the organisation. The response includes Trybe's system revenue centres (spa, deposit, membership fees, ...) and any custom centres the operator has added. The meta.has_custom_revenue_centres flag indicates whether the organisation has overridden the Trybe defaults.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Responses

200
The revenue centres were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres', {
  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/organisations/00000000-0000-0000-0000-000000000000/revenue-centres",
    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/organisations/00000000-0000-0000-0000-000000000000/revenue-centres', [
    '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/organisations/00000000-0000-0000-0000-000000000000/revenue-centres", 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 centres were successfully retrieved.

{
  "data": [
    {
      "id": "spa",
      "key": "spa",
      "name": "Spa",
      "tax_percent": 20,
      "tax_configuration": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "name": "UK VAT"
      },
      "is_required": true
    }
  ],
  "meta": {
    "has_custom_revenue_centres": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/organisations/{organisationId}/revenue-centres

Create a Revenue Centre

createOrganisationRevenueCentre

Add a new revenue centre to the organisation. Pass at minimum a display name; key can be supplied if you want a stable identifier for use from external integrations. Adding the first custom centre flips has_custom_revenue_centres to true on subsequent list responses.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Request body

keystringoptional
Optional stable key for the new revenue centre. Used when looking the centre up from external integrations. Defaults to a slugified form of name when omitted.
namestringrequired
Display name of the revenue centre, shown in the admin UI and on financial reports.
tax_percentnumberoptionalnullable
The percentage of tax to apply to sales recorded against this revenue centre when no per-line tax configuration overrides it.

Responses

200
The revenue centre was successfully retrieved.
400
The request failed.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "retail",
  "name": "Retail",
  "tax_percent": 20
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "key": "retail",
    "name": "Retail",
    "tax_percent": 20
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "key": "retail",
        "name": "Retail",
        "tax_percent": 20
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'key' => 'retail',
            'name' => 'Retail',
            'tax_percent' => 20
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"key": "retail",
		"name": "Retail",
		"tax_percent": 20,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 centre was successfully retrieved.

{
  "data": {
    "id": "spa",
    "key": "spa",
    "name": "Spa",
    "tax_percent": 20,
    "tax_configuration": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "name": "UK VAT"
    },
    "is_required": true
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/organisations/{organisationId}/revenue-centres/{revenueCentreId}

Get a Revenue Centre

getOrganisationRevenueCentre

Returns the details of a single revenue centre, including its display name, default tax percentage, and whether it is a required Trybe revenue centre that cannot be deleted.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
revenueCentreIdstringrequired
The identifier of the revenue centre. System revenue centres use stable, lower-case slugs (spa, deposit, ...); custom ones are issued when the centre is created.

Responses

200
The revenue centre was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', {
  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/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123",
    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/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', [
    '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/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123", 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 centre was successfully retrieved.

{
  "data": {
    "id": "spa",
    "key": "spa",
    "name": "Spa",
    "tax_percent": 20,
    "tax_configuration": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "name": "UK VAT"
    },
    "is_required": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/organisations/{organisationId}/revenue-centres/{revenueCentreId}

Update a Revenue Centre

updateOrganisationRevenueCentre

Update an existing revenue centre. The name is required; key and tax_percent can be supplied to change those fields. System revenue centres can be renamed and have their tax percentage updated but cannot be deleted.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
revenueCentreIdstringrequired
The identifier of the revenue centre. System revenue centres use stable, lower-case slugs (spa, deposit, ...); custom ones are issued when the centre is created.

Request body

keystringoptional
Optional stable key for the new revenue centre. Used when looking the centre up from external integrations. Defaults to a slugified form of name when omitted.
namestringrequired
Display name of the revenue centre, shown in the admin UI and on financial reports.
tax_percentnumberoptionalnullable
The percentage of tax to apply to sales recorded against this revenue centre when no per-line tax configuration overrides it.

Responses

200
The revenue centre was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "retail",
  "name": "Retail",
  "tax_percent": 20
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "key": "retail",
    "name": "Retail",
    "tax_percent": 20
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "key": "retail",
        "name": "Retail",
        "tax_percent": 20
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'key' => 'retail',
            'name' => 'Retail',
            'tax_percent' => 20
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"key": "retail",
		"name": "Retail",
		"tax_percent": 20,
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 centre was successfully retrieved.

{
  "data": {
    "id": "spa",
    "key": "spa",
    "name": "Spa",
    "tax_percent": 20,
    "tax_configuration": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "name": "UK VAT"
    },
    "is_required": true
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/organisations/{organisationId}/revenue-centres/{revenueCentreId}

Delete a Revenue Centre

deleteOrganisationRevenueCentre

Permanently delete the revenue centre from the organisation. System revenue centres (spa, deposit, membership joining fee, membership fee, and deposit redemption) cannot be deleted and will return 400 Bad Request. Historical ledger lines that referenced the centre keep their reference for reporting purposes.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
revenueCentreIdstringrequired
The identifier of the revenue centre. System revenue centres use stable, lower-case slugs (spa, deposit, ...); custom ones are issued when the centre is created.

Responses

204
The revenue centre was successfully deleted.
400
The request failed.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123', [
    '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("DELETE", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/revenue-centres/abc123", 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 centre was successfully deleted.

// empty response

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/organisations/{organisationId}/sales-channels

List Sales Channels

listSalesChannels

Returns a paginated list of every sales channel that belongs to the organisation, ordered by their stored display order then by name. Sales channels are used to label the source of a sale (e.g. "Front Desk", "Phone", "Website") so revenue can be broken down by channel on reports.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Query parameters

pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The sales channels were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels', {
  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/organisations/00000000-0000-0000-0000-000000000000/sales-channels",
    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/organisations/00000000-0000-0000-0000-000000000000/sales-channels', [
    '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/organisations/00000000-0000-0000-0000-000000000000/sales-channels", 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 sales channels were successfully retrieved.

{
  "data": [
    {
      "id": "6630f7a8e1a4c2b1d4d5e7c1",
      "name": "Front Desk",
      "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
    }
  ],
  "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"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/organisations/{organisationId}/sales-channels

Create a Sales Channel

createSalesChannel

Create a new sales channel against the given organisation. The channel becomes immediately available for tagging orders, appointments, and other revenue-bearing records across every site under the organisation.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Request body

namestringrequired
Display name of the sales channel, shown in pickers across the admin UI and on reports that break revenue down by channel.

Responses

201
The sales channel was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Front Desk"
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Front Desk"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Front Desk"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Front Desk'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Front Desk",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 sales channel was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "Front Desk",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/organisations/{organisationId}/sales-channels/{salesChannelId}

Get a Sales Channel

getSalesChannel

Returns the details of a single sales channel, including its display name and the organisation it belongs to.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
salesChannelIduuidrequired
The unique identifier of the sales channel. Sales channel IDs are stable once issued and can be referenced from orders, appointments, and other revenue-bearing records.

Responses

200
The sales channel was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels/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/organisations/00000000-0000-0000-0000-000000000000/sales-channels/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/organisations/00000000-0000-0000-0000-000000000000/sales-channels/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/organisations/00000000-0000-0000-0000-000000000000/sales-channels/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/organisations/00000000-0000-0000-0000-000000000000/sales-channels/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 sales channel was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "Front Desk",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

delete/shop/organisations/{organisationId}/sales-channels/{salesChannelId}

Delete a Sales Channel

deleteSalesChannel

Permanently delete the sales channel. Existing records that were previously tagged with the channel keep their historical association on reports, but the channel will no longer appear in pickers when creating new records.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
salesChannelIduuidrequired
The unique identifier of the sales channel. Sales channel IDs are stable once issued and can be referenced from orders, appointments, and other revenue-bearing records.

Responses

204
The sales channel was successfully deleted.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels/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/organisations/00000000-0000-0000-0000-000000000000/sales-channels/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  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.delete(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels/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('DELETE', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels/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("DELETE", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels/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 sales channel was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/organisations/{organisationId}/labels/{labelId}/copy

Duplicate a Label

copyOrganisationLabel

Creates a copy of an existing organisation Label with new fields applied from the request body. Useful for spinning up a second label for another set of sites without rebuilding it from scratch.

name and site_ids are required so the copy is distinct from the source. color is optional and defaults to the source's colour when omitted.

Requires the SETTINGS_MANAGE permission on the organisation.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
labelIduuidrequired
The unique identifier of the label. Label IDs are stable once issued and can be referenced from any record the label is attached to.

Request body

namestringrequired
Display name for the new copy. Plain text only (any HTML is rejected); maximum 40 characters.
colorstringoptionalnullable
Six-digit hex colour with a leading #. Defaults to the source's colour when omitted.
site_idsstring[]required
UUIDs of the sites the copy is visible at. Every ID must belong to the organisation in the path. Replaces (does not extend) the source's site list.

Responses

200
The label was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/copy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP Guests (West Sites)",
  "color": "#3366cc",
  "site_ids": [
    "00000000-0000-0000-0000-111111111111"
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/copy', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "VIP Guests (West Sites)",
    "color": "#3366cc",
    "site_ids": [
      "00000000-0000-0000-0000-111111111111"
    ]
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/copy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "VIP Guests (West Sites)",
        "color": "#3366cc",
        "site_ids": [
            "00000000-0000-0000-0000-111111111111"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/copy', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'VIP Guests (West Sites)',
            'color' => '#3366cc',
            'site_ids' => [
                '00000000-0000-0000-0000-111111111111'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "VIP Guests (West Sites)",
		"color": "#3366cc",
		"site_ids": []interface{}{
			"00000000-0000-0000-0000-111111111111",
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/copy", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 label was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "VIP",
    "color": "#ff5733",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9",
    "site_ids": [
      "65a0c2e5b3a7d2f8c1d4e7ba",
      "65a0c2e5b3a7d2f8c1d4e7bb"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

post/shop/organisations/{organisationId}/labels/{labelId}/restore

Restore a Label

restoreOrganisationLabel

Restores a previously soft-deleted organisation Label. The label reappears in pickers and filters and any records that were tagged with it before deletion immediately regain the tag in the UI.

Requires the SETTINGS_MANAGE permission on the organisation. No request body.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
labelIduuidrequired
The unique identifier of the label. Label IDs are stable once issued and can be referenced from any record the label is attached to.

Responses

200
The label was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/restore" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/restore', {
  method: 'POST',
  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.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/restore",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/restore', [
    '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("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000/restore", 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 label was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "VIP",
    "color": "#ff5733",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9",
    "site_ids": [
      "65a0c2e5b3a7d2f8c1d4e7ba",
      "65a0c2e5b3a7d2f8c1d4e7bb"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/organisations/{organisationId}/sales-channels-order

List Sales Channels in Display Order

listOrganisationSalesChannelsOrder

Returns every sales channel that belongs to the organisation, sorted by the organisation-wide display order (ascending). Use this endpoint when you need the channels in the order they should be rendered in a UI picker; use GET /shop/organisations/{organisationId}/sales-channels when you want a paginated list.

Requires the RESERVATIONS_VIEW permission on a site under the organisation.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Responses

200
The ordered sales channels.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order', {
  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/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order",
    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/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order', [
    '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/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order", 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 ordered sales channels.

{
  "data": [
    {
      "id": "6630f7a8e1a4c2b1d4d5e7c1",
      "name": "Front Desk",
      "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/organisations/{organisationId}/sales-channels-order

Update Sales Channels Order

updateSalesChannelsOrder

Updates the organisation-wide display order of sales channels by supplying the desired sequence of SalesChannel IDs. IDs not listed retain their previous order relative to one another and are appended to the tail.

Requires the SHARED_SETTINGS_MANAGE permission on any site under the organisation.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.

Request body

organisation_iduuidrequired
UUID of the organisation whose channels are being reordered. Must match the organisationId in the path.
sales_channel_idsstring[]required
The desired display sequence of SalesChannel IDs.

Responses

204
The sales channel order was updated successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "sales_channel_ids": [
    "5dcb47800000000000000001"
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "sales_channel_ids": [
      "5dcb47800000000000000001"
    ]
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "organisation_id": "00000000-0000-0000-0000-000000000000",
        "sales_channel_ids": [
            "5dcb47800000000000000001"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'organisation_id' => '00000000-0000-0000-0000-000000000000',
            'sales_channel_ids' => [
                '5dcb47800000000000000001'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"organisation_id": "00000000-0000-0000-0000-000000000000",
		"sales_channel_ids": []interface{}{
			"5dcb47800000000000000001",
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/sales-channels-order", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 sales channel order was updated successfully.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

post/shop/organisations/{organisationId}/category/{categoryId}/copy

Copy a Category (singular alias)

copyOrganisationCategoryLegacy

Legacy URL alias for POST /shop/organisations/{organisationId}/categories/{categoryId}/copy. Routes to the same handler — copies the category and overlays any properties supplied in the request body.

New integrations should use the plural route; this endpoint remains for backwards compatibility with API consumers that were built against the original singular URL.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
categoryIduuidrequired
The ID of the Category.

Request body

namestringoptional
Display name to give the duplicated category. 1-120 characters; must not contain HTML.
voucher_applicablebooleanoptional
Whether the new category can be selected when issuing vouchers.

Responses

201
The category was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/category/00000000-0000-0000-0000-000000000000/copy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Massages (Summer 2026)",
  "voucher_applicable": false
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/category/00000000-0000-0000-0000-000000000000/copy', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Massages (Summer 2026)",
    "voucher_applicable": false
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/category/00000000-0000-0000-0000-000000000000/copy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Massages (Summer 2026)",
        "voucher_applicable": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/category/00000000-0000-0000-0000-000000000000/copy', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Massages (Summer 2026)',
            'voucher_applicable' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Massages (Summer 2026)",
		"voucher_applicable": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/category/00000000-0000-0000-0000-000000000000/copy", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 category was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Alex Morgan",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "voucher_applicable": false
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

post/shop/organisations/{organisationId}/label/{labelId}/copy

Duplicate a Label (singular alias)

copyOrganisationLabelLegacy

Legacy URL alias for POST /shop/organisations/{organisationId}/labels/{labelId}/copy. Routes to the same handler — duplicates the label with new fields overlaid from the body.

New integrations should use the plural route; this endpoint remains for backwards compatibility with API consumers that were built against the original singular URL.

Path parameters

organisationIduuidrequired
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
labelIduuidrequired
The unique identifier of the label. Label IDs are stable once issued and can be referenced from any record the label is attached to.

Request body

namestringrequired
Display name for the new copy. Plain text only; maximum 40 characters.
colorstringoptionalnullable
Six-digit hex colour with a leading #. Defaults to the source's colour when omitted.
site_idsstring[]required
UUIDs of the sites the copy is visible at. Every ID must belong to the organisation in the path.

Responses

200
The label was successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/label/00000000-0000-0000-0000-000000000000/copy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP Guests (West Sites)",
  "color": "#3366cc",
  "site_ids": [
    "00000000-0000-0000-0000-111111111111"
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/label/00000000-0000-0000-0000-000000000000/copy', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "VIP Guests (West Sites)",
    "color": "#3366cc",
    "site_ids": [
      "00000000-0000-0000-0000-111111111111"
    ]
  }),
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/label/00000000-0000-0000-0000-000000000000/copy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "VIP Guests (West Sites)",
        "color": "#3366cc",
        "site_ids": [
            "00000000-0000-0000-0000-111111111111"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/label/00000000-0000-0000-0000-000000000000/copy', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'VIP Guests (West Sites)',
            'color' => '#3366cc',
            'site_ids' => [
                '00000000-0000-0000-0000-111111111111'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "VIP Guests (West Sites)",
		"color": "#3366cc",
		"site_ids": []interface{}{
			"00000000-0000-0000-0000-111111111111",
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/organisations/00000000-0000-0000-0000-000000000000/label/00000000-0000-0000-0000-000000000000/copy", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 label was successfully retrieved.

{
  "data": {
    "id": "6630f7a8e1a4c2b1d4d5e7c1",
    "name": "VIP",
    "color": "#ff5733",
    "organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9",
    "site_ids": [
      "65a0c2e5b3a7d2f8c1d4e7ba",
      "65a0c2e5b3a7d2f8c1d4e7bb"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}