Offerings catalog

Voucher Types

A VoucherType represents a type of voucher that can be purchased at a site.

get/shop/voucher-types

Updates an existing VoucherType. name is required (the validator re-asserts it on every update); other fields are optional and omitted fields retain their current values. Cash- vs discount-to-zero-specific fields are conditionally enforced — see the request body for details.

Sending category_ids: [] explicitly clears the category list (the only way to wipe categories — omitting the key leaves them unchanged).

Requires the SETTINGS_MANAGE permission on the voucher type's site.

Path parameters

voucherTypeIdobject-idrequired
The ID of the VoucherType.

Request body

namestringrequired
Customer-facing display name. Plain text.
descriptionstringoptionalnullable
Long-form description shown on the voucher's shopfront page.
product_codestringoptionalnullable
External POS/PMS product code.
external_idstringoptionalnullable
External identifier for integrations.
image_idstringoptionalnullable
ID of an uploaded Media to use as the cover image.
recipient_messagestringoptionalnullable
Default message included in the gift-voucher email. HTML is stripped to the site's allowed-tag list.
amount_typestringoptional
Switches the voucher between a fixed cash-value gift card (cash) and a single-offering discount-to-zero voucher (discount_to_zero). Drives which other fields are honoured.
Possible values:cashdiscount_to_zero
amountintegeroptional
Cash value in the smallest currency unit. Only relevant when amount_type=cash.
customisable_amountbooleanoptional
When true, the value can be overridden at sale time. Only relevant when amount_type=cash.
partially_redeemablebooleanoptional
When true, the voucher can be redeemed across multiple transactions. Only relevant when amount_type=cash.
valid_weekdaysstring[]optionalnullable
Lowercase weekday names the voucher is valid on. Only relevant when amount_type=discount_to_zero.
invalid_date_set_idsstring[]optionalnullable
Date-set IDs the voucher is not valid on. Only relevant when amount_type=discount_to_zero.
valid_offeringsobject[]optionalnullable
Allowlist of offerings the voucher may be redeemed against. Only relevant when amount_type=discount_to_zero.
invalid_offeringsobject[]optionalnullable
Denylist of offerings the voucher may not be redeemed against. Only relevant when amount_type=discount_to_zero.
default_validity_intervalstringoptionalnullable
ISO 8601 duration a sold voucher is valid for after purchase. e.g. P1Y = 1 year.
offered_onlinebooleanoptional
Whether the voucher type is sellable via the public shopfront.
privatebooleanoptional
When true, the voucher type is reachable only via direct link.
visibilitystringoptional
The visibility status of the product.
Possible values:publiclink_onlyprivate
members_onlybooleanoptional
When true, only customers with an active membership can purchase.
permitted_membership_type_idsstring[]optionalnullable
Membership-type UUIDs whose active members are allowed to purchase. Only relevant when members_only=true.
category_idsstring[]optional
Voucher-category IDs this voucher type belongs to. Sending [] clears the existing categories.
currencyoptional
ISO-4217 currency code in lowercase. Must be supported by the site.

Responses

200
A single VoucherType.
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/voucher-types/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "£50 Gift Voucher",
  "description": "A £50 gift voucher to spend on any treatment.",
  "product_code": "VOU-GIFT-50",
  "external_id": "ext-gift-50",
  "image_id": "5f1234567890abcdef123456",
  "recipient_message": "<p>Enjoy your gift!</p>\n",
  "amount_type": "cash",
  "amount": 5000,
  "customisable_amount": false,
  "partially_redeemable": false,
  "valid_weekdays": [
    "monday"
  ],
  "invalid_date_set_ids": [
    "64a9f3b2c3d8e1f4a5b6c7d8"
  ],
  "valid_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "invalid_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "default_validity_interval": "P1Y",
  "offered_online": false,
  "private": false,
  "visibility": "public",
  "members_only": false,
  "permitted_membership_type_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "category_ids": [
    "64a9f3b2c3d8e1f4a5b6c7d8"
  ],
  "currency": "gbp"
}'

