Sites & Organisation

Sites

A Site represents a property using Trybe.

The Site object

Attributes

iduuidrequired
The ID of the site
billing_customer_idstringrequired
brand_iduuidrequired
The ID of the Brand the Site belongs to.
brand_namestringrequired
The name of the Brand the Site belongs to.
country_codestringrequirednullable
The country code of the site
created_atdate-timerequired
The date and time that the site was created
onboarding_completed_atdate-timerequirednullable
The date and time that the site's onboarding was completed
currencystringrequired
The currency of the site. See Supported Currencies for a list of supported currencies.
external_idstringrequirednullable
An external ID for the site This can be used to link the site to an external system.
frontend_subdomainstringrequired
The subdomain of the site's frontend
is_read_onlybooleanrequired
Are billing details read-only.
localestringrequired
The locale of the site. See Supported Locales for a list of supported locales.
namestringrequired
Display name of the site. Shown to customers in the storefront, in the admin UI, on receipts, and on communications. Trimmed; 1-120 characters, must not contain HTML.
organisation_iduuidrequired
The ID of the organisation that the site belongs to
organisation_namestringrequired
The name of the organisation that the site belongs to
timezonestringrequirednullable
The site's local timezone as an IANA zone identifier (e.g. Europe/London, America/New_York). All schedule, opening hours and reporting figures are interpreted in this zone, and the value is used to convert UTC timestamps in API responses into local times for display.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "billing_customer_id": "00000000-0000-0000-0000-000000000000",
  "brand_id": "00000000-0000-0000-0000-000000000000",
  "brand_name": "string",
  "country_code": "GB",
  "created_at": "2026-01-15T09:30:00+00:00",
  "onboarding_completed_at": "2026-01-15T09:30:00+00:00",
  "currency": "GBP",
  "external_id": "ext-site-london-bridge",
  "frontend_subdomain": "palmtreespa",
  "is_read_only": true,
  "locale": "en",
  "name": "Palm Tree Spa",
  "organisation_id": "00000000-0000-0000-0000-000000000000",
  "organisation_name": "Palm Tree Holdings Ltd.",
  "timezone": "Europe/London"
}

get/sites

Retrieve Sites

listSites

Use this endpoint to retrieve a paginated list of Sites.

Query parameters

pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page
site_idstringoptional
Filter results by the site they belong to
querystringoptional
Filter results by name or ID.
sort_bystringoptional
The field to sort the results by.
sort_by_directionstringoptional
The direction in which to sort to the response.
Possible values:ascdesc

Responses

200
Sites were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.

curl "https://api.playground.try.be/sites" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

Sites were successfully retrieved.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "billing_customer_id": "00000000-0000-0000-0000-000000000000",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "brand_name": "string",
      "country_code": "GB",
      "created_at": "2026-01-15T09:30:00+00:00",
      "onboarding_completed_at": "2026-01-15T09:30:00+00:00",
      "currency": "GBP",
      "external_id": "ext-site-london-bridge",
      "frontend_subdomain": "palmtreespa",
      "is_read_only": true,
      "locale": "en",
      "name": "Palm Tree Spa",
      "organisation_id": "00000000-0000-0000-0000-000000000000",
      "organisation_name": "Palm Tree Holdings Ltd.",
      "timezone": "Europe/London"
    }
  ],
  "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"
  },
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  }
}

{
  "message": "Unauthenticated"
}

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

get/sites/{siteId}

Get the details of a single Site

getSiteDetails

Returns the full details of a single Site — including its name, locale, timezone, currency, and the organisation and brand it belongs to. Use this when you need the canonical record for a site identifier you already hold; for browsing the full list use listSites.

Distinct from getSite, which is the admin-scoped read at /shop/admin/sites/{siteId}.

Path parameters

siteIduuidrequired
The ID of the site

Responses

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

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

const response = await fetch('https://api.playground.try.be/sites/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/sites/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/sites/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/sites/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 `Site` was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "billing_customer_id": "00000000-0000-0000-0000-000000000000",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "brand_name": "string",
    "country_code": "GB",
    "created_at": "2026-01-15T09:30:00+00:00",
    "onboarding_completed_at": "2026-01-15T09:30:00+00:00",
    "currency": "GBP",
    "external_id": "ext-site-london-bridge",
    "frontend_subdomain": "palmtreespa",
    "is_read_only": true,
    "locale": "en",
    "name": "Palm Tree Spa",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "organisation_name": "Palm Tree Holdings Ltd.",
    "timezone": "Europe/London"
  }
}

{
  "message": "Unauthenticated"
}

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

put/sites/{siteId}

Update a Site

updateSite

Use this endpoint to update an existing Site.

Path parameters

siteIduuidrequired
The ID of the site

Request body

namestringoptional
Display name of the site. Shown to customers in the storefront, in the admin UI, on receipts, and on communications. Trimmed; 1-120 characters, must not contain HTML.
localestringoptional
The locale of the site. See Supported Locales for a list of supported locales.
currencystringoptional
The currency of the site. See Supported Currencies for a list of supported currencies.
timezonestringoptionalnullable
The site's local timezone as an IANA zone identifier (e.g. Europe/London, America/New_York). All schedule, opening hours and reporting figures are interpreted in this zone, and the value is used to convert UTC timestamps in API responses into local times for display.
logo_media_iduuidoptionalnullable
The media ID of the Site's logo.

To obtain a Media ID, use the createMedia endpoint to upload your media.
external_idstringoptionalnullable
An external ID for the site This can be used to link the site to an external system.
country_codestringoptionalnullable
The country code of the site

Responses

200
The Site 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/sites/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Palm Tree Spa",
  "locale": "en",
  "currency": "GBP",
  "timezone": "Europe/London",
  "logo_media_id": "00000000-0000-0000-0000-000000000000",
  "external_id": "ext-site-london-bridge",
  "country_code": "GB"
}'

const response = await fetch('https://api.playground.try.be/sites/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Palm Tree Spa",
    "locale": "en",
    "currency": "GBP",
    "timezone": "Europe/London",
    "logo_media_id": "00000000-0000-0000-0000-000000000000",
    "external_id": "ext-site-london-bridge",
    "country_code": "GB"
  }),
})

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/sites/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Palm Tree Spa",
        "locale": "en",
        "currency": "GBP",
        "timezone": "Europe/London",
        "logo_media_id": "00000000-0000-0000-0000-000000000000",
        "external_id": "ext-site-london-bridge",
        "country_code": "GB"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/sites/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Palm Tree Spa',
            'locale' => 'en',
            'currency' => 'GBP',
            'timezone' => 'Europe/London',
            'logo_media_id' => '00000000-0000-0000-0000-000000000000',
            'external_id' => 'ext-site-london-bridge',
            'country_code' => 'GB'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Palm Tree Spa",
		"locale": "en",
		"currency": "GBP",
		"timezone": "Europe/London",
		"logo_media_id": "00000000-0000-0000-0000-000000000000",
		"external_id": "ext-site-london-bridge",
		"country_code": "GB",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/sites/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 Site was successfully updated

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "billing_customer_id": "00000000-0000-0000-0000-000000000000",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "brand_name": "string",
    "country_code": "GB",
    "created_at": "2026-01-15T09:30:00+00:00",
    "onboarding_completed_at": "2026-01-15T09:30:00+00:00",
    "currency": "GBP",
    "external_id": "ext-site-london-bridge",
    "frontend_subdomain": "palmtreespa",
    "is_read_only": true,
    "locale": "en",
    "name": "Palm Tree Spa",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "organisation_name": "Palm Tree Holdings Ltd.",
    "timezone": "Europe/London"
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

get/sites/{siteId}/logo

Show a Site's logo

getSiteLogo

Use this endpoint to retrieve a Site's logo.

If the Site hasn't provided a logo, data will be null.

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
The Site's logo was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/sites/00000000-0000-0000-0000-000000000000/logo', {
  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/sites/00000000-0000-0000-0000-000000000000/logo",
    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/sites/00000000-0000-0000-0000-000000000000/logo', [
    '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/sites/00000000-0000-0000-0000-000000000000/logo", 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 `Site`'s logo was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "file_name": "super-cool-photo.jpg",
    "mime_type": "image/jpeg",
    "original_url": "https://example.com/media/super-cool-photo.jpg",
    "size": 84256,
    "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
  }
}

{
  "message": "Unauthenticated"
}

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

get/shop/sites/{siteId}

Retrieve a ShopSite

getShopSite

Use this endpoint to retrieve a single ShopSite.

Path parameters

siteIduuidrequired
The ID of the site

Responses

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

