Offerings catalog

Visit Type

A VisitType represents a configuration for a Visit.

get/shop/visit-types

Show VisitTypes

listVisitTypes

This endpoint retrieves a list of VisitTypes.

Query parameters

site_iduuidoptional
Filter VisitTypes that belong to the given site ID
archivedbooleanoptional
Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The response to a request to list VisitTypes
401
The user is unauthenticated

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

const response = await fetch('https://api.playground.try.be/shop/visit-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/visit-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/visit-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/visit-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 response to a request to list `VisitType`s

{
  "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"
  },
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "name": "Spa Weekend",
      "description": "To be offered to guests staying in December.",
      "offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "email_settings": {
        "creation_email_message": "Your visit has been created.",
        "reminder_emails_enabled": true,
        "reminder_emails_message": "This is a reminder for your upcoming visit.",
        "reminder_emails_time": "09:00",
        "reminder_emails_days_ahead": 2
      },
      "rate_codes": [
        "RATE10"
      ],
      "integration_settings": {
        "auto_send_portal_invite_notification": true
      }
    }
  ]
}

{
  "message": "Unauthenticated"
}

post/shop/visit-types

Create VisitType

createVisitType

This endpoint creates a new VisitType.

Query parameters

site_iduuidoptional
Filter VisitTypes that belong to the given site ID

Request body

namestringrequired
A name to identify this visit configuration, for internal use.
descriptionstringoptional
A description of this visit configuration, for internal use.
offeringsobject[]optional
An array of offerings which each guest can choose from. Each guest may choose one of the following.

Responses

201
The response to a request a single VisitType
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/visit-types" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Spa Weekend",
  "description": "To be offered to guests staying in December.",
  "offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/visit-types', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Spa Weekend",
    "description": "To be offered to guests staying in December.",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ]
  }),
})

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/visit-types",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Spa Weekend",
        "description": "To be offered to guests staying in December.",
        "offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/visit-types', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Spa Weekend',
            'description' => 'To be offered to guests staying in December.',
            'offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Spa Weekend",
		"description": "To be offered to guests staying in December.",
		"offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/visit-types", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The response to a request a single `VisitType`

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "Spa Weekend",
    "description": "To be offered to guests staying in December.",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "email_settings": {
      "creation_email_message": "Your visit has been created.",
      "reminder_emails_enabled": true,
      "reminder_emails_message": "This is a reminder for your upcoming visit.",
      "reminder_emails_time": "09:00",
      "reminder_emails_days_ahead": 2
    },
    "rate_codes": [
      "RATE10"
    ],
    "integration_settings": {
      "auto_send_portal_invite_notification": true
    }
  }
}

{
  "message": "Unauthenticated"
}

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

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

get/shop/visit-types/{visitTypeId}

Show a VisitType

getVisitType

Use this endpoint to retrieve a VisitType

Path parameters

visitTypeIdobject-idoptional
The unique identifier of the VisitType.

Responses

200
The response to a request a single VisitType
401
The user is unauthenticated
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/shop/visit-types/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/visit-types/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/visit-types/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/visit-types/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 response to a request a single `VisitType`

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "Spa Weekend",
    "description": "To be offered to guests staying in December.",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "email_settings": {
      "creation_email_message": "Your visit has been created.",
      "reminder_emails_enabled": true,
      "reminder_emails_message": "This is a reminder for your upcoming visit.",
      "reminder_emails_time": "09:00",
      "reminder_emails_days_ahead": 2
    },
    "rate_codes": [
      "RATE10"
    ],
    "integration_settings": {
      "auto_send_portal_invite_notification": true
    }
  }
}

{
  "message": "Unauthenticated"
}

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

put/shop/visit-types/{visitTypeId}

Update a VisitType

updateVisitType

Use this endpoint to update an existing VisitType.

Path parameters

visitTypeIdobject-idoptional
The unique identifier of the VisitType.

Request body

namestringoptional
A name to identify this visit configuration, for internal use.
descriptionstringoptional
A description of this visit configuration, for internal use.
offeringsobject[]optional
An array of offerings which each guest can choose from. Each guest may choose one of the following.
email_settingsobjectoptional
Email settings associated with this visit type.
integration_settingsobjectoptional
Integration settings associated with this visit type.
rate_codesstring[]optionalnullable
An array of unique rate codes associated with this visit type. Each code must be unique across all visit types.

Responses