const response = await fetch('https://api.playground.try.be/shop/voucher-types/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "£50 Gift Voucher",
    "description": "A £50 gift voucher to spend on any treatment.",
    "product_code": "VOU-GIFT-50",
    "external_id": "ext-gift-50",
    "image_id": "5f1234567890abcdef123456",
    "recipient_message": "<p>Enjoy your gift!</p>\n",
    "amount_type": "cash",
    "amount": 5000,
    "customisable_amount": false,
    "partially_redeemable": false,
    "valid_weekdays": [
      "monday"
    ],
    "invalid_date_set_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "valid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "invalid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "default_validity_interval": "P1Y",
    "offered_online": false,
    "private": false,
    "visibility": "public",
    "members_only": false,
    "permitted_membership_type_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "category_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "currency": "gbp"
  }),
})

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/voucher-types/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "£50 Gift Voucher",
        "description": "A £50 gift voucher to spend on any treatment.",
        "product_code": "VOU-GIFT-50",
        "external_id": "ext-gift-50",
        "image_id": "5f1234567890abcdef123456",
        "recipient_message": "<p>Enjoy your gift!</p>\n",
        "amount_type": "cash",
        "amount": 5000,
        "customisable_amount": False,
        "partially_redeemable": False,
        "valid_weekdays": [
            "monday"
        ],
        "invalid_date_set_ids": [
            "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "valid_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "invalid_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "default_validity_interval": "P1Y",
        "offered_online": False,
        "private": False,
        "visibility": "public",
        "members_only": False,
        "permitted_membership_type_ids": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "category_ids": [
            "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "currency": "gbp"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/voucher-types/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => '£50 Gift Voucher',
            'description' => 'A £50 gift voucher to spend on any treatment.',
            'product_code' => 'VOU-GIFT-50',
            'external_id' => 'ext-gift-50',
            'image_id' => '5f1234567890abcdef123456',
            'recipient_message' => '<p>Enjoy your gift!</p>
',
            'amount_type' => 'cash',
            'amount' => 5000,
            'customisable_amount' => false,
            'partially_redeemable' => false,
            'valid_weekdays' => [
                'monday'
            ],
            'invalid_date_set_ids' => [
                '64a9f3b2c3d8e1f4a5b6c7d8'
            ],
            'valid_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'invalid_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'default_validity_interval' => 'P1Y',
            'offered_online' => false,
            'private' => false,
            'visibility' => 'public',
            'members_only' => false,
            'permitted_membership_type_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ],
            'category_ids' => [
                '64a9f3b2c3d8e1f4a5b6c7d8'
            ],
            'currency' => 'gbp'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "£50 Gift Voucher",
		"description": "A £50 gift voucher to spend on any treatment.",
		"product_code": "VOU-GIFT-50",
		"external_id": "ext-gift-50",
		"image_id": "5f1234567890abcdef123456",
		"recipient_message": "<p>Enjoy your gift!</p>\n",
		"amount_type": "cash",
		"amount": 5000,
		"customisable_amount": false,
		"partially_redeemable": false,
		"valid_weekdays": []interface{}{
			"monday",
		},
		"invalid_date_set_ids": []interface{}{
			"64a9f3b2c3d8e1f4a5b6c7d8",
		},
		"valid_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"invalid_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"default_validity_interval": "P1Y",
		"offered_online": false,
		"private": false,
		"visibility": "public",
		"members_only": false,
		"permitted_membership_type_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
		"category_ids": []interface{}{
			"64a9f3b2c3d8e1f4a5b6c7d8",
		},
		"currency": "gbp",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/voucher-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)
}