curl "https://api.playground.try.be/shop/sites/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/sites/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/sites/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/sites/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/sites/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 `ShopSite` was successfully retrieved.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "appointment_enquiries_enabled": false,
    "basket_confirmed_email_message": "<p>We look forward to seeing you. If anything changes,\n<a href=\"mailto:hello@example.com\">get in touch</a>.</p>\n",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "category_ids": [
      "string"
    ],
    "country_code": "GB",
    "country_name": "GB",
    "currency": "GBP",
    "custom_payment_types": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "fiscalisation_type": "string",
        "kind": "string",
        "name": "Alex Morgan"
      }
    ],
    "customer_search_config": {
      "sources": [
        {
          "key": "string",
          "name": "Alex Morgan",
          "supported_fields": [
            "string"
          ]
        }
      ]
    },
    "email_from_address": "spa@example.com",
    "email_from_address_verified_at": "2026-01-15T09:30:00+00:00",
    "email_settings": {
      "collect_email_addresses": false,
      "follow_up_emails_enabled": false,
      "follow_up_emails_days_after": 1,
      "follow_up_emails_time": "15:00",
      "hide_manage_order": false,
      "qr_codes_enabled": false,
      "reminder_emails_enabled": false,
      "reminder_emails_days_ahead": 1,
      "reminder_emails_time": "15:00",
      "auto_send_order_summary_on_checkout": false,
      "visibility_settings": {
        "basket_confirmed": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        },
        "basket_reminder": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        },
        "order_summary": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        },
        "new_order": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        }
      }
    },
    "external_id": "00000000-0000-0000-0000-000000000000",
    "feature_flags": {},
    "features": {
      "support_wearable_payments": false
    },
    "has_booking_engine_integration": true,
    "has_fiscalisation_integration": true,
    "has_payments_integration": true,
    "has_pos_integration": true,
    "has_table_reservation_integration": true,
    "intake_form_questionnaire_id": "5f1234567890abcdef123456",
    "locale": "en",
    "name": "Palm Tree Spa",
    "opening_hours": [
      {
        "time_from": "string",
        "time_to": "string",
        "weekday": "string"
      }
    ],
    "payment_config": {
      "default_processor": "string",
      "should_show_stripe": false,
      "stripe": {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "account_type": "string"
      },
      "terminal_payments": {
        "enabled": false,
        "processor": "string"
      }
    },
    "pms_integration": {
      "async": false,
      "enabled": false,
      "charge_to_room_enabled": false,
      "type": "string"
    },
    "privacy_policy": "We process your personal data in accordance with GDPR. See our full\nprivacy notice at https://example.com/privacy.\n",
    "revenue_centres": [
      {}
    ],
    "scheduling_week_interval": 2,
    "scheduling_week_interval_start": "2026-01-05T00:00:00Z",
    "shop_config": {
      "features": [
        {}
      ],
      "require_member_guests": false,
      "separate_name_values_enforced": false
    },
    "stripe_config": {
      "account_id": "00000000-0000-0000-0000-000000000000",
      "account_type": "string"
    },
    "terms": "Bookings are subject to our cancellation policy. Full terms at\nhttps://example.com/terms.\n",
    "timezone": "Europe/London",
    "vouchers_integration": {
      "enabled": false,
      "name": "Alex Morgan",
      "type": "string"
    },
    "organisation": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Palm Tree Holdings Ltd."
    }
  }
}

{
  "message": "Unauthenticated"
}

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

put/shop/sites/{siteId}

Update a ShopSite

updateShopSite

Use this endpoint to update a ShopSite.

Path parameters

siteIduuidrequired
The ID of the site

Request body

basket_confirmed_email_messagestringoptionalnullable
A message which is appended to the end of every Basket Confirmed email for this site.

HTML is supported, however only the following tags are allowed: h1, strong, a, p, br.
category_idsstring[]optional
custom_payment_type_idsstring[]optional
An array of custom payment type IDs for the site
email_from_addressstringoptionalnullable
The email address used as the From header on all customer- facing email this site sends (confirmations, reminders, receipts). Must be verified with the email provider before delivery succeeds — check email_from_address_verified_at.
email_settingsobjectoptional
intake_form_questionnaire_idstringoptionalnullable
ID of the intake-form questionnaire applied to bookings at this site. Null means no questionnaire is attached and the intake step is skipped.
namestringoptional
Display name of the site, shown to customers in the storefront, on receipts, and in confirmation emails sent to guests. Trimmed; 1-120 characters and must not contain HTML.
opening_hoursobject[]optional
privacy_policystringoptionalnullable
Customer-facing privacy policy shown during checkout and on receipts. Markdown is rendered; null means inherit from the organisation.
scheduling_week_intervalintegeroptionalnullable
Number of weeks between repeating scheduling rotations. Used to roll fortnightly or multi-week rotas. 2 means alternating weeks; null means no rotation (every week is identical).
scheduling_week_interval_startdate-timeoptionalnullable
Anchor datetime used to compute which week of a multi-week rotation any given date falls into. Paired with scheduling_week_interval; null disables the rotation.
termsstringoptionalnullable
Customer-facing terms and conditions shown at checkout and linked in confirmation emails. Markdown is rendered; null means inherit from the organisation.

Responses

200
The ShopSite 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/sites/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "basket_confirmed_email_message": "<p>We look forward to seeing you. If anything changes,\n<a href=\"mailto:hello@example.com\">get in touch</a>.</p>\n",
  "category_ids": [
    "string"
  ],
  "custom_payment_type_ids": [
    "5f8d944e79c9f341846e807a"
  ],
  "email_from_address": "spa@example.com",
  "email_settings": {
    "collect_email_addresses": false,
    "follow_up_emails_enabled": false,
    "follow_up_emails_days_after": 1,
    "follow_up_emails_time": "15:00",
    "hide_manage_order": false,
    "qr_codes_enabled": false,
    "reminder_emails_enabled": false,
    "reminder_emails_days_ahead": 1,
    "reminder_emails_time": "15:00",
    "auto_send_order_summary_on_checkout": false,
    "visibility_settings": {
      "basket_confirmed": {
        "show_day_of_week": false,
        "show_end_times": false,
        "show_guest_names": false,
        "show_practitioner_names": false
      },
      "basket_reminder": {
        "show_day_of_week": false,
        "show_end_times": false,
        "show_guest_names": false,
        "show_practitioner_names": false
      },
      "order_summary": {
        "show_day_of_week": false,
        "show_end_times": false,
        "show_guest_names": false,
        "show_practitioner_names": false
      },
      "new_order": {
        "show_day_of_week": false,
        "show_end_times": false,
        "show_guest_names": false,
        "show_practitioner_names": false
      }
    }
  },
  "intake_form_questionnaire_id": "5f1234567890abcdef123456",
  "name": "Palm Tree Spa",
  "opening_hours": [
    {
      "time_from": "string",
      "time_to": "string",
      "weekday": "string"
    }
  ],
  "privacy_policy": "We process your personal data in accordance with GDPR. See our full\nprivacy notice at https://example.com/privacy.\n",
  "scheduling_week_interval": 2,
  "scheduling_week_interval_start": "2026-01-05T00:00:00Z",
  "terms": "Bookings are subject to our cancellation policy. Full terms at\nhttps://example.com/terms.\n"
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "basket_confirmed_email_message": "<p>We look forward to seeing you. If anything changes,\n<a href=\"mailto:hello@example.com\">get in touch</a>.</p>\n",
    "category_ids": [
      "string"
    ],
    "custom_payment_type_ids": [
      "5f8d944e79c9f341846e807a"
    ],
    "email_from_address": "spa@example.com",
    "email_settings": {
      "collect_email_addresses": false,
      "follow_up_emails_enabled": false,
      "follow_up_emails_days_after": 1,
      "follow_up_emails_time": "15:00",
      "hide_manage_order": false,
      "qr_codes_enabled": false,
      "reminder_emails_enabled": false,
      "reminder_emails_days_ahead": 1,
      "reminder_emails_time": "15:00",
      "auto_send_order_summary_on_checkout": false,
      "visibility_settings": {
        "basket_confirmed": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        },
        "basket_reminder": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        },
        "order_summary": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        },
        "new_order": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        }
      }
    },
    "intake_form_questionnaire_id": "5f1234567890abcdef123456",
    "name": "Palm Tree Spa",
    "opening_hours": [
      {
        "time_from": "string",
        "time_to": "string",
        "weekday": "string"
      }
    ],
    "privacy_policy": "We process your personal data in accordance with GDPR. See our full\nprivacy notice at https://example.com/privacy.\n",
    "scheduling_week_interval": 2,
    "scheduling_week_interval_start": "2026-01-05T00:00:00Z",
    "terms": "Bookings are subject to our cancellation policy. Full terms at\nhttps://example.com/terms.\n"
  }),
})

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/sites/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "basket_confirmed_email_message": "<p>We look forward to seeing you. If anything changes,\n<a href=\"mailto:hello@example.com\">get in touch</a>.</p>\n",
        "category_ids": [
            "string"
        ],
        "custom_payment_type_ids": [
            "5f8d944e79c9f341846e807a"
        ],
        "email_from_address": "spa@example.com",
        "email_settings": {
            "collect_email_addresses": False,
            "follow_up_emails_enabled": False,
            "follow_up_emails_days_after": 1,
            "follow_up_emails_time": "15:00",
            "hide_manage_order": False,
            "qr_codes_enabled": False,
            "reminder_emails_enabled": False,
            "reminder_emails_days_ahead": 1,
            "reminder_emails_time": "15:00",
            "auto_send_order_summary_on_checkout": False,
            "visibility_settings": {
                "basket_confirmed": {
                    "show_day_of_week": False,
                    "show_end_times": False,
                    "show_guest_names": False,
                    "show_practitioner_names": False
                },
                "basket_reminder": {
                    "show_day_of_week": False,
                    "show_end_times": False,
                    "show_guest_names": False,
                    "show_practitioner_names": False
                },
                "order_summary": {
                    "show_day_of_week": False,
                    "show_end_times": False,
                    "show_guest_names": False,
                    "show_practitioner_names": False
                },
                "new_order": {
                    "show_day_of_week": False,
                    "show_end_times": False,
                    "show_guest_names": False,
                    "show_practitioner_names": False
                }
            }
        },
        "intake_form_questionnaire_id": "5f1234567890abcdef123456",
        "name": "Palm Tree Spa",
        "opening_hours": [
            {
                "time_from": "string",
                "time_to": "string",
                "weekday": "string"
            }
        ],
        "privacy_policy": "We process your personal data in accordance with GDPR. See our full\nprivacy notice at https://example.com/privacy.\n",
        "scheduling_week_interval": 2,
        "scheduling_week_interval_start": "2026-01-05T00:00:00Z",
        "terms": "Bookings are subject to our cancellation policy. Full terms at\nhttps://example.com/terms.\n"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'basket_confirmed_email_message' => '<p>We look forward to seeing you. If anything changes,