201
The response to a request a single VisitType
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/visit-types/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Spa Weekend",
  "description": "To be offered to guests staying in December.",
  "offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "email_settings": {
    "creation_email_message": "Your visit has been created.",
    "reminder_emails_enabled": true,
    "reminder_emails_message": "This is a reminder for your upcoming visit.",
    "reminder_emails_time": "09:00",
    "reminder_emails_days_ahead": 2
  },
  "integration_settings": {
    "auto_send_portal_invite_notification": true
  },
  "rate_codes": [
    "RATE100"
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/visit-types/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Spa Weekend",
    "description": "To be offered to guests staying in December.",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "email_settings": {
      "creation_email_message": "Your visit has been created.",
      "reminder_emails_enabled": true,
      "reminder_emails_message": "This is a reminder for your upcoming visit.",
      "reminder_emails_time": "09:00",
      "reminder_emails_days_ahead": 2
    },
    "integration_settings": {
      "auto_send_portal_invite_notification": true
    },
    "rate_codes": [
      "RATE100"
    ]
  }),
})

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/visit-types/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Spa Weekend",
        "description": "To be offered to guests staying in December.",
        "offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "email_settings": {
            "creation_email_message": "Your visit has been created.",
            "reminder_emails_enabled": True,
            "reminder_emails_message": "This is a reminder for your upcoming visit.",
            "reminder_emails_time": "09:00",
            "reminder_emails_days_ahead": 2
        },
        "integration_settings": {
            "auto_send_portal_invite_notification": True
        },
        "rate_codes": [
            "RATE100"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/visit-types/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Spa Weekend',
            'description' => 'To be offered to guests staying in December.',
            'offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'email_settings' => [
                'creation_email_message' => 'Your visit has been created.',
                'reminder_emails_enabled' => true,
                'reminder_emails_message' => 'This is a reminder for your upcoming visit.',
                'reminder_emails_time' => '09:00',
                'reminder_emails_days_ahead' => 2
            ],
            'integration_settings' => [
                'auto_send_portal_invite_notification' => true
            ],
            'rate_codes' => [
                'RATE100'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Spa Weekend",
		"description": "To be offered to guests staying in December.",
		"offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"email_settings": map[string]interface{}{
			"creation_email_message": "Your visit has been created.",
			"reminder_emails_enabled": true,
			"reminder_emails_message": "This is a reminder for your upcoming visit.",
			"reminder_emails_time": "09:00",
			"reminder_emails_days_ahead": 2,
		},
		"integration_settings": map[string]interface{}{
			"auto_send_portal_invite_notification": true,
		},
		"rate_codes": []interface{}{
			"RATE100",
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/visit-types/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 response to a request a single `VisitType`

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "Spa Weekend",
    "description": "To be offered to guests staying in December.",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "email_settings": {
      "creation_email_message": "Your visit has been created.",
      "reminder_emails_enabled": true,
      "reminder_emails_message": "This is a reminder for your upcoming visit.",
      "reminder_emails_time": "09:00",
      "reminder_emails_days_ahead": 2
    },
    "rate_codes": [
      "RATE10"
    ],
    "integration_settings": {
      "auto_send_portal_invite_notification": true
    }
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

delete/shop/visit-types/{visitTypeId}

Archive a VisitType

deleteVisitType

Use this endpoint to archive a VisitType.

Path parameters

visitTypeIdobject-idoptional
The unique identifier of the VisitType.

Responses

204
VisitType archived
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/visit-types/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/visit-types/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/visit-types/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/visit-types/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/visit-types/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)
}

VisitType archived

// empty response

{
  "message": "Unauthenticated"
}

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

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

post/shop/visit-types/{visitTypeId}/restore

Restore a VisitType

restoreVisitType

Use this endpoint to restore an archived VisitType.

Path parameters

visitTypeIdobject-idoptional
The unique identifier of the VisitType.

Responses

200
The response to a request a single VisitType
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/shop/visit-types/abc123/restore" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/visit-types/abc123/restore', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

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

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/visit-types/abc123/restore",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/visit-types/abc123/restore', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

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

package main

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

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

The response to a request a single `VisitType`

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "Spa Weekend",
    "description": "To be offered to guests staying in December.",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "email_settings": {
      "creation_email_message": "Your visit has been created.",
      "reminder_emails_enabled": true,
      "reminder_emails_message": "This is a reminder for your upcoming visit.",
      "reminder_emails_time": "09:00",
      "reminder_emails_days_ahead": 2
    },
    "rate_codes": [
      "RATE10"
    ],
    "integration_settings": {
      "auto_send_portal_invite_notification": true
    }
  }
}

{
  "message": "Unauthenticated"
}

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

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