A single `VoucherType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "£50 voucher",
    "description": "£50 off a treatment of your choice.",
    "external_id": "00000000-0000-0000-0000-000000000000",
    "product_code": "VOU123",
    "image": {
      "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"
    },
    "recipient_message": "You can spend this on anything you like. Enjoy!",
    "amount_type": "cash",
    "amount": 2500,
    "customisable_amount": true,
    "valid_weekdays": [
      "monday"
    ],
    "invalid_date_set_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "valid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "invalid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "partially_redeemable": true,
    "default_validity_interval": "P1Y",
    "offered_online": true,
    "private": false,
    "members_only": true,
    "permitted_membership_type_ids": [
      "string"
    ],
    "availability_rules": [
      {
        "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"
        ]
      }
    ],
    "currency": "gbp",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "category_ids": [
      "string"
    ],
    "updated_at": "2020-02-24T12:00:00+01:00",
    "deleted_at": "2020-02-24T12:00:00+01:00",
    "visibility": "public"
  }
}

{
  "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/voucher-types/{voucherTypeId}

Delete a voucher type

deleteVoucherType

Soft-deletes the voucher type. Existing vouchers already sold under this type remain valid and redeemable; the type itself is removed from new-sale flows. Use POST .../restore to bring it back.

Requires the SETTINGS_MANAGE permission on the voucher type's site. No request body.

Path parameters

voucherTypeIdobject-idrequired
The ID of the VoucherType.

Responses

204
Voucher type deleted successfully.
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/voucher-types/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

Voucher type deleted successfully.

// empty response

{
  "message": "Unauthenticated"
}

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

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

get/shop/voucher-types/{voucherTypeId}/availability-rules

List availability rules for a voucher type

listVoucherTypeAvailabilityRules

Returns all AvailabilityRules configured on a VoucherType. Availability rules carve up the calendar into windows when vouchers of this type can or cannot be redeemed — useful for blocking peak holiday dates, restricting redemptions to specific seasons, or only allowing redemption from a future opening date.

Rule semantics: any is_available: false rule overrides any is_available: true rule for the same period.

Path parameters

voucherTypeIdobject-idrequired
The ID of the VoucherType.

Responses

200
A list of AvailabilityRules configured on the VoucherType.
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/voucher-types/abc123/availability-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/voucher-types/abc123/availability-rules', {
  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/voucher-types/abc123/availability-rules",
    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/voucher-types/abc123/availability-rules', [
    '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/voucher-types/abc123/availability-rules", 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 `AvailabilityRule`s configured on the `VoucherType`.

{
  "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/voucher-types/{voucherTypeId}/availability-rules

Create an availability rule for a voucher type

createVoucherTypeAvailabilityRule

Adds a new AvailabilityRule to a VoucherType. Use is_available: true to open redemption windows, or is_available: false to block redemptions during the supplied date range. Omit the dates to apply the rule from today onwards with no end date.

Requires the update ability on the voucher type.

Path parameters

voucherTypeIdobject-idrequired
The ID of the VoucherType.

Request body

is_availablebooleanrequired
true opens redemption windows; false closes them. false rules override true rules for the same period.
date_fromdateoptionalnullable
First date the rule applies (inclusive), in the voucher type's timezone. Defaults to today when omitted.
date_todateoptionalnullable
Last date the rule applies (inclusive). Must be on or after date_from. Omit for an open-ended rule.

Responses

201
A single AvailabilityRule belonging to the VoucherType.
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/voucher-types/abc123/availability-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "is_available": false,
  "date_from": "2026-12-20",
  "date_to": "2027-01-02"
}'

const response = await fetch('https://api.playground.try.be/shop/voucher-types/abc123/availability-rules', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "is_available": false,
    "date_from": "2026-12-20",
    "date_to": "2027-01-02"
  }),
})

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/voucher-types/abc123/availability-rules",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "is_available": False,
        "date_from": "2026-12-20",
        "date_to": "2027-01-02"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/voucher-types/abc123/availability-rules', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'is_available' => false,
            'date_from' => '2026-12-20',
            'date_to' => '2027-01-02'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"is_available": false,
		"date_from": "2026-12-20",
		"date_to": "2027-01-02",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/voucher-types/abc123/availability-rules", 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 single `AvailabilityRule` belonging to the `VoucherType`.

{
  "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/voucher-types/{voucherTypeId}/availability-rules/{availabilityRuleId}

Retrieve a voucher type availability rule

getVoucherTypeAvailabilityRule

Returns a single AvailabilityRule belonging to the given VoucherType.

Path parameters

voucherTypeIdobject-idrequired
The ID of the VoucherType.
availabilityRuleIdobject-idrequired
The unique identifier of the availability rule.

Responses

200
A single AvailabilityRule belonging to the VoucherType.
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/voucher-types/abc123/availability-rules/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

A single `AvailabilityRule` belonging to the `VoucherType`.

{
  "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/voucher-types/{voucherTypeId}/availability-rules/{availabilityRuleId}

Update a voucher type availability rule

updateVoucherTypeAvailabilityRule

Replaces an AvailabilityRule on a VoucherType. The server validates the same shape as on create, so is_available is required and any supplied dates must keep date_to on or after date_from. Requires the update ability on the voucher type.

Path parameters

voucherTypeIdobject-idrequired
The ID of the VoucherType.
availabilityRuleIdobject-idrequired
The unique identifier of the availability rule.

Request body

is_availablebooleanrequired
Whether the window is bookable for voucher redemption. false overrides true.
date_fromdateoptionalnullable
First date the rule applies (inclusive).
date_todateoptionalnullable
Last date the rule applies (inclusive). Must be on or after date_from.

Responses

200
A single AvailabilityRule belonging to the VoucherType.
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/voucher-types/abc123/availability-rules/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "is_available": true,
  "date_from": "2026-12-20",
  "date_to": "2027-01-02"
}'

const response = await fetch('https://api.playground.try.be/shop/voucher-types/abc123/availability-rules/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "is_available": true,
    "date_from": "2026-12-20",
    "date_to": "2027-01-02"
  }),
})

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/voucher-types/abc123/availability-rules/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "is_available": True,
        "date_from": "2026-12-20",
        "date_to": "2027-01-02"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/voucher-types/abc123/availability-rules/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'is_available' => true,
            'date_from' => '2026-12-20',
            'date_to' => '2027-01-02'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"is_available": true,
		"date_from": "2026-12-20",
		"date_to": "2027-01-02",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/voucher-types/abc123/availability-rules/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)
}

A single `AvailabilityRule` belonging to the `VoucherType`.

{
  "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/voucher-types/{voucherTypeId}/availability-rules/{availabilityRuleId}

Delete a voucher type availability rule

deleteVoucherTypeAvailabilityRule

Removes an AvailabilityRule from a VoucherType. Redemption windows are recomputed from the remaining rules. Vouchers already issued are not affected.

Path parameters

voucherTypeIdobject-idrequired
The ID of the VoucherType.
availabilityRuleIdobject-idrequired
The unique identifier of the availability rule.

Responses

204
Availability rule deleted successfully.
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/voucher-types/abc123/availability-rules/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

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

Availability rule deleted successfully.

// empty response

{
  "message": "Unauthenticated"
}

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

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

post/shop/voucher-types/{voucherTypeId}/copy

Duplicate a voucher type

copyVoucherType

Creates a copy of an existing VoucherType with the supplied fields overlaid on top. Useful when seeding a near-identical offering off an existing one. The new voucher type is created under the same site and organisation as the original; you can override any write-able field by sending it in the body. Fields omitted from the body are inherited from the source verbatim.

name is required so the new copy is distinguishable from the source. The amount_type-based field rules apply just as on create — see the request body for details.

Requires the SETTINGS_MANAGE permission on the original voucher type's site.

Path parameters

voucherTypeIdobject-idrequired
The ID of the VoucherType.

Request body

namestringrequired
Display name for the new copy. Required so the copy is distinguishable from the source.
descriptionstringoptionalnullable
Override the long-form description on the copy. Defaults to the source's description when omitted.
product_codestringoptionalnullable
Override the POS/PMS product code. Defaults to the source's value.
external_idstringoptionalnullable
Override the external identifier on the copy. Defaults to the source's value; consider setting this explicitly so integrations don't see two offerings with the same external id.
image_idstringoptionalnullable
ID of an uploaded Media to use as the cover image. Defaults to the source's image.
recipient_messagestringoptionalnullable
Override the gift-voucher recipient message. HTML is stripped to the site's allowed-tag list.
amount_typestringoptional
Override the voucher amount type on the copy. Switching this between cash and discount_to_zero clears the fields that don't apply to the new type.
Possible values:cashdiscount_to_zero
amountintegeroptional
Override the cash value (smallest currency unit) on the copy. Only relevant when amount_type=cash.
customisable_amountbooleanoptional
Override whether the value can be customised at sale time. Only relevant when amount_type=cash.
partially_redeemablebooleanoptional
Override whether the copy can be partially redeemed. Only relevant when amount_type=cash.
valid_weekdaysstring[]optionalnullable
Override the lowercase weekday allowlist. Only relevant when amount_type=discount_to_zero.
invalid_date_set_idsstring[]optionalnullable
Override the denylist of date-set IDs the copy is invalid on. Only relevant when amount_type=discount_to_zero.
valid_offeringsobject[]optionalnullable
Override the allowlist of offerings the copy may be redeemed against. Only relevant when amount_type=discount_to_zero.
invalid_offeringsobject[]optionalnullable
Override the denylist of offerings the copy may not be redeemed against. Only relevant when amount_type=discount_to_zero.
default_validity_intervalstringoptionalnullable
ISO 8601 duration a sold voucher of this copy is valid for. Override the source's default. e.g. P1Y = 1 year.
offered_onlinebooleanoptional
Whether the copy is sellable via the public shopfront.
privatebooleanoptional
When true, the copy is reachable only via direct link.
visibilitystringoptional
The visibility status of the product.
Possible values:publiclink_onlyprivate
members_onlybooleanoptional
When true, only members can purchase the copy.
permitted_membership_type_idsstring[]optionalnullable
Membership-type UUIDs whose active members can purchase the copy. Only relevant when members_only=true.
category_idsstring[]optional
Override the voucher-category memberships on the copy. Each ID must reference a category on the voucher type's site.
currencyoptional
ISO-4217 currency code in lowercase. Must be supported by the site.

Responses

201
A single VoucherType.
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/voucher-types/abc123/copy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "£100 Gift Voucher",
  "description": "A £100 gift voucher to spend on any treatment.",
  "product_code": "VOU-GIFT-100",
  "external_id": "ext-gift-100",
  "image_id": "5f1234567890abcdef123456",
  "recipient_message": "<p>Enjoy your £100 voucher!</p>\n",
  "amount_type": "cash",
  "amount": 10000,
  "customisable_amount": false,
  "partially_redeemable": false,
  "valid_weekdays": [
    "monday"
  ],
  "invalid_date_set_ids": [
    "64a9f3b2c3d8e1f4a5b6c7d8"
  ],
  "valid_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "invalid_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "default_validity_interval": "P1Y",
  "offered_online": false,
  "private": false,
  "visibility": "public",
  "members_only": false,
  "permitted_membership_type_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "category_ids": [
    "64a9f3b2c3d8e1f4a5b6c7d8"
  ],
  "currency": "gbp"
}'

const response = await fetch('https://api.playground.try.be/shop/voucher-types/abc123/copy', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "£100 Gift Voucher",
    "description": "A £100 gift voucher to spend on any treatment.",
    "product_code": "VOU-GIFT-100",
    "external_id": "ext-gift-100",
    "image_id": "5f1234567890abcdef123456",
    "recipient_message": "<p>Enjoy your £100 voucher!</p>\n",
    "amount_type": "cash",
    "amount": 10000,
    "customisable_amount": false,
    "partially_redeemable": false,
    "valid_weekdays": [
      "monday"
    ],
    "invalid_date_set_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "valid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "invalid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "default_validity_interval": "P1Y",
    "offered_online": false,
    "private": false,
    "visibility": "public",
    "members_only": false,
    "permitted_membership_type_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "category_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "currency": "gbp"
  }),
})

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/voucher-types/abc123/copy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "£100 Gift Voucher",
        "description": "A £100 gift voucher to spend on any treatment.",
        "product_code": "VOU-GIFT-100",
        "external_id": "ext-gift-100",
        "image_id": "5f1234567890abcdef123456",
        "recipient_message": "<p>Enjoy your £100 voucher!</p>\n",
        "amount_type": "cash",
        "amount": 10000,
        "customisable_amount": False,
        "partially_redeemable": False,
        "valid_weekdays": [
            "monday"
        ],
        "invalid_date_set_ids": [
            "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "valid_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "invalid_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "default_validity_interval": "P1Y",
        "offered_online": False,
        "private": False,
        "visibility": "public",
        "members_only": False,
        "permitted_membership_type_ids": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "category_ids": [
            "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "currency": "gbp"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/voucher-types/abc123/copy', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => '£100 Gift Voucher',
            'description' => 'A £100 gift voucher to spend on any treatment.',
            'product_code' => 'VOU-GIFT-100',
            'external_id' => 'ext-gift-100',
            'image_id' => '5f1234567890abcdef123456',
            'recipient_message' => '<p>Enjoy your £100 voucher!</p>
',
            'amount_type' => 'cash',
            'amount' => 10000,
            'customisable_amount' => false,
            'partially_redeemable' => false,
            'valid_weekdays' => [
                'monday'
            ],
            'invalid_date_set_ids' => [
                '64a9f3b2c3d8e1f4a5b6c7d8'
            ],
            'valid_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'invalid_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'default_validity_interval' => 'P1Y',
            'offered_online' => false,
            'private' => false,
            'visibility' => 'public',
            'members_only' => false,
            'permitted_membership_type_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ],
            'category_ids' => [
                '64a9f3b2c3d8e1f4a5b6c7d8'
            ],
            'currency' => 'gbp'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "£100 Gift Voucher",
		"description": "A £100 gift voucher to spend on any treatment.",
		"product_code": "VOU-GIFT-100",
		"external_id": "ext-gift-100",
		"image_id": "5f1234567890abcdef123456",
		"recipient_message": "<p>Enjoy your £100 voucher!</p>\n",
		"amount_type": "cash",
		"amount": 10000,
		"customisable_amount": false,
		"partially_redeemable": false,
		"valid_weekdays": []interface{}{
			"monday",
		},
		"invalid_date_set_ids": []interface{}{
			"64a9f3b2c3d8e1f4a5b6c7d8",
		},
		"valid_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"invalid_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"default_validity_interval": "P1Y",
		"offered_online": false,
		"private": false,
		"visibility": "public",
		"members_only": false,
		"permitted_membership_type_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
		"category_ids": []interface{}{
			"64a9f3b2c3d8e1f4a5b6c7d8",
		},
		"currency": "gbp",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/voucher-types/abc123/copy", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `VoucherType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "£50 voucher",
    "description": "£50 off a treatment of your choice.",
    "external_id": "00000000-0000-0000-0000-000000000000",
    "product_code": "VOU123",
    "image": {
      "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"
    },
    "recipient_message": "You can spend this on anything you like. Enjoy!",
    "amount_type": "cash",
    "amount": 2500,
    "customisable_amount": true,
    "valid_weekdays": [
      "monday"
    ],
    "invalid_date_set_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "valid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "invalid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "partially_redeemable": true,
    "default_validity_interval": "P1Y",
    "offered_online": true,
    "private": false,
    "members_only": true,
    "permitted_membership_type_ids": [
      "string"
    ],
    "availability_rules": [
      {
        "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"
        ]
      }
    ],
    "currency": "gbp",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "category_ids": [
      "string"
    ],
    "updated_at": "2020-02-24T12:00:00+01:00",
    "deleted_at": "2020-02-24T12:00:00+01:00",
    "visibility": "public"
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