<a href="mailto:hello@example.com">get in touch</a>.</p>
',
            'category_ids' => [
                'string'
            ],
            'custom_payment_type_ids' => [
                '5f8d944e79c9f341846e807a'
            ],
            'email_from_address' => 'spa@example.com',
            'email_settings' => [
                'collect_email_addresses' => false,
                'follow_up_emails_enabled' => false,
                'follow_up_emails_days_after' => 1,
                'follow_up_emails_time' => '15:00',
                'hide_manage_order' => false,
                'qr_codes_enabled' => false,
                'reminder_emails_enabled' => false,
                'reminder_emails_days_ahead' => 1,
                'reminder_emails_time' => '15:00',
                'auto_send_order_summary_on_checkout' => false,
                'visibility_settings' => [
                    'basket_confirmed' => [
                        'show_day_of_week' => false,
                        'show_end_times' => false,
                        'show_guest_names' => false,
                        'show_practitioner_names' => false
                    ],
                    'basket_reminder' => [
                        'show_day_of_week' => false,
                        'show_end_times' => false,
                        'show_guest_names' => false,
                        'show_practitioner_names' => false
                    ],
                    'order_summary' => [
                        'show_day_of_week' => false,
                        'show_end_times' => false,
                        'show_guest_names' => false,
                        'show_practitioner_names' => false
                    ],
                    'new_order' => [
                        'show_day_of_week' => false,
                        'show_end_times' => false,
                        'show_guest_names' => false,
                        'show_practitioner_names' => false
                    ]
                ]
            ],
            'intake_form_questionnaire_id' => '5f1234567890abcdef123456',
            'name' => 'Palm Tree Spa',
            'opening_hours' => [
                [
                    'time_from' => 'string',
                    'time_to' => 'string',
                    'weekday' => 'string'
                ]
            ],
            'privacy_policy' => 'We process your personal data in accordance with GDPR. See our full
privacy notice at https://example.com/privacy.
',
            'scheduling_week_interval' => 2,
            'scheduling_week_interval_start' => '2026-01-05T00:00:00Z',
            'terms' => 'Bookings are subject to our cancellation policy. Full terms at
https://example.com/terms.
'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"basket_confirmed_email_message": "<p>We look forward to seeing you. If anything changes,\n<a href=\"mailto:hello@example.com\">get in touch</a>.</p>\n",
		"category_ids": []interface{}{
			"string",
		},
		"custom_payment_type_ids": []interface{}{
			"5f8d944e79c9f341846e807a",
		},
		"email_from_address": "spa@example.com",
		"email_settings": map[string]interface{}{
			"collect_email_addresses": false,
			"follow_up_emails_enabled": false,
			"follow_up_emails_days_after": 1,
			"follow_up_emails_time": "15:00",
			"hide_manage_order": false,
			"qr_codes_enabled": false,
			"reminder_emails_enabled": false,
			"reminder_emails_days_ahead": 1,
			"reminder_emails_time": "15:00",
			"auto_send_order_summary_on_checkout": false,
			"visibility_settings": map[string]interface{}{
				"basket_confirmed": map[string]interface{}{
					"show_day_of_week": false,
					"show_end_times": false,
					"show_guest_names": false,
					"show_practitioner_names": false,
				},
				"basket_reminder": map[string]interface{}{
					"show_day_of_week": false,
					"show_end_times": false,
					"show_guest_names": false,
					"show_practitioner_names": false,
				},
				"order_summary": map[string]interface{}{
					"show_day_of_week": false,
					"show_end_times": false,
					"show_guest_names": false,
					"show_practitioner_names": false,
				},
				"new_order": map[string]interface{}{
					"show_day_of_week": false,
					"show_end_times": false,
					"show_guest_names": false,
					"show_practitioner_names": false,
				},
			},
		},
		"intake_form_questionnaire_id": "5f1234567890abcdef123456",
		"name": "Palm Tree Spa",
		"opening_hours": []interface{}{
			map[string]interface{}{
				"time_from": "string",
				"time_to": "string",
				"weekday": "string",
			},
		},
		"privacy_policy": "We process your personal data in accordance with GDPR. See our full\nprivacy notice at https://example.com/privacy.\n",
		"scheduling_week_interval": 2,
		"scheduling_week_interval_start": "2026-01-05T00:00:00Z",
		"terms": "Bookings are subject to our cancellation policy. Full terms at\nhttps://example.com/terms.\n",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/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 `ShopSite` was successfully updated.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "appointment_enquiries_enabled": false,
    "basket_confirmed_email_message": "<p>We look forward to seeing you. If anything changes,\n<a href=\"mailto:hello@example.com\">get in touch</a>.</p>\n",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "category_ids": [
      "string"
    ],
    "country_code": "GB",
    "country_name": "GB",
    "currency": "GBP",
    "custom_payment_types": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "fiscalisation_type": "string",
        "kind": "string",
        "name": "Alex Morgan"
      }
    ],
    "customer_search_config": {
      "sources": [
        {
          "key": "string",
          "name": "Alex Morgan",
          "supported_fields": [
            "string"
          ]
        }
      ]
    },
    "email_from_address": "spa@example.com",
    "email_from_address_verified_at": "2026-01-15T09:30:00+00:00",
    "email_settings": {
      "collect_email_addresses": false,
      "follow_up_emails_enabled": false,
      "follow_up_emails_days_after": 1,
      "follow_up_emails_time": "15:00",
      "hide_manage_order": false,
      "qr_codes_enabled": false,
      "reminder_emails_enabled": false,
      "reminder_emails_days_ahead": 1,
      "reminder_emails_time": "15:00",
      "auto_send_order_summary_on_checkout": false,
      "visibility_settings": {
        "basket_confirmed": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        },
        "basket_reminder": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        },
        "order_summary": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        },
        "new_order": {
          "show_day_of_week": false,
          "show_end_times": false,
          "show_guest_names": false,
          "show_practitioner_names": false
        }
      }
    },
    "external_id": "00000000-0000-0000-0000-000000000000",
    "feature_flags": {},
    "features": {
      "support_wearable_payments": false
    },
    "has_booking_engine_integration": true,
    "has_fiscalisation_integration": true,
    "has_payments_integration": true,
    "has_pos_integration": true,
    "has_table_reservation_integration": true,
    "intake_form_questionnaire_id": "5f1234567890abcdef123456",
    "locale": "en",
    "name": "Palm Tree Spa",
    "opening_hours": [
      {
        "time_from": "string",
        "time_to": "string",
        "weekday": "string"
      }
    ],
    "payment_config": {
      "default_processor": "string",
      "should_show_stripe": false,
      "stripe": {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "account_type": "string"
      },
      "terminal_payments": {
        "enabled": false,
        "processor": "string"
      }
    },
    "pms_integration": {
      "async": false,
      "enabled": false,
      "charge_to_room_enabled": false,
      "type": "string"
    },
    "privacy_policy": "We process your personal data in accordance with GDPR. See our full\nprivacy notice at https://example.com/privacy.\n",
    "revenue_centres": [
      {}
    ],
    "scheduling_week_interval": 2,
    "scheduling_week_interval_start": "2026-01-05T00:00:00Z",
    "shop_config": {
      "features": [
        {}
      ],
      "require_member_guests": false,
      "separate_name_values_enforced": false
    },
    "stripe_config": {
      "account_id": "00000000-0000-0000-0000-000000000000",
      "account_type": "string"
    },
    "terms": "Bookings are subject to our cancellation policy. Full terms at\nhttps://example.com/terms.\n",
    "timezone": "Europe/London",
    "vouchers_integration": {
      "enabled": false,
      "name": "Alex Morgan",
      "type": "string"
    },
    "organisation": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Palm Tree Holdings Ltd."
    }
  }
}

{
  "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/sites/{siteId}/appointment-enquiry-settings

Retrieve a site's appointment enquiry settings

getAppointmentEnquirySettings

Use this endpoint to retrieve the appointment enquiry settings for a site

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
A response containing a site's appointment enquiry settings.
401
The user is unauthenticated
404
The resource couldn't be found

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

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

A response containing a site's appointment enquiry settings.

{
  "data": {
    "enabled": false,
    "min_advance_bookings_interval": "P2D",
    "automatically_confirm": false,
    "automatically_charge": false
  }
}

{
  "message": "Unauthenticated"
}

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

put/shop/sites/{siteId}/appointment-enquiry-settings

Update a site's appointment enquiry settings

updateAppointmentEnquirySettings

Use this endpoint to update the appointment enquiry settings for a site

Path parameters

siteIduuidrequired
The ID of the site

Request body

enabledbooleanoptional
Whether appointment enquiries are enabled for this site.
min_advance_bookings_intervalstringoptionalnullable
The minimum time before an appointment's start time that an enquiry may be made, as an ISO8601 string. See https://en.wikipedia.org/wiki/ISO_8601#Durations
automatically_confirmbooleanoptional
Whether enquiries should automatically be confirmed when there is availability.
automatically_chargebooleanoptional
Whether enquiries should automatically be charged when being confirmed.

Responses

200
A response containing a site's appointment enquiry settings.
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/sites/00000000-0000-0000-0000-000000000000/appointment-enquiry-settings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": false,
  "min_advance_bookings_interval": "P2D",
  "automatically_confirm": false,
  "automatically_charge": false
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/appointment-enquiry-settings', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "enabled": false,
    "min_advance_bookings_interval": "P2D",
    "automatically_confirm": false,
    "automatically_charge": 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/sites/00000000-0000-0000-0000-000000000000/appointment-enquiry-settings",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "enabled": False,
        "min_advance_bookings_interval": "P2D",
        "automatically_confirm": False,
        "automatically_charge": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/appointment-enquiry-settings', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'enabled' => false,
            'min_advance_bookings_interval' => 'P2D',
            'automatically_confirm' => false,
            'automatically_charge' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"enabled": false,
		"min_advance_bookings_interval": "P2D",
		"automatically_confirm": false,
		"automatically_charge": false,
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/appointment-enquiry-settings", 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)
}

A response containing a site's appointment enquiry settings.

