Offerings catalog

Offerings

These endpoints are used to interact with offerings.

get/shop/offering-search

Search for offerings

listOfferings

Use this endpoint to search for different offering types.

Query parameters

offering_typestring[]optional
Filter by specific offering types.
practitioner_idstring[]optional
Filter by specific practitioner IDs.
querystringoptional
Provide a search query to match offerings against.
site_iduuidrequired
The site ID the offerings belong to.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
Successfully retrieved offerings.
401
The user is unauthenticated
403
The authenticated user does not have permission.

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

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

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

const data = await response.json()

import httpx

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

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

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

Successfully retrieved offerings.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "categories": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Alex Morgan"
        }
      ],
      "image_url": "https://example.com",
      "inventory_categories": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Alex Morgan"
        }
      ],
      "members_only": false,
      "name": "Alex Morgan",
      "offering_type": "appointment"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

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

get/shop/offering-search/most-popular

List the most popular offerings

listMostPopularOfferings

Returns the offerings most often sold over the trailing four weeks, capped by per_page and ordered by sales count descending. Useful for "Popular at this site" sections on the storefront and operator quick-pick lists.

Filters mirror the main offering search:

offering_type accepts a comma-separated list; prefix a type with - to exclude it (e.g. appointment,-package).
practitioner_id narrows appointment results to those tied to the given practitioners.

Requires the RESERVATIONS_VIEW permission on the targeted site.

Query parameters

offering_typestring[]optional
Filter by specific offering types.
practitioner_idstring[]optional
Filter by specific practitioner IDs.
site_iduuidrequired
The site ID the offerings belong to.
per_pageintegeroptional
The number of results to return per page

Responses

200
The most popular offerings.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl "https://api.playground.try.be/shop/offering-search/most-popular?site_id=00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

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

const data = await response.json()

import httpx

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

<?php

$client = new \GuzzleHttp\Client();

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

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

package main

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

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

The most popular offerings.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "categories": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Alex Morgan"
        }
      ],
      "image_url": "https://example.com",
      "inventory_categories": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Alex Morgan"
        }
      ],
      "members_only": false,
      "name": "Alex Morgan",
      "offering_type": "appointment"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

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