post/shop/voucher-types/{voucherTypeId}/restore

Restore a deleted voucher type

restoreVoucherType

Un-deletes a previously soft-deleted VoucherType. The voucher type returns to its pre-deletion state, including price, validity rules, valid/invalid offerings, and delivery options. Existing vouchers already sold under this type remain unaffected.

Requires the SETTINGS_MANAGE permission on the voucher type's site. No request body.

Path parameters

voucherTypeIdobject-idrequired
The ID of the VoucherType.

Responses

200
The voucher type was restored successfully.
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/voucher-types/abc123/restore" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/voucher-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/voucher-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/voucher-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/voucher-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 voucher type was restored successfully.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "£50 voucher",
    "description": "£50 off a treatment of your choice.",
    "external_id": "00000000-0000-0000-0000-000000000000",
    "product_code": "VOU123",
    "image": {
      "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"
    },
    "recipient_message": "You can spend this on anything you like. Enjoy!",
    "amount_type": "cash",
    "amount": 2500,
    "customisable_amount": true,
    "valid_weekdays": [
      "monday"
    ],
    "invalid_date_set_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "valid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "invalid_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "partially_redeemable": true,
    "default_validity_interval": "P1Y",
    "offered_online": true,
    "private": false,
    "members_only": true,
    "permitted_membership_type_ids": [
      "string"
    ],
    "availability_rules": [
      {
        "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"
        ]
      }
    ],
    "currency": "gbp",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "category_ids": [
      "string"
    ],
    "updated_at": "2020-02-24T12:00:00+01:00",
    "deleted_at": "2020-02-24T12:00:00+01:00",
    "visibility": "public"
  }
}