{
  "data": {
    "enabled": false,
    "min_advance_bookings_interval": "P2D",
    "automatically_confirm": false,
    "automatically_charge": 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/sites/{siteId}/opening-hours-overrides

Retrieve a ShopSites' opening hours overrides

listShopSiteOpeningHoursOverrides

Use this endpoint to retrieve the overrides for a ShopSites' opening hours.

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
The ShopSites' opening hours overrides 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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides', {
  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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides",
    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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides', [
    '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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides", 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 `ShopSite`s' opening hours overrides were successfully retrieved.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "date_from": "2021-02-15T12:00:00+00:00",
      "date_to": "2021-02-15T12:00:00+00:00",
      "is_available": true,
      "max_duration": 1,
      "min_duration": 1,
      "time_from": "11:00",
      "time_to": "17:00",
      "weekdays": [
        "string"
      ]
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

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

post/shop/sites/{siteId}/opening-hours-overrides

Create an opening hours override for a ShopSite

createShopSiteOpeningHoursOverride

Use this endpoint to create an exception for the ShopSites' standard opening hours.

Path parameters

siteIduuidrequired
The ID of the site

Request body

date_fromdaterequired
The start of the rule period.
date_todaterequired
The end of the rule period.
is_availablebooleanoptional
Whether the resource is available during this period. Any false rules will override true rules.
time_fromstringoptional
The daily start time of the time period, in 24 hour format.
time_tostringoptional
The daily end time of the time period, in 24 hour format.

Responses

201
An opening hours override 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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "date_from": "2021-02-15T12:00:00+00:00",
  "date_to": "2021-02-15T12:00:00+00:00",
  "is_available": true,
  "time_from": "11:00",
  "time_to": "17:00"
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "time_from": "11:00",
    "time_to": "17:00"
  }),
})

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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "date_from": "2021-02-15T12:00:00+00:00",
        "date_to": "2021-02-15T12:00:00+00:00",
        "is_available": True,
        "time_from": "11:00",
        "time_to": "17:00"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'date_from' => '2021-02-15T12:00:00+00:00',
            'date_to' => '2021-02-15T12:00:00+00:00',
            'is_available' => true,
            'time_from' => '11:00',
            'time_to' => '17:00'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"date_from": "2021-02-15T12:00:00+00:00",
		"date_to": "2021-02-15T12:00:00+00:00",
		"is_available": true,
		"time_from": "11:00",
		"time_to": "17:00",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides", 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)
}

An opening hours override was successfully created.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "max_duration": 1,
    "min_duration": 1,
    "time_from": "11:00",
    "time_to": "17:00",
    "weekdays": [
      "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/sites/{siteId}/opening-hours-overrides/{openingHoursOverrideId}

Retrieve a ShopSite opening hours override

getShopSiteOpeningHoursOverride

Use this endpoint to retrieve an override for a ShopSites' opening hours.

Path parameters

siteIduuidrequired
The ID of the site
openingHoursOverrideIdobject-idrequired
The ID of the opening hour override.

Responses

200
The opening hour override 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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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 opening hour override was successfully retrieved.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "max_duration": 1,
    "min_duration": 1,
    "time_from": "11:00",
    "time_to": "17:00",
    "weekdays": [
      "string"
    ]
  }
}

{
  "message": "Unauthenticated"
}

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

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

put/shop/sites/{siteId}/opening-hours-overrides/{openingHoursOverrideId}

Update a ShopSites' opening hour override

updateOpeningHoursOverride

Update an existing override for a ShopSites' opening hours. Use this endpoint when you need to amend a previously created exception — for example, extending a holiday closure by a day, or adjusting the time window during which the site is open. All fields in the request body are optional, but date_from and date_to together must form a valid range, and if time_to is provided it must fall after time_from.

Path parameters

siteIduuidrequired
The ID of the site
openingHoursOverrideIdobject-idrequired
The ID of the opening hour override.

Request body

date_fromdateoptional
The start of the rule period.
date_todateoptional
The end of the rule period.
is_availablebooleanoptional
Whether the resource is available during this period. Any false rules will override true rules.
time_fromstringoptional
The daily start time of the time period, in 24 hour format.
time_tostringoptional
The daily end time of the time period, in 24 hour format.

Responses

200
The opening hour override 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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "date_from": "2021-02-15T12:00:00+00:00",
  "date_to": "2021-02-15T12:00:00+00:00",
  "is_available": true,
  "time_from": "11:00",
  "time_to": "17:00"
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "time_from": "11:00",
    "time_to": "17:00"
  }),
})

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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "date_from": "2021-02-15T12:00:00+00:00",
        "date_to": "2021-02-15T12:00:00+00:00",
        "is_available": True,
        "time_from": "11:00",
        "time_to": "17:00"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'date_from' => '2021-02-15T12:00:00+00:00',
            'date_to' => '2021-02-15T12:00:00+00:00',
            'is_available' => true,
            'time_from' => '11:00',
            'time_to' => '17:00'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"date_from": "2021-02-15T12:00:00+00:00",
		"date_to": "2021-02-15T12:00:00+00:00",
		"is_available": true,
		"time_from": "11:00",
		"time_to": "17:00",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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 opening hour override was successfully updated.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "max_duration": 1,
    "min_duration": 1,
    "time_from": "11:00",
    "time_to": "17:00",
    "weekdays": [
      "string"
    ]
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

patch/shop/sites/{siteId}/opening-hours-overrides/{openingHoursOverrideId}

Update a ShopSites' opening hour override

updateShopSiteOpeningHoursOverride

Use this endpoint to update an override for a ShopSites' opening hours.

Path parameters

siteIduuidrequired
The ID of the site
openingHoursOverrideIdobject-idrequired
The ID of the opening hour override.

Request body

date_fromdateoptional
The start of the rule period.
date_todateoptional
The end of the rule period.
is_availablebooleanoptional
Whether the resource is available during this period. Any false rules will override true rules.
time_fromstringoptional
The daily start time of the time period, in 24 hour format.
time_tostringoptional
The daily end time of the time period, in 24 hour format.

Responses

200
The opening hour override 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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "date_from": "2021-02-15T12:00:00+00:00",
  "date_to": "2021-02-15T12:00:00+00:00",
  "is_available": true,
  "time_from": "11:00",
  "time_to": "17:00"
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "time_from": "11:00",
    "time_to": "17:00"
  }),
})

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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "date_from": "2021-02-15T12:00:00+00:00",
        "date_to": "2021-02-15T12:00:00+00:00",
        "is_available": True,
        "time_from": "11:00",
        "time_to": "17:00"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'date_from' => '2021-02-15T12:00:00+00:00',
            'date_to' => '2021-02-15T12:00:00+00:00',
            'is_available' => true,
            'time_from' => '11:00',
            'time_to' => '17:00'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"date_from": "2021-02-15T12:00:00+00:00",
		"date_to": "2021-02-15T12:00:00+00:00",
		"is_available": true,
		"time_from": "11:00",
		"time_to": "17:00",
	})
	req, _ := http.NewRequest("PATCH", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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 opening hour override was successfully updated.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "max_duration": 1,
    "min_duration": 1,
    "time_from": "11:00",
    "time_to": "17:00",
    "weekdays": [
      "string"
    ]
  }
}

{
  "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/sites/{siteId}/opening-hours-overrides/{openingHoursOverrideId}

Delete a ShopSites' opening hours override

deleteShopSiteOpeningHoursOverride

Use this endpoint to delete an override for a ShopSites' opening hours.

Path parameters

siteIduuidrequired
The ID of the site
openingHoursOverrideIdobject-idrequired
The ID of the opening hour override.

Responses

204
The opening hours override 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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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/sites/00000000-0000-0000-0000-000000000000/opening-hours-overrides/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 opening hours override was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

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

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

get/shop/sites/{siteId}/service-charge-settings

Retrieve a site's service charge settings

getServiceChargeSettings

Use this endpoint to retrieve the service charge settings for a site

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
A response containing a site's service charge settings.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/service-charge-settings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

A response containing a site's service charge settings.

{
  "data": {
    "default_percentage": 10,
    "exit_gratuity_percentages": [
      0
    ],
    "exit_gratuity_offering_defaults": [
      {
        "no_tip_exit_behaviour": "allow_exit",
        "tip_wording": "Add a gratuity for your therapist",
        "percentages": [
          0
        ],
        "offerings": [
          {
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ]
      }
    ],
    "tip_on_terminal_enabled": false,
    "tip_on_exit_gate": "ask_lead_booker",
    "offering_defaults": [
      {
        "percentage": 12.5,
        "offerings": [
          {
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ]
      }
    ],
    "no_tip_exit_behaviour": "allow_exit",
    "tip_wording": "Add a gratuity for your therapist"
  }
}

{
  "message": "Unauthenticated"
}

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

put/shop/sites/{siteId}/service-charge-settings

Update a site's service charge settings

updateServiceChargeSettings

Use this endpoint to update the service charge settings for a site

Path parameters

siteIduuidrequired
The ID of the site

Request body

default_percentagenumberoptional
The percentage service charge to be applied, to the nearest half percent
exit_gratuity_percentagesnumber[]optional
The percentage options to be presented to customers when exiting through a gate
exit_gratuity_offering_defaultsobject[]optional
tip_on_terminal_enabledbooleanoptional
Whether to support adding a tip from card reader payments.
tip_on_exit_gatestringoptionalnullable
Whether to support adding a tip when a customer exits through a gate.
Possible values:ask_lead_bookerask_each_guest
no_tip_exit_behaviourstringoptionalnullable
The behavior to apply when a customer exits through a gate and does not select a tip option for these offerings.
Possible values:allow_exitdisallow_exit
tip_wordingstringoptionalnullable
Custom wording to use for the tip option when a customer exits through a gate for these offerings. If not provided, a default wording will be used.
offering_defaultsobject[]optional

Responses

200
A response containing a site's service charge settings.
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/sites/00000000-0000-0000-0000-000000000000/service-charge-settings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "default_percentage": 10,
  "exit_gratuity_percentages": [
    0
  ],
  "exit_gratuity_offering_defaults": [
    {
      "no_tip_exit_behaviour": "allow_exit",
      "tip_wording": "Add a gratuity for your therapist",
      "percentages": [
        0
      ],
      "offerings": [
        {
          "offering_type": "appointment",
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8"
        }
      ]
    }
  ],
  "tip_on_terminal_enabled": false,
  "tip_on_exit_gate": "ask_lead_booker",
  "no_tip_exit_behaviour": "allow_exit",
  "tip_wording": "Add a gratuity for your therapist",
  "offering_defaults": [
    {
      "percentage": 12.5,
      "offerings": [
        {
          "offering_type": "appointment",
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8"
        }
      ]
    }
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/service-charge-settings', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "default_percentage": 10,
    "exit_gratuity_percentages": [
      0
    ],
    "exit_gratuity_offering_defaults": [
      {
        "no_tip_exit_behaviour": "allow_exit",
        "tip_wording": "Add a gratuity for your therapist",
        "percentages": [
          0
        ],
        "offerings": [
          {
            "offering_type": "appointment",
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8"
          }
        ]
      }
    ],
    "tip_on_terminal_enabled": false,
    "tip_on_exit_gate": "ask_lead_booker",
    "no_tip_exit_behaviour": "allow_exit",
    "tip_wording": "Add a gratuity for your therapist",
    "offering_defaults": [
      {
        "percentage": 12.5,
        "offerings": [
          {
            "offering_type": "appointment",
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8"
          }
        ]
      }
    ]
  }),
})

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/sites/00000000-0000-0000-0000-000000000000/service-charge-settings",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "default_percentage": 10,
        "exit_gratuity_percentages": [
            0
        ],
        "exit_gratuity_offering_defaults": [
            {
                "no_tip_exit_behaviour": "allow_exit",
                "tip_wording": "Add a gratuity for your therapist",
                "percentages": [
                    0
                ],
                "offerings": [
                    {
                        "offering_type": "appointment",
                        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8"
                    }
                ]
            }
        ],
        "tip_on_terminal_enabled": False,
        "tip_on_exit_gate": "ask_lead_booker",
        "no_tip_exit_behaviour": "allow_exit",
        "tip_wording": "Add a gratuity for your therapist",
        "offering_defaults": [
            {
                "percentage": 12.5,
                "offerings": [
                    {
                        "offering_type": "appointment",
                        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8"
                    }
                ]
            }
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/service-charge-settings', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'default_percentage' => 10,
            'exit_gratuity_percentages' => [
                0
            ],
            'exit_gratuity_offering_defaults' => [
                [
                    'no_tip_exit_behaviour' => 'allow_exit',
                    'tip_wording' => 'Add a gratuity for your therapist',
                    'percentages' => [
                        0
                    ],
                    'offerings' => [
                        [
                            'offering_type' => 'appointment',
                            'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8'
                        ]
                    ]
                ]
            ],
            'tip_on_terminal_enabled' => false,
            'tip_on_exit_gate' => 'ask_lead_booker',
            'no_tip_exit_behaviour' => 'allow_exit',
            'tip_wording' => 'Add a gratuity for your therapist',
            'offering_defaults' => [
                [
                    'percentage' => 12.5,
                    'offerings' => [
                        [
                            'offering_type' => 'appointment',
                            'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8'
                        ]
                    ]
                ]
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"default_percentage": 10,
		"exit_gratuity_percentages": []interface{}{
			0,
		},
		"exit_gratuity_offering_defaults": []interface{}{
			map[string]interface{}{
				"no_tip_exit_behaviour": "allow_exit",
				"tip_wording": "Add a gratuity for your therapist",
				"percentages": []interface{}{
					0,
				},
				"offerings": []interface{}{
					map[string]interface{}{
						"offering_type": "appointment",
						"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
					},
				},
			},
		},
		"tip_on_terminal_enabled": false,
		"tip_on_exit_gate": "ask_lead_booker",
		"no_tip_exit_behaviour": "allow_exit",
		"tip_wording": "Add a gratuity for your therapist",
		"offering_defaults": []interface{}{
			map[string]interface{}{
				"percentage": 12.5,
				"offerings": []interface{}{
					map[string]interface{}{
						"offering_type": "appointment",
						"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
					},
				},
			},
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/service-charge-settings", 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)
}

A response containing a site's service charge settings.

{
  "data": {
    "default_percentage": 10,
    "exit_gratuity_percentages": [
      0
    ],
    "exit_gratuity_offering_defaults": [
      {
        "no_tip_exit_behaviour": "allow_exit",
        "tip_wording": "Add a gratuity for your therapist",
        "percentages": [
          0
        ],
        "offerings": [
          {
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ]
      }
    ],
    "tip_on_terminal_enabled": false,
    "tip_on_exit_gate": "ask_lead_booker",
    "offering_defaults": [
      {
        "percentage": 12.5,
        "offerings": [
          {
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ]
      }
    ],
    "no_tip_exit_behaviour": "allow_exit",
    "tip_wording": "Add a gratuity for your therapist"
  }
}

{
  "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/sites/{siteId}/auto-checkout-settings

Retrieve a site's auto checkout settings

getAutoCheckoutSettings

Use this endpoint to retrieve auto checkout settings for a site

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
A response containing a site's auto checkout settings.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/auto-checkout-settings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

A response containing a site's auto checkout settings.

{
  "data": {
    "checkout_sessions_enabled": false
  }
}

{
  "message": "Unauthenticated"
}

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

put/shop/sites/{siteId}/auto-checkout-settings

Update a site's auto checkout settings

updateAutoCheckoutSettings

Use this endpoint to update the auto checkout settings for a site

Path parameters

siteIduuidrequired
The ID of the site

Request body

checkout_sessions_enabledbooleanoptional
Whether to support automation of checking out all sessions from the previous day.

Responses

200
A response containing a site's auto checkout settings.
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/sites/00000000-0000-0000-0000-000000000000/auto-checkout-settings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "checkout_sessions_enabled": false
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/auto-checkout-settings', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "checkout_sessions_enabled": 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/sites/00000000-0000-0000-0000-000000000000/auto-checkout-settings",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "checkout_sessions_enabled": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/auto-checkout-settings', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'checkout_sessions_enabled' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"checkout_sessions_enabled": false,
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/auto-checkout-settings", 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)
}

A response containing a site's auto checkout settings.

{
  "data": {
    "checkout_sessions_enabled": 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/sites/{siteId}/sms-settings

Show SMS Notification Settings

getSmsNotificationSettings

This endpoint retrieves the SMS Notification Settings for the given site.

Path parameters

siteIduuidrequired
Identifier of the site whose SMS settings are being read or updated. SMS settings (sender names, default templates, Twilio bindings) are scoped per site so each location can configure its own customer-comms behaviour.

Responses

200
The SMS Notification Settings were successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

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

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

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "confirmation_sms_enabled": false,
    "automated_confirmation_sms_enabled": false,
    "cancellation_sms_enabled": false,
    "pay_by_link_sms_enabled": false,
    "billing_details_request_sms_enabled": false,
    "waitlist_confirmation_sms_enabled": false,
    "reminder_sms_enabled": false,
    "automated_reminder_sms_enabled": false,
    "reminder_sms_time": "09:30:00",
    "reminder_sms_days_ahead": 3,
    "follow_up_sms_enabled": false,
    "automated_follow_up_sms_enabled": false,
    "follow_up_sms_time": "09:30:00",
    "follow_up_sms_days_after": 3,
    "sid": "SENDERSPA",
    "provider": "twilio",
    "from_number": 1234567890
  }
}

{
  "message": "Unauthenticated"
}

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

put/shop/sites/{siteId}/sms-settings

Update SMS Notification Settings

updateSmsNotificationSettings

This endpoint updates the SMS Notification Settings for the given site.

Path parameters

siteIduuidrequired
Identifier of the site whose SMS settings are being read or updated. SMS settings (sender names, default templates, Twilio bindings) are scoped per site so each location can configure its own customer-comms behaviour.

Request body

confirmation_sms_enabledbooleanoptional
Whether the order confirmation SMS is enabled.
automated_confirmation_sms_enabledbooleanoptional
Whether the order confirmation SMS has automation turned off or not.
cancellation_sms_enabledbooleanoptional
Whether the order cancellation SMS is enabled.
pay_by_link_sms_enabledbooleanoptional
Whether the pay by link request SMS is enabled.
billing_details_request_sms_enabledbooleanoptional
Whether the billing details request SMS for memberships is enabled.
waitlist_confirmation_sms_enabledbooleanoptional
Whether the waitlist update SMS is enabled.
reminder_sms_enabledbooleanoptional
Whether the reminder SMS is enabled.
automated_reminder_sms_enabledbooleanoptional
Whether the order reminder SMS has automation turned off or not.
reminder_sms_timetimeoptional
The time of day the reminder SMS will be sent for automated messages.
reminder_sms_days_aheadintegeroptional
The number of days ahead of the booking the reminder SMS will be sent for automated messages.
follow_up_sms_enabledbooleanoptional
Whether the follow up SMS is enabled.
automated_follow_up_sms_enabledbooleanoptional
Whether the order follow up SMS has automation turned off or not.
follow_up_sms_timetimeoptional
The time of day the follow up SMS will be sent for automated messages.
follow_up_sms_days_afterintegeroptional
The number of days after the booking the follow up SMS will be sent for automated messages.
sidstringoptional
The sender identifier registered with the SMS gateway. For Twilio this is the alphanumeric sender ID or Messaging Service SID; recipients see it as the "from" name on the text. Country restrictions on alphanumeric sender IDs apply.
providerstringoptional
Which SMS gateway sends outbound texts for this site. Only twilio is supported today; new sites should leave this at the default and configure Twilio credentials separately in the integrations section.
from_numberstringoptional
The phone number the SMS will be sent from.

Responses

200
The SMS Notification Settings 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/sites/00000000-0000-0000-0000-000000000000/sms-settings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "confirmation_sms_enabled": false,
  "automated_confirmation_sms_enabled": false,
  "cancellation_sms_enabled": false,
  "pay_by_link_sms_enabled": false,
  "billing_details_request_sms_enabled": false,
  "waitlist_confirmation_sms_enabled": false,
  "reminder_sms_enabled": false,
  "automated_reminder_sms_enabled": false,
  "reminder_sms_time": "09:30:00",
  "reminder_sms_days_ahead": 3,
  "follow_up_sms_enabled": false,
  "automated_follow_up_sms_enabled": false,
  "follow_up_sms_time": "09:30:00",
  "follow_up_sms_days_after": 3,
  "sid": "SENDERSPA",
  "provider": "twilio",
  "from_number": "+1234567890"
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/sms-settings', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "confirmation_sms_enabled": false,
    "automated_confirmation_sms_enabled": false,
    "cancellation_sms_enabled": false,
    "pay_by_link_sms_enabled": false,
    "billing_details_request_sms_enabled": false,
    "waitlist_confirmation_sms_enabled": false,
    "reminder_sms_enabled": false,
    "automated_reminder_sms_enabled": false,
    "reminder_sms_time": "09:30:00",
    "reminder_sms_days_ahead": 3,
    "follow_up_sms_enabled": false,
    "automated_follow_up_sms_enabled": false,
    "follow_up_sms_time": "09:30:00",
    "follow_up_sms_days_after": 3,
    "sid": "SENDERSPA",
    "provider": "twilio",
    "from_number": "+1234567890"
  }),
})

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/sites/00000000-0000-0000-0000-000000000000/sms-settings",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "confirmation_sms_enabled": False,
        "automated_confirmation_sms_enabled": False,
        "cancellation_sms_enabled": False,
        "pay_by_link_sms_enabled": False,
        "billing_details_request_sms_enabled": False,
        "waitlist_confirmation_sms_enabled": False,
        "reminder_sms_enabled": False,
        "automated_reminder_sms_enabled": False,
        "reminder_sms_time": "09:30:00",
        "reminder_sms_days_ahead": 3,
        "follow_up_sms_enabled": False,
        "automated_follow_up_sms_enabled": False,
        "follow_up_sms_time": "09:30:00",
        "follow_up_sms_days_after": 3,
        "sid": "SENDERSPA",
        "provider": "twilio",
        "from_number": "+1234567890"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/sms-settings', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'confirmation_sms_enabled' => false,
            'automated_confirmation_sms_enabled' => false,
            'cancellation_sms_enabled' => false,
            'pay_by_link_sms_enabled' => false,
            'billing_details_request_sms_enabled' => false,
            'waitlist_confirmation_sms_enabled' => false,
            'reminder_sms_enabled' => false,
            'automated_reminder_sms_enabled' => false,
            'reminder_sms_time' => '09:30:00',
            'reminder_sms_days_ahead' => 3,
            'follow_up_sms_enabled' => false,
            'automated_follow_up_sms_enabled' => false,
            'follow_up_sms_time' => '09:30:00',
            'follow_up_sms_days_after' => 3,
            'sid' => 'SENDERSPA',
            'provider' => 'twilio',
            'from_number' => '+1234567890'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"confirmation_sms_enabled": false,
		"automated_confirmation_sms_enabled": false,
		"cancellation_sms_enabled": false,
		"pay_by_link_sms_enabled": false,
		"billing_details_request_sms_enabled": false,
		"waitlist_confirmation_sms_enabled": false,
		"reminder_sms_enabled": false,
		"automated_reminder_sms_enabled": false,
		"reminder_sms_time": "09:30:00",
		"reminder_sms_days_ahead": 3,
		"follow_up_sms_enabled": false,
		"automated_follow_up_sms_enabled": false,
		"follow_up_sms_time": "09:30:00",
		"follow_up_sms_days_after": 3,
		"sid": "SENDERSPA",
		"provider": "twilio",
		"from_number": "+1234567890",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/sms-settings", 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 SMS Notification Settings were successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "confirmation_sms_enabled": false,
    "automated_confirmation_sms_enabled": false,
    "cancellation_sms_enabled": false,
    "pay_by_link_sms_enabled": false,
    "billing_details_request_sms_enabled": false,
    "waitlist_confirmation_sms_enabled": false,
    "reminder_sms_enabled": false,
    "automated_reminder_sms_enabled": false,
    "reminder_sms_time": "09:30:00",
    "reminder_sms_days_ahead": 3,
    "follow_up_sms_enabled": false,
    "automated_follow_up_sms_enabled": false,
    "follow_up_sms_time": "09:30:00",
    "follow_up_sms_days_after": 3,
    "sid": "SENDERSPA",
    "provider": "twilio",
    "from_number": 1234567890
  }
}