{
  "message": "Unauthenticated"
}

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

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

get/shop/voucher-types/order

List voucher types in display order

listVoucherTypesOrder

Returns a lightweight, non-paginated list of VoucherTypeSummary objects for the given site, sorted by each voucher type's order field. Use this to render a drag-and-drop ordering UI without pulling the full VoucherType payload for every entry.

Requires the RESERVATIONS_VIEW permission on the site.

Query parameters

site_idstringrequired
Filter results by the site they belong to

Responses

200
The voucher types for the site, sorted by order.
401
The user is unauthenticated
403
The authenticated user does not have permission.

curl "https://api.playground.try.be/shop/voucher-types/order?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/voucher-types/order?site_id=site_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/voucher-types/order?site_id=site_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/voucher-types/order?site_id=site_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/voucher-types/order?site_id=site_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 voucher types for the site, sorted by `order`.

{
  "data": [
    {
      "id": "5dcb47800000000000000000",
      "name": "£50 voucher"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

put/shop/voucher-types/order

Reorder voucher types for a site

updateVoucherTypesOrder

Reorders the voucher types at a site in one request. The order of voucher_type_ids in the body determines each voucher type's order field (first ID → order: 0, second → order: 1, etc.). IDs not listed are unaffected and keep their existing order.

Returns no body on success — call GET /shop/voucher-types/order afterwards to fetch the reordered list.

Requires the SETTINGS_MANAGE permission on the site.

Request body

site_iduuidrequired
ID of the site whose voucher types are being reordered. All voucher_type_ids must belong to this site.
voucher_type_idsstring[]required
Voucher type IDs in the desired display order. The index of each ID in the array becomes that voucher type's order field.

Responses

204
The voucher types were reordered. No content is returned.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/voucher-types/order" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "site_id": "6f1234567890abcdef123456",
  "voucher_type_ids": [
    "64a9f3b2c3d8e1f4a5b6c7d8"
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/voucher-types/order', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "site_id": "6f1234567890abcdef123456",
    "voucher_type_ids": [
      "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/voucher-types/order",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "site_id": "6f1234567890abcdef123456",
        "voucher_type_ids": [
            "64a9f3b2c3d8e1f4a5b6c7d8"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/voucher-types/order', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'site_id' => '6f1234567890abcdef123456',
            'voucher_type_ids' => [
                '64a9f3b2c3d8e1f4a5b6c7d8'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"site_id": "6f1234567890abcdef123456",
		"voucher_type_ids": []interface{}{
			"64a9f3b2c3d8e1f4a5b6c7d8",
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/voucher-types/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 voucher types were reordered. No content is returned.

// empty response

{
  "message": "Unauthenticated"
}

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

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