{
  "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/sites/{siteId}/supported-comms-locales

Get supported comms locales

getSupportedCommsLocales

This endpoint returns a list of the locales that are supported by the site.

When a Customer has a preferred locale, if the locale is included in the site's supported comms locales, then any email communication will be sent in that preferred locale.

The locales must be included in the platform's supported locales, which can be retrieved using the listMetaSupportedLocales endpoint.

Path parameters

siteIduuidrequired
Identifier of the site whose supported communication locales are being read or updated. The locales control which translations are selectable when authoring email/SMS templates and which locales customers may pick from at checkout.

Responses

200
A list of supported comms locales
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/supported-comms-locales" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

A list of supported comms locales

{
  "data": [
    {
      "code": "en",
      "name": "English",
      "emoji": "🇬🇧"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

put/shop/sites/{siteId}/supported-comms-locales

Update supported comms locales

updateSupportedCommsLocales

This endpoint allows you to update the list of locales that are supported by the site.

When a Customer has a preferred locale, if the locale is included in the site's supported comms locales, then any email communication will be sent in that preferred locale.

The locales must be included in the platform's supported locales, which can be retrieved using the listMetaSupportedLocales endpoint.

Path parameters

siteIduuidrequired
Identifier of the site whose supported communication locales are being read or updated. The locales control which translations are selectable when authoring email/SMS templates and which locales customers may pick from at checkout.

Request body

localesstring[]optional
A list of locales that are supported by the site.

This should be a string of locale codes that are supported by the platform.

Responses

200
A list of supported comms locales
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/sites/00000000-0000-0000-0000-000000000000/supported-comms-locales" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "locales": [
    "en",
    "fr",
    "de"
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/supported-comms-locales', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "locales": [
      "en",
      "fr",
      "de"
    ]
  }),
})

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/sites/00000000-0000-0000-0000-000000000000/supported-comms-locales",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "locales": [
            "en",
            "fr",
            "de"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/supported-comms-locales', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'locales' => [
                'en',
                'fr',
                'de'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"locales": []interface{}{
			"en",
			"fr",
			"de",
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/supported-comms-locales", 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)
}

A list of supported comms locales

{
  "data": [
    {
      "code": "en",
      "name": "English",
      "emoji": "🇬🇧"
    }
  ]
}

{
  "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/sites/{siteId}/features

Get the features of a Site

getSiteFeatures

Use this endpoint to retrieve the features of an existing Site.

Path parameters

siteIduuidrequired
The ID of the site

Responses

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

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

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

{
  "data": {
    "support_wearable_payments": false,
    "support_terminal_initiated_payments": false,
    "terminal_payment_retail_product_id": "64a9f3b2c3d8e1f4a5b6c7d8"
  }
}

{
  "message": "Unauthenticated"
}

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

put/shop/sites/{siteId}/features

Update the features of a Site

updateSiteFeatures

Use this endpoint to update the features of an existing Site.

Path parameters

siteIduuidrequired
The ID of the site

Request body

support_wearable_paymentsbooleanoptional
Whether the site supports wearable payments
support_terminal_initiated_paymentsbooleanoptional
Whether the site supports terminal initiated payments
terminal_payment_retail_product_idobject-idoptionalnullable
Identifier of the retail product used to back ad-hoc terminal-initiated payments (e.g. open-amount tap-to-pay charges). The product's revenue centre is what the resulting sale will post to. Pass null to disable terminal-initiated payments.

Responses

200
The Site features 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/sites/00000000-0000-0000-0000-000000000000/features" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "support_wearable_payments": false,
  "support_terminal_initiated_payments": false,
  "terminal_payment_retail_product_id": "64a9f3b2c3d8e1f4a5b6c7d8"
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/features', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "support_wearable_payments": false,
    "support_terminal_initiated_payments": false,
    "terminal_payment_retail_product_id": "64a9f3b2c3d8e1f4a5b6c7d8"
  }),
})

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/sites/00000000-0000-0000-0000-000000000000/features",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "support_wearable_payments": False,
        "support_terminal_initiated_payments": False,
        "terminal_payment_retail_product_id": "64a9f3b2c3d8e1f4a5b6c7d8"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/features', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'support_wearable_payments' => false,
            'support_terminal_initiated_payments' => false,
            'terminal_payment_retail_product_id' => '64a9f3b2c3d8e1f4a5b6c7d8'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"support_wearable_payments": false,
		"support_terminal_initiated_payments": false,
		"terminal_payment_retail_product_id": "64a9f3b2c3d8e1f4a5b6c7d8",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/features", 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 `Site` features were successfully retrieved

{
  "data": {
    "support_wearable_payments": false,
    "support_terminal_initiated_payments": false,
    "terminal_payment_retail_product_id": "64a9f3b2c3d8e1f4a5b6c7d8"
  }
}

{
  "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/sites/{siteId}/shop-config/offering-order

Get details of all offerings available on the shop in their specified order

getOfferingOrder

This endpoint retrieves the details of all offerings available on the shop in their specified order for the given site.

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
The order of offerings available on the shop for the site.
401
The user is unauthenticated
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/shop-config/offering-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/sites/00000000-0000-0000-0000-000000000000/shop-config/offering-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/sites/00000000-0000-0000-0000-000000000000/shop-config/offering-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/sites/00000000-0000-0000-0000-000000000000/shop-config/offering-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 order of offerings available on the shop for the site.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "offering_type": "area_booking",
      "name": "Hot Tub Booking",
      "members_only": true,
      "image_url": "https://example.com/image.jpg"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

put/shop/sites/{siteId}/shop-config/offering-order

Update the order of offerings available on the shop

updateOfferingOrder

Use this endpoint to update the order of offerings available on the shop for a specific site.

Path parameters

siteIduuidrequired
The ID of the site

Request body

offering_idsstring[]required

Responses

200
The order of offerings available on the shop for the site.
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/sites/00000000-0000-0000-0000-000000000000/shop-config/offering-order" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "offering_ids": [
    "string"
  ]
}'

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

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/sites/00000000-0000-0000-0000-000000000000/shop-config/offering-order",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "offering_ids": [
            "string"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"offering_ids": []interface{}{
			"string",
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/shop-config/offering-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 order of offerings available on the shop for the site.

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "offering_type": "area_booking",
      "name": "Hot Tub Booking",
      "members_only": true,
      "image_url": "https://example.com/image.jpg"
    }
  ]
}

{
  "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/sites/{siteId}/shop-config/sso

Get the SSO configuration for a site

getSsoConfig

This endpoint retrieves the SSO configuration for a specific site.

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
The SSO configuration for the site.
401
The user is unauthenticated
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/shop-config/sso', {
  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/sites/00000000-0000-0000-0000-000000000000/shop-config/sso",
    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/sites/00000000-0000-0000-0000-000000000000/shop-config/sso', [
    '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/sites/00000000-0000-0000-0000-000000000000/shop-config/sso", 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 SSO configuration for the site.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "type": "customer_sso",
    "enabled": true,
    "authorize_url": "https://api.trybe.test/authorize",
    "credentials": {
      "client_id": "1234",
      "has_client_secret": true,
      "masked_client_secret": "***********",
      "additional_authorize_query_params": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "additional_token_query_params": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "token_url": "https://api.trybe.test/token",
    "user_info_url": "https://api.trybe.test/userinfo",
    "scopes": [
      "openid"
    ],
    "include_existing_url_params": false,
    "token_request_style": "form_params",
    "user_mappings": [
      {
        "key": "email",
        "fields": [
          "email"
        ]
      }
    ],
    "created_at": "2025-05-01T00:00:00Z",
    "updated_at": "2025-05-01T00:00:00Z"
  }
}

{
  "message": "Unauthenticated"
}

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

put/shop/sites/{siteId}/shop-config/sso

Update the SSO configuration for a site

updateSsoConfig

Use this endpoint to update the SSO configuration for a specific site.

Path parameters

siteIduuidrequired
The ID of the site

Request body

iduuidoptional
Identifier of the SSO configuration to update, returned by the SSO config read endpoint. Must match the configuration currently attached to the site in the URL.
site_iduuidoptional
Identifier of the site that owns this SSO configuration. Must match the siteId in the request URL; provided redundantly to make the body self-describing for audit logs.
typestringoptional
The type of SSO configuration.
enabledbooleanoptional
Whether the SSO configuration is enabled.
authorize_urlstringoptional
The URL to redirect to for authorization.
credentialsobjectoptional
The credentials required for the SSO configuration.
token_urlstringoptional
The URL to request an access token.
user_info_urlstringoptional
The URL to request user information.
scopesstring[]optional
The scopes to request during authorization.
include_existing_url_paramsbooleanoptional
Whether to include existing URL parameters in the authorization request.
token_request_stylestringoptional
The style of the token request.
Possible values:form_paramsjson
user_mappingsobject[]optional
Mappings from user attributes to SSO token fields.

Responses

200
The SSO configuration for the site.
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/sites/00000000-0000-0000-0000-000000000000/shop-config/sso" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "00000000-0000-0000-0000-000000000000",
  "site_id": "00000000-0000-0000-0000-000000000000",
  "type": "customer_sso",
  "enabled": true,
  "authorize_url": "https://api.trybe.test/authorize",
  "credentials": {
    "client_id": "1234",
    "client_secret": "s3cr3tK3y123!@#",
    "additional_authorize_query_params": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "additional_token_query_params": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "token_url": "https://api.trybe.test/token",
  "user_info_url": "https://api.trybe.test/userinfo",
  "scopes": [
    "openid"
  ],
  "include_existing_url_params": false,
  "token_request_style": "form_params",
  "user_mappings": [
    {
      "key": "full_name",
      "fields": [
        "email"
      ]
    }
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/shop-config/sso', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "type": "customer_sso",
    "enabled": true,
    "authorize_url": "https://api.trybe.test/authorize",
    "credentials": {
      "client_id": "1234",
      "client_secret": "s3cr3tK3y123!@#",
      "additional_authorize_query_params": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "additional_token_query_params": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "token_url": "https://api.trybe.test/token",
    "user_info_url": "https://api.trybe.test/userinfo",
    "scopes": [
      "openid"
    ],
    "include_existing_url_params": false,
    "token_request_style": "form_params",
    "user_mappings": [
      {
        "key": "full_name",
        "fields": [
          "email"
        ]
      }
    ]
  }),
})

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/sites/00000000-0000-0000-0000-000000000000/shop-config/sso",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "id": "00000000-0000-0000-0000-000000000000",
        "site_id": "00000000-0000-0000-0000-000000000000",
        "type": "customer_sso",
        "enabled": True,
        "authorize_url": "https://api.trybe.test/authorize",
        "credentials": {
            "client_id": "1234",
            "client_secret": "s3cr3tK3y123!@#",
            "additional_authorize_query_params": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "additional_token_query_params": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        },
        "token_url": "https://api.trybe.test/token",
        "user_info_url": "https://api.trybe.test/userinfo",
        "scopes": [
            "openid"
        ],
        "include_existing_url_params": False,
        "token_request_style": "form_params",
        "user_mappings": [
            {
                "key": "full_name",
                "fields": [
                    "email"
                ]
            }
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/shop-config/sso', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'id' => '00000000-0000-0000-0000-000000000000',
            'site_id' => '00000000-0000-0000-0000-000000000000',
            'type' => 'customer_sso',
            'enabled' => true,
            'authorize_url' => 'https://api.trybe.test/authorize',
            'credentials' => [
                'client_id' => '1234',
                'client_secret' => 's3cr3tK3y123!@#',
                'additional_authorize_query_params' => [
                    [
                        'key' => 'string',
                        'value' => 'string'
                    ]
                ],
                'additional_token_query_params' => [
                    [
                        'key' => 'string',
                        'value' => 'string'
                    ]
                ]
            ],
            'token_url' => 'https://api.trybe.test/token',
            'user_info_url' => 'https://api.trybe.test/userinfo',
            'scopes' => [
                'openid'
            ],
            'include_existing_url_params' => false,
            'token_request_style' => 'form_params',
            'user_mappings' => [
                [
                    'key' => 'full_name',
                    'fields' => [
                        'email'
                    ]
                ]
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"id": "00000000-0000-0000-0000-000000000000",
		"site_id": "00000000-0000-0000-0000-000000000000",
		"type": "customer_sso",
		"enabled": true,
		"authorize_url": "https://api.trybe.test/authorize",
		"credentials": map[string]interface{}{
			"client_id": "1234",
			"client_secret": "s3cr3tK3y123!@#",
			"additional_authorize_query_params": []interface{}{
				map[string]interface{}{
					"key": "string",
					"value": "string",
				},
			},
			"additional_token_query_params": []interface{}{
				map[string]interface{}{
					"key": "string",
					"value": "string",
				},
			},
		},
		"token_url": "https://api.trybe.test/token",
		"user_info_url": "https://api.trybe.test/userinfo",
		"scopes": []interface{}{
			"openid",
		},
		"include_existing_url_params": false,
		"token_request_style": "form_params",
		"user_mappings": []interface{}{
			map[string]interface{}{
				"key": "full_name",
				"fields": []interface{}{
					"email",
				},
			},
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/shop-config/sso", 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 SSO configuration for the site.

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "type": "customer_sso",
    "enabled": true,
    "authorize_url": "https://api.trybe.test/authorize",
    "credentials": {
      "client_id": "1234",
      "has_client_secret": true,
      "masked_client_secret": "***********",
      "additional_authorize_query_params": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "additional_token_query_params": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "token_url": "https://api.trybe.test/token",
    "user_info_url": "https://api.trybe.test/userinfo",
    "scopes": [
      "openid"
    ],
    "include_existing_url_params": false,
    "token_request_style": "form_params",
    "user_mappings": [
      {
        "key": "email",
        "fields": [
          "email"
        ]
      }
    ],
    "created_at": "2025-05-01T00:00:00Z",
    "updated_at": "2025-05-01T00:00:00Z"
  }
}

{
  "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/sites/{siteId}/custom-payment-types

List a Site's custom payment types

listSiteCustomPaymentTypes

Returns the set of CustomPaymentTypes enabled for the given Site. Custom payment types let operators record tenders that are not handled by the platform's first-class processors — typical examples include third-party voucher providers, hotel PMS prepayments, and arbitrary "cash equivalent" tenders.

Custom payment types are defined at the organisation level via the /shop/organisations/{organisationId}/custom-payment-types endpoints; this endpoint returns the subset associated with the named Site.

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
The Site's 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/sites/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/sites/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/sites/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/sites/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/sites/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 `Site`'s 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"
}

get/shop/sites/{siteId}/sold-by-users

List sold-by users for a Site

listSiteSoldByUsers

Returns the combined list of Trybe users and Practitioners who can be selected as the "sold by" attribution on an Order, OrderLine, or basket. The list is filtered to those that belong to the named Site's organisation.

Use the returned id and type values to populate sold_by fields when creating or updating sales records.

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
The sold-by entities were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/sites/00000000-0000-0000-0000-000000000000/sold-by-users" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

{
  "data": [
    {
      "id": "5f8d944e79c9f341846e807a",
      "name": "Ada Lovelace",
      "type": "practitioner"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

get/customers/sites/{siteId}/mobile-pass-customisation

Retrieve the mobile pass customisation

getMobilePassCustomisation

Retrieves the mobile pass customisation for the given site. The customisation controls the visual appearance of digital wallet passes (Apple Wallet / Google Wallet) issued to members.

Path parameters

siteIduuidrequired
The site ID

Responses

200
The mobile pass customisation for the site was successfully retrieved or updated.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation', {
  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/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation",
    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/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation', [
    '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/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation", 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 mobile pass customisation for the site was successfully retrieved or updated.

{
  "data": {
    "enabled": false,
    "icon_id": "000000-000000-000000-000000",
    "icon": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "logo_id": "000000-000000-000000-000000",
    "logo": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "strip_id": "000000-000000-000000-000000",
    "strip": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "background_colour": "#FF0066",
    "foreground_colour": "#FF0066",
    "label_colour": "#FF0066"
  }
}

{
  "message": "Unauthenticated"
}

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

post/customers/sites/{siteId}/mobile-pass-customisation

Update the mobile pass customisation

updateMobilePassCustomisation

Updates the mobile pass customisation for the given site, including the icon, logo, strip image and colour scheme. The icon_id is required; the other media references are optional.

Path parameters

siteIduuidrequired
The site ID

Request body

icon_iduuidrequired
Media to use as the icon on the mobile pass. Apple Wallet renders this in notifications; aim for a small square image. Must already be uploaded via the Media API.
logo_iduuidoptional
Media to use as the logo on the mobile pass. Shown at the top of the pass next to the brand name.
strip_iduuidoptional
The media id of the strip image
background_colourstringoptional
Background hex colour for the pass, excluding the leading #. Use the brand colour that contrasts well with white text.
foreground_colourstringoptional
Foreground hex colour for the primary pass copy, excluding the leading #. Pick a value with high contrast against background_colour.
label_colourstringoptional
Hex colour for the small field labels on the pass, excluding the leading #. Defaults to a slightly dimmer shade than foreground_colour.
enabledbooleanoptional
Whether or not to enable mobile passes for this site

Responses

200
The mobile pass customisation for the site was successfully retrieved or 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 POST "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "icon_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "logo_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "strip_id": "000000-000000-000000-000000",
  "background_colour": "1a1a2e",
  "foreground_colour": "ffffff",
  "label_colour": "cccccc",
  "enabled": false
}'

const response = await fetch('https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "icon_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "logo_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "strip_id": "000000-000000-000000-000000",
    "background_colour": "1a1a2e",
    "foreground_colour": "ffffff",
    "label_colour": "cccccc",
    "enabled": 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/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "icon_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "logo_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "strip_id": "000000-000000-000000-000000",
        "background_colour": "1a1a2e",
        "foreground_colour": "ffffff",
        "label_colour": "cccccc",
        "enabled": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'icon_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d',
            'logo_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d',
            'strip_id' => '000000-000000-000000-000000',
            'background_colour' => '1a1a2e',
            'foreground_colour' => 'ffffff',
            'label_colour' => 'cccccc',
            'enabled' => false
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"icon_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
		"logo_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
		"strip_id": "000000-000000-000000-000000",
		"background_colour": "1a1a2e",
		"foreground_colour": "ffffff",
		"label_colour": "cccccc",
		"enabled": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/sites/00000000-0000-0000-0000-000000000000/mobile-pass-customisation", 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 mobile pass customisation for the site was successfully retrieved or updated.

{
  "data": {
    "enabled": false,
    "icon_id": "000000-000000-000000-000000",
    "icon": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "logo_id": "000000-000000-000000-000000",
    "logo": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "strip_id": "000000-000000-000000-000000",
    "strip": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "background_colour": "#FF0066",
    "foreground_colour": "#FF0066",
    "label_colour": "#FF0066"
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

get/sites/{siteId}/tax-info

Get the tax details for a Site

getSiteTaxInfo

Returns the registered tax identifier (e.g. VAT or GST number) and registered company address for a Site. These values appear on receipts, invoices, and exported tax reports.

Path parameters

siteIduuidrequired
The ID of the site

Responses

200
The site tax info
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/sites/00000000-0000-0000-0000-000000000000/tax-info" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/sites/00000000-0000-0000-0000-000000000000/tax-info', {
  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/sites/00000000-0000-0000-0000-000000000000/tax-info",
    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/sites/00000000-0000-0000-0000-000000000000/tax-info', [
    '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/sites/00000000-0000-0000-0000-000000000000/tax-info", 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 site tax info

{
  "data": {
    "tax_id": "GB 123 4567 89",
    "address_line_1": "71 Aldwych",
    "address_line_2": "WeWork",
    "city": "London",
    "county": "London",
    "country": "United Kingdom",
    "postcode": "WC2B 4HN"
  }
}

{
  "message": "Unauthenticated"
}

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

post/sites/{siteId}/tax-info

Update the tax details for a Site

updateSiteTaxInfo

Updates the registered tax identifier (e.g. VAT or GST number) and registered company address for a Site. The updated values take effect on invoices and tax reports generated after the request — historical receipts are unaffected.

Path parameters

siteIduuidrequired
The ID of the site

Request body

tax_idstringrequired
The tax ID, ie the VAT number.
address_line_1stringrequired
The first address line of the registered company.
address_line_2stringoptional
The second address line of the registered company.
citystringrequired
The city of the registered company.
countystringoptional
The county of the registered company.
countrystringrequired
The country of the registered company.
postcodestringrequired
The postcode of the registered company.

Responses

200
The site tax info
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/sites/00000000-0000-0000-0000-000000000000/tax-info" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "tax_id": "GB 123 4567 89",
  "address_line_1": "71 Aldwych",
  "address_line_2": "WeWork",
  "city": "London",
  "county": "London",
  "country": "United Kingdom",
  "postcode": "WC2B 4HN"
}'

const response = await fetch('https://api.playground.try.be/sites/00000000-0000-0000-0000-000000000000/tax-info', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "tax_id": "GB 123 4567 89",
    "address_line_1": "71 Aldwych",
    "address_line_2": "WeWork",
    "city": "London",
    "county": "London",
    "country": "United Kingdom",
    "postcode": "WC2B 4HN"
  }),
})

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/sites/00000000-0000-0000-0000-000000000000/tax-info",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "tax_id": "GB 123 4567 89",
        "address_line_1": "71 Aldwych",
        "address_line_2": "WeWork",
        "city": "London",
        "county": "London",
        "country": "United Kingdom",
        "postcode": "WC2B 4HN"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/sites/00000000-0000-0000-0000-000000000000/tax-info', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'tax_id' => 'GB 123 4567 89',
            'address_line_1' => '71 Aldwych',
            'address_line_2' => 'WeWork',
            'city' => 'London',
            'county' => 'London',
            'country' => 'United Kingdom',
            'postcode' => 'WC2B 4HN'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"tax_id": "GB 123 4567 89",
		"address_line_1": "71 Aldwych",
		"address_line_2": "WeWork",
		"city": "London",
		"county": "London",
		"country": "United Kingdom",
		"postcode": "WC2B 4HN",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/sites/00000000-0000-0000-0000-000000000000/tax-info", 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 site tax info

{
  "data": {
    "tax_id": "GB 123 4567 89",
    "address_line_1": "71 Aldwych",
    "address_line_2": "WeWork",
    "city": "London",
    "county": "London",
    "country": "United Kingdom",
    "postcode": "WC2B 4HN"
  }
}

{
  "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/sites

List shop sites

listShopSites

Returns every Site the caller has permission to see, projected through the shop API's ShopSite shape. The projection includes storefront-facing configuration (currency, payment types, email branding, feature flags, category mappings) that is not exposed on the bare Site record.

The list is unpaginated — sites per organisation are expected to be small enough to return in a single response.

Responses

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

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

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

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "appointment_enquiries_enabled": false,
      "basket_confirmed_email_message": "<p>We look forward to seeing you. If anything changes,\n<a href=\"mailto:hello@example.com\">get in touch</a>.</p>\n",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "category_ids": [
        "string"
      ],
      "country_code": "GB",
      "country_name": "GB",
      "currency": "GBP",
      "custom_payment_types": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "fiscalisation_type": "string",
          "kind": "string",
          "name": "Alex Morgan"
        }
      ],
      "customer_search_config": {
        "sources": [
          {
            "key": "string",
            "name": "Alex Morgan",
            "supported_fields": [
              "string"
            ]
          }
        ]
      },
      "email_from_address": "spa@example.com",
      "email_from_address_verified_at": "2026-01-15T09:30:00+00:00",
      "email_settings": {
        "collect_email_addresses": false,
        "follow_up_emails_enabled": false,
        "follow_up_emails_days_after": 1,
        "follow_up_emails_time": "15:00",
        "hide_manage_order": false,
        "qr_codes_enabled": false,
        "reminder_emails_enabled": false,
        "reminder_emails_days_ahead": 1,
        "reminder_emails_time": "15:00",
        "auto_send_order_summary_on_checkout": false,
        "visibility_settings": {
          "basket_confirmed": {
            "show_day_of_week": false,
            "show_end_times": false,
            "show_guest_names": false,
            "show_practitioner_names": false
          },
          "basket_reminder": {
            "show_day_of_week": false,
            "show_end_times": false,
            "show_guest_names": false,
            "show_practitioner_names": false
          },
          "order_summary": {
            "show_day_of_week": false,
            "show_end_times": false,
            "show_guest_names": false,
            "show_practitioner_names": false
          },
          "new_order": {
            "show_day_of_week": false,
            "show_end_times": false,
            "show_guest_names": false,
            "show_practitioner_names": false
          }
        }
      },
      "external_id": "00000000-0000-0000-0000-000000000000",
      "feature_flags": {},
      "features": {
        "support_wearable_payments": false
      },
      "has_booking_engine_integration": true,
      "has_fiscalisation_integration": true,
      "has_payments_integration": true,
      "has_pos_integration": true,
      "has_table_reservation_integration": true,
      "intake_form_questionnaire_id": "5f1234567890abcdef123456",
      "locale": "en",
      "name": "Palm Tree Spa",
      "opening_hours": [
        {
          "time_from": "string",
          "time_to": "string",
          "weekday": "string"
        }
      ],
      "payment_config": {
        "default_processor": "string",
        "should_show_stripe": false,
        "stripe": {
          "account_id": "00000000-0000-0000-0000-000000000000",
          "account_type": "string"
        },
        "terminal_payments": {
          "enabled": false,
          "processor": "string"
        }
      },
      "pms_integration": {
        "async": false,
        "enabled": false,
        "charge_to_room_enabled": false,
        "type": "string"
      },
      "privacy_policy": "We process your personal data in accordance with GDPR. See our full\nprivacy notice at https://example.com/privacy.\n",
      "revenue_centres": [
        {}
      ],
      "scheduling_week_interval": 2,
      "scheduling_week_interval_start": "2026-01-05T00:00:00Z",
      "shop_config": {
        "features": [
          {}
        ],
        "require_member_guests": false,
        "separate_name_values_enforced": false
      },
      "stripe_config": {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "account_type": "string"
      },
      "terms": "Bookings are subject to our cancellation policy. Full terms at\nhttps://example.com/terms.\n",
      "timezone": "Europe/London",
      "vouchers_integration": {
        "enabled": false,
        "name": "Alex Morgan",
        "type": "string"
      },
      "organisation": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Palm Tree Holdings Ltd."
      }
    }
  ]
}

{
  "message": "Unauthenticated"
}

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