TrellisDevelopers
API reference

Reservations

List reservations by service date

GET
/tables-api/v1/locations/{locationId}/reservations

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

locationId*string
Formatuuid

Query Parameters

dateFrom*string
Match^\d{4}-\d{2}-\d{2}$
dateTo*string
Match^\d{4}-\d{2}-\d{2}$

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/tables-api/v1/locations/497f6eca-6276-4993-bfeb-53cbbbba6f08/reservations?dateFrom=string&dateTo=string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "publicId": "f72dfe8e-6cfd-43c2-b1cb-95adbf313789",      "confirmationCode": "string",      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",      "experienceVersionId": "0f25b13b-77c6-4389-b388-277a7477f3af",      "lifecycle": "string",      "version": 1,      "source": "string",      "businessDate": "string",      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "partySize": 1,      "guest": {        "name": "string",        "email": "user@example.com",        "phone": "string"      },      "booking": {        "method": "string",        "currency": "string",        "subtotalAmount": 0,        "taxAmount": 0,        "totalAmount": 0      },      "confirmedAt": "2019-08-24T14:15:22Z",      "cancelledAt": "2019-08-24T14:15:22Z"    }  ]}

Create a free reservation from an availability option

POST
/tables-api/v1/locations/{locationId}/reservations

Paid, prepaid, deposit, and card-hold options require a future payment-session API and currently return payment_required.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

locationId*string
Formatuuid

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

idempotency-key*string
Length8 <= length <= 180

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/tables-api/v1/locations/497f6eca-6276-4993-bfeb-53cbbbba6f08/reservations" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "idempotency-key: stringst" \  -H "Content-Type: application/json" \  -d '{    "optionToken": "stringstringstringst",    "guest": {      "name": "string",      "email": "user@example.com"    }  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "publicId": "f72dfe8e-6cfd-43c2-b1cb-95adbf313789",    "confirmationCode": "string",    "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",    "experienceVersionId": "0f25b13b-77c6-4389-b388-277a7477f3af",    "lifecycle": "string",    "version": 1,    "source": "string",    "businessDate": "string",    "startsAt": "2019-08-24T14:15:22Z",    "endsAt": "2019-08-24T14:15:22Z",    "partySize": 1,    "guest": {      "name": "string",      "email": "user@example.com",      "phone": "string"    },    "booking": {      "method": "string",      "currency": "string",      "subtotalAmount": 0,      "taxAmount": 0,      "totalAmount": 0    },    "confirmedAt": "2019-08-24T14:15:22Z",    "cancelledAt": "2019-08-24T14:15:22Z"  }}

Retrieve a reservation

GET
/tables-api/v1/locations/{locationId}/reservations/{reservationId}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

locationId*string
Formatuuid
reservationId*string
Formatuuid

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/tables-api/v1/locations/497f6eca-6276-4993-bfeb-53cbbbba6f08/reservations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "publicId": "f72dfe8e-6cfd-43c2-b1cb-95adbf313789",    "confirmationCode": "string",    "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",    "experienceVersionId": "0f25b13b-77c6-4389-b388-277a7477f3af",    "lifecycle": "string",    "version": 1,    "source": "string",    "businessDate": "string",    "startsAt": "2019-08-24T14:15:22Z",    "endsAt": "2019-08-24T14:15:22Z",    "partySize": 1,    "guest": {      "name": "string",      "email": "user@example.com",      "phone": "string"    },    "booking": {      "method": "string",      "currency": "string",      "subtotalAmount": 0,      "taxAmount": 0,      "totalAmount": 0    },    "confirmedAt": "2019-08-24T14:15:22Z",    "cancelledAt": "2019-08-24T14:15:22Z"  }}

Cancel a free reservation

POST
/tables-api/v1/locations/{locationId}/reservations/{reservationId}/cancel

Paid reservations require payment resolution through the restaurant dashboard before cancellation.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

locationId*string
Formatuuid
reservationId*string
Formatuuid

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

idempotency-key*string
Length8 <= length <= 180
if-match*string
Match^[1-9]\d*$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/tables-api/v1/locations/497f6eca-6276-4993-bfeb-53cbbbba6f08/reservations/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "idempotency-key: stringst" \  -H "if-match: string" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "publicId": "f72dfe8e-6cfd-43c2-b1cb-95adbf313789",    "confirmationCode": "string",    "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",    "experienceVersionId": "0f25b13b-77c6-4389-b388-277a7477f3af",    "lifecycle": "string",    "version": 1,    "source": "string",    "businessDate": "string",    "startsAt": "2019-08-24T14:15:22Z",    "endsAt": "2019-08-24T14:15:22Z",    "partySize": 1,    "guest": {      "name": "string",      "email": "user@example.com",      "phone": "string"    },    "booking": {      "method": "string",      "currency": "string",      "subtotalAmount": 0,      "taxAmount": 0,      "totalAmount": 0    },    "confirmedAt": "2019-08-24T14:15:22Z",    "cancelledAt": "2019-08-24T14:15:22Z"  }}

List reservations

GET
/reservation

Commerce7 basis: Reservations. This contract-first version models reservation search, filters, and per-record lookup for restaurant and tasting-room flows.

Query Parameters

q?string
page?integer
Range1 <= value
limit?integer
Range1 <= value <= 100

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/reservation" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "reservations": [    {      "id": "string",      "reservationNumber": 0,      "channel": "string",      "externalReservationNumber": "string",      "externalReservationVendor": "string",      "reservationSource": "string",      "customerId": "string",      "reservationDate": "2019-08-24T14:15:22Z",      "reservationCloseOutDate": "2019-08-24T14:15:22Z",      "reservationTypeId": "string",      "reservationTypeOptionId": "string",      "guestCount": 0,      "reservationLocationId": "string",      "reservationLocationTableId": "string",      "reservationStaffId": "string",      "experienceType": "default",      "isRequiresAHost": true,      "status": "Pending",      "paymentStatus": "unpaid",      "paymentCharge": "none",      "lastProcessAttemptDate": "2019-08-24T14:15:22Z",      "orderId": "string",      "orderNumber": 0,      "reservationPaidDate": "2019-08-24T14:15:22Z",      "reminderEmailSendStatus": "pending",      "reminderEmailSendDate": "2019-08-24T14:15:22Z",      "sku": "string",      "price": 0,      "isPriceOverride": true,      "isReservationDateOverride": true,      "isReservationLocationOverride": true,      "isGuestCountOverride": true,      "customerCreditCardId": "string",      "tenderType": "cash",      "reservationThirdPartyId": "string",      "inventoryLocationId": "string",      "notes": "string",      "checkInTime": "2019-08-24T14:15:22Z",      "closeOutTime": "2019-08-24T14:15:22Z",      "systemNote": "string",      "metaData": {        "property1": null,        "property2": null      },      "appData": {        "property1": null,        "property2": null      },      "appSync": {        "property1": null,        "property2": null      },      "flags": [        "string"      ],      "reservationStaff": null,      "reservationType": {        "id": "string",        "title": "string",        "slug": "string",        "status": "active",        "inventoryLocationId": "string",        "reservationLocationId": "string",        "defaultReservationLocationId": "string",        "reservationLocationIds": [          "string"        ],        "type": "string",        "tourType": "string",        "paymentCharge": "none",        "minGuestCount": 0,        "maxGuestCount": 0,        "maxGroupCount": 0,        "minutesAllotted": 0,        "minutesBeforeLocationInUse": 0,        "leadTimeInHours": 0,        "isRequiresAHost": true,        "isAlwaysOccursInDefaultLocation": true,        "allowOnlineCancel": true,        "onlineCancelDeadlineInHours": 0,        "emailInstructions": "string",        "content": "string",        "image": "string",        "seoTitle": "string",        "seoDescription": "string",        "metaData": {          "property1": null,          "property2": null        },        "security": {          "property1": null,          "property2": null        },        "options": [          {            "id": "string",            "reservationTypeId": "string",            "title": "string",            "sku": "string",            "price": 0,            "taxCode": "string",            "sortOrder": 0,            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "timeSlots": [          {            "id": "string",            "reservationTypeId": "string",            "dayOfWeek": 0,            "times": [              {                "id": "string",                "reservationTypeTimeSlotId": "string",                "time": "string",                "allowCustomersToReserveOnline": true,                "createdAt": "2019-08-24T14:15:22Z",                "updatedAt": "2019-08-24T14:15:22Z"              }            ],            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "page": {    "total": 0,    "page": 1,    "limit": 1  }}

Create a reservation

POST
/reservation

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/reservation" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "reservationDate": "2019-08-24T14:15:22Z",    "reservationTypeId": "string",    "guestCount": 0,    "reservationLocationId": "string",    "inventoryLocationId": "string"  }'
{  "id": "string",  "reservationNumber": 0,  "channel": "string",  "externalReservationNumber": "string",  "externalReservationVendor": "string",  "reservationSource": "string",  "customerId": "string",  "reservationDate": "2019-08-24T14:15:22Z",  "reservationCloseOutDate": "2019-08-24T14:15:22Z",  "reservationTypeId": "string",  "reservationTypeOptionId": "string",  "guestCount": 0,  "reservationLocationId": "string",  "reservationLocationTableId": "string",  "reservationStaffId": "string",  "experienceType": "default",  "isRequiresAHost": true,  "status": "Pending",  "paymentStatus": "unpaid",  "paymentCharge": "none",  "lastProcessAttemptDate": "2019-08-24T14:15:22Z",  "orderId": "string",  "orderNumber": 0,  "reservationPaidDate": "2019-08-24T14:15:22Z",  "reminderEmailSendStatus": "pending",  "reminderEmailSendDate": "2019-08-24T14:15:22Z",  "sku": "string",  "price": 0,  "isPriceOverride": true,  "isReservationDateOverride": true,  "isReservationLocationOverride": true,  "isGuestCountOverride": true,  "customerCreditCardId": "string",  "tenderType": "cash",  "reservationThirdPartyId": "string",  "inventoryLocationId": "string",  "notes": "string",  "checkInTime": "2019-08-24T14:15:22Z",  "closeOutTime": "2019-08-24T14:15:22Z",  "systemNote": "string",  "metaData": {    "property1": null,    "property2": null  },  "appData": {    "property1": null,    "property2": null  },  "appSync": {    "property1": null,    "property2": null  },  "flags": [    "string"  ],  "reservationStaff": null,  "reservationType": {    "id": "string",    "title": "string",    "slug": "string",    "status": "active",    "inventoryLocationId": "string",    "reservationLocationId": "string",    "defaultReservationLocationId": "string",    "reservationLocationIds": [      "string"    ],    "type": "string",    "tourType": "string",    "paymentCharge": "none",    "minGuestCount": 0,    "maxGuestCount": 0,    "maxGroupCount": 0,    "minutesAllotted": 0,    "minutesBeforeLocationInUse": 0,    "leadTimeInHours": 0,    "isRequiresAHost": true,    "isAlwaysOccursInDefaultLocation": true,    "allowOnlineCancel": true,    "onlineCancelDeadlineInHours": 0,    "emailInstructions": "string",    "content": "string",    "image": "string",    "seoTitle": "string",    "seoDescription": "string",    "metaData": {      "property1": null,      "property2": null    },    "security": {      "property1": null,      "property2": null    },    "options": [      {        "id": "string",        "reservationTypeId": "string",        "title": "string",        "sku": "string",        "price": 0,        "taxCode": "string",        "sortOrder": 0,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "timeSlots": [      {        "id": "string",        "reservationTypeId": "string",        "dayOfWeek": 0,        "times": [          {            "id": "string",            "reservationTypeTimeSlotId": "string",            "time": "string",            "allowCustomersToReserveOnline": true,            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve a reservation

GET
/reservation/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/reservation/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "reservationNumber": 0,  "channel": "string",  "externalReservationNumber": "string",  "externalReservationVendor": "string",  "reservationSource": "string",  "customerId": "string",  "reservationDate": "2019-08-24T14:15:22Z",  "reservationCloseOutDate": "2019-08-24T14:15:22Z",  "reservationTypeId": "string",  "reservationTypeOptionId": "string",  "guestCount": 0,  "reservationLocationId": "string",  "reservationLocationTableId": "string",  "reservationStaffId": "string",  "experienceType": "default",  "isRequiresAHost": true,  "status": "Pending",  "paymentStatus": "unpaid",  "paymentCharge": "none",  "lastProcessAttemptDate": "2019-08-24T14:15:22Z",  "orderId": "string",  "orderNumber": 0,  "reservationPaidDate": "2019-08-24T14:15:22Z",  "reminderEmailSendStatus": "pending",  "reminderEmailSendDate": "2019-08-24T14:15:22Z",  "sku": "string",  "price": 0,  "isPriceOverride": true,  "isReservationDateOverride": true,  "isReservationLocationOverride": true,  "isGuestCountOverride": true,  "customerCreditCardId": "string",  "tenderType": "cash",  "reservationThirdPartyId": "string",  "inventoryLocationId": "string",  "notes": "string",  "checkInTime": "2019-08-24T14:15:22Z",  "closeOutTime": "2019-08-24T14:15:22Z",  "systemNote": "string",  "metaData": {    "property1": null,    "property2": null  },  "appData": {    "property1": null,    "property2": null  },  "appSync": {    "property1": null,    "property2": null  },  "flags": [    "string"  ],  "reservationStaff": null,  "reservationType": {    "id": "string",    "title": "string",    "slug": "string",    "status": "active",    "inventoryLocationId": "string",    "reservationLocationId": "string",    "defaultReservationLocationId": "string",    "reservationLocationIds": [      "string"    ],    "type": "string",    "tourType": "string",    "paymentCharge": "none",    "minGuestCount": 0,    "maxGuestCount": 0,    "maxGroupCount": 0,    "minutesAllotted": 0,    "minutesBeforeLocationInUse": 0,    "leadTimeInHours": 0,    "isRequiresAHost": true,    "isAlwaysOccursInDefaultLocation": true,    "allowOnlineCancel": true,    "onlineCancelDeadlineInHours": 0,    "emailInstructions": "string",    "content": "string",    "image": "string",    "seoTitle": "string",    "seoDescription": "string",    "metaData": {      "property1": null,      "property2": null    },    "security": {      "property1": null,      "property2": null    },    "options": [      {        "id": "string",        "reservationTypeId": "string",        "title": "string",        "sku": "string",        "price": 0,        "taxCode": "string",        "sortOrder": 0,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "timeSlots": [      {        "id": "string",        "reservationTypeId": "string",        "dayOfWeek": 0,        "times": [          {            "id": "string",            "reservationTypeTimeSlotId": "string",            "time": "string",            "allowCustomersToReserveOnline": true,            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a reservation

DELETE
/reservation/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X DELETE "https://example.com/reservation/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "reservationNumber": 0,  "channel": "string",  "externalReservationNumber": "string",  "externalReservationVendor": "string",  "reservationSource": "string",  "customerId": "string",  "reservationDate": "2019-08-24T14:15:22Z",  "reservationCloseOutDate": "2019-08-24T14:15:22Z",  "reservationTypeId": "string",  "reservationTypeOptionId": "string",  "guestCount": 0,  "reservationLocationId": "string",  "reservationLocationTableId": "string",  "reservationStaffId": "string",  "experienceType": "default",  "isRequiresAHost": true,  "status": "Pending",  "paymentStatus": "unpaid",  "paymentCharge": "none",  "lastProcessAttemptDate": "2019-08-24T14:15:22Z",  "orderId": "string",  "orderNumber": 0,  "reservationPaidDate": "2019-08-24T14:15:22Z",  "reminderEmailSendStatus": "pending",  "reminderEmailSendDate": "2019-08-24T14:15:22Z",  "sku": "string",  "price": 0,  "isPriceOverride": true,  "isReservationDateOverride": true,  "isReservationLocationOverride": true,  "isGuestCountOverride": true,  "customerCreditCardId": "string",  "tenderType": "cash",  "reservationThirdPartyId": "string",  "inventoryLocationId": "string",  "notes": "string",  "checkInTime": "2019-08-24T14:15:22Z",  "closeOutTime": "2019-08-24T14:15:22Z",  "systemNote": "string",  "metaData": {    "property1": null,    "property2": null  },  "appData": {    "property1": null,    "property2": null  },  "appSync": {    "property1": null,    "property2": null  },  "flags": [    "string"  ],  "reservationStaff": null,  "reservationType": {    "id": "string",    "title": "string",    "slug": "string",    "status": "active",    "inventoryLocationId": "string",    "reservationLocationId": "string",    "defaultReservationLocationId": "string",    "reservationLocationIds": [      "string"    ],    "type": "string",    "tourType": "string",    "paymentCharge": "none",    "minGuestCount": 0,    "maxGuestCount": 0,    "maxGroupCount": 0,    "minutesAllotted": 0,    "minutesBeforeLocationInUse": 0,    "leadTimeInHours": 0,    "isRequiresAHost": true,    "isAlwaysOccursInDefaultLocation": true,    "allowOnlineCancel": true,    "onlineCancelDeadlineInHours": 0,    "emailInstructions": "string",    "content": "string",    "image": "string",    "seoTitle": "string",    "seoDescription": "string",    "metaData": {      "property1": null,      "property2": null    },    "security": {      "property1": null,      "property2": null    },    "options": [      {        "id": "string",        "reservationTypeId": "string",        "title": "string",        "sku": "string",        "price": 0,        "taxCode": "string",        "sortOrder": 0,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "timeSlots": [      {        "id": "string",        "reservationTypeId": "string",        "dayOfWeek": 0,        "times": [          {            "id": "string",            "reservationTypeTimeSlotId": "string",            "time": "string",            "allowCustomersToReserveOnline": true,            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update a reservation

PUT
/reservation/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/reservation/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "reservationNumber": 0,  "channel": "string",  "externalReservationNumber": "string",  "externalReservationVendor": "string",  "reservationSource": "string",  "customerId": "string",  "reservationDate": "2019-08-24T14:15:22Z",  "reservationCloseOutDate": "2019-08-24T14:15:22Z",  "reservationTypeId": "string",  "reservationTypeOptionId": "string",  "guestCount": 0,  "reservationLocationId": "string",  "reservationLocationTableId": "string",  "reservationStaffId": "string",  "experienceType": "default",  "isRequiresAHost": true,  "status": "Pending",  "paymentStatus": "unpaid",  "paymentCharge": "none",  "lastProcessAttemptDate": "2019-08-24T14:15:22Z",  "orderId": "string",  "orderNumber": 0,  "reservationPaidDate": "2019-08-24T14:15:22Z",  "reminderEmailSendStatus": "pending",  "reminderEmailSendDate": "2019-08-24T14:15:22Z",  "sku": "string",  "price": 0,  "isPriceOverride": true,  "isReservationDateOverride": true,  "isReservationLocationOverride": true,  "isGuestCountOverride": true,  "customerCreditCardId": "string",  "tenderType": "cash",  "reservationThirdPartyId": "string",  "inventoryLocationId": "string",  "notes": "string",  "checkInTime": "2019-08-24T14:15:22Z",  "closeOutTime": "2019-08-24T14:15:22Z",  "systemNote": "string",  "metaData": {    "property1": null,    "property2": null  },  "appData": {    "property1": null,    "property2": null  },  "appSync": {    "property1": null,    "property2": null  },  "flags": [    "string"  ],  "reservationStaff": null,  "reservationType": {    "id": "string",    "title": "string",    "slug": "string",    "status": "active",    "inventoryLocationId": "string",    "reservationLocationId": "string",    "defaultReservationLocationId": "string",    "reservationLocationIds": [      "string"    ],    "type": "string",    "tourType": "string",    "paymentCharge": "none",    "minGuestCount": 0,    "maxGuestCount": 0,    "maxGroupCount": 0,    "minutesAllotted": 0,    "minutesBeforeLocationInUse": 0,    "leadTimeInHours": 0,    "isRequiresAHost": true,    "isAlwaysOccursInDefaultLocation": true,    "allowOnlineCancel": true,    "onlineCancelDeadlineInHours": 0,    "emailInstructions": "string",    "content": "string",    "image": "string",    "seoTitle": "string",    "seoDescription": "string",    "metaData": {      "property1": null,      "property2": null    },    "security": {      "property1": null,      "property2": null    },    "options": [      {        "id": "string",        "reservationTypeId": "string",        "title": "string",        "sku": "string",        "price": 0,        "taxCode": "string",        "sortOrder": 0,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "timeSlots": [      {        "id": "string",        "reservationTypeId": "string",        "dayOfWeek": 0,        "times": [          {            "id": "string",            "reservationTypeTimeSlotId": "string",            "time": "string",            "allowCustomersToReserveOnline": true,            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Apply a guarded reservation status transition

POST
/reservation/{id}/transition

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

if-match*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/reservation/string/transition" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "if-match: string" \  -H "Content-Type: application/json" \  -d '{    "target": "Pending"  }'
{  "id": "string",  "reservationNumber": 0,  "channel": "string",  "externalReservationNumber": "string",  "externalReservationVendor": "string",  "reservationSource": "string",  "customerId": "string",  "reservationDate": "2019-08-24T14:15:22Z",  "reservationCloseOutDate": "2019-08-24T14:15:22Z",  "reservationTypeId": "string",  "reservationTypeOptionId": "string",  "guestCount": 0,  "reservationLocationId": "string",  "reservationLocationTableId": "string",  "reservationStaffId": "string",  "experienceType": "default",  "isRequiresAHost": true,  "status": "Pending",  "paymentStatus": "unpaid",  "paymentCharge": "none",  "lastProcessAttemptDate": "2019-08-24T14:15:22Z",  "orderId": "string",  "orderNumber": 0,  "reservationPaidDate": "2019-08-24T14:15:22Z",  "reminderEmailSendStatus": "pending",  "reminderEmailSendDate": "2019-08-24T14:15:22Z",  "sku": "string",  "price": 0,  "isPriceOverride": true,  "isReservationDateOverride": true,  "isReservationLocationOverride": true,  "isGuestCountOverride": true,  "customerCreditCardId": "string",  "tenderType": "cash",  "reservationThirdPartyId": "string",  "inventoryLocationId": "string",  "notes": "string",  "checkInTime": "2019-08-24T14:15:22Z",  "closeOutTime": "2019-08-24T14:15:22Z",  "systemNote": "string",  "metaData": {    "property1": null,    "property2": null  },  "appData": {    "property1": null,    "property2": null  },  "appSync": {    "property1": null,    "property2": null  },  "flags": [    "string"  ],  "reservationStaff": null,  "reservationType": {    "id": "string",    "title": "string",    "slug": "string",    "status": "active",    "inventoryLocationId": "string",    "reservationLocationId": "string",    "defaultReservationLocationId": "string",    "reservationLocationIds": [      "string"    ],    "type": "string",    "tourType": "string",    "paymentCharge": "none",    "minGuestCount": 0,    "maxGuestCount": 0,    "maxGroupCount": 0,    "minutesAllotted": 0,    "minutesBeforeLocationInUse": 0,    "leadTimeInHours": 0,    "isRequiresAHost": true,    "isAlwaysOccursInDefaultLocation": true,    "allowOnlineCancel": true,    "onlineCancelDeadlineInHours": 0,    "emailInstructions": "string",    "content": "string",    "image": "string",    "seoTitle": "string",    "seoDescription": "string",    "metaData": {      "property1": null,      "property2": null    },    "security": {      "property1": null,      "property2": null    },    "options": [      {        "id": "string",        "reservationTypeId": "string",        "title": "string",        "sku": "string",        "price": 0,        "taxCode": "string",        "sortOrder": 0,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "timeSlots": [      {        "id": "string",        "reservationTypeId": "string",        "dayOfWeek": 0,        "times": [          {            "id": "string",            "reservationTypeTimeSlotId": "string",            "time": "string",            "allowCustomersToReserveOnline": true,            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List reservation types

GET
/reservation-type

Query Parameters

q?string
page?integer
Range1 <= value
limit?integer
Range1 <= value <= 100

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/reservation-type" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "reservationTypes": [    {      "id": "string",      "title": "string",      "slug": "string",      "status": "active",      "inventoryLocationId": "string",      "reservationLocationId": "string",      "defaultReservationLocationId": "string",      "reservationLocationIds": [        "string"      ],      "type": "string",      "tourType": "string",      "paymentCharge": "none",      "minGuestCount": 0,      "maxGuestCount": 0,      "maxGroupCount": 0,      "minutesAllotted": 0,      "minutesBeforeLocationInUse": 0,      "leadTimeInHours": 0,      "isRequiresAHost": true,      "isAlwaysOccursInDefaultLocation": true,      "allowOnlineCancel": true,      "onlineCancelDeadlineInHours": 0,      "emailInstructions": "string",      "content": "string",      "image": "string",      "seoTitle": "string",      "seoDescription": "string",      "metaData": {        "property1": null,        "property2": null      },      "security": {        "property1": null,        "property2": null      },      "options": [        {          "id": "string",          "reservationTypeId": "string",          "title": "string",          "sku": "string",          "price": 0,          "taxCode": "string",          "sortOrder": 0,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "timeSlots": [        {          "id": "string",          "reservationTypeId": "string",          "dayOfWeek": 0,          "times": [            {              "id": "string",              "reservationTypeTimeSlotId": "string",              "time": "string",              "allowCustomersToReserveOnline": true,              "createdAt": "2019-08-24T14:15:22Z",              "updatedAt": "2019-08-24T14:15:22Z"            }          ],          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "page": {    "total": 0,    "page": 1,    "limit": 1  }}

Create a reservation type

POST
/reservation-type

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/reservation-type" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "inventoryLocationId": "string",    "type": "string"  }'
{  "id": "string",  "title": "string",  "slug": "string",  "status": "active",  "inventoryLocationId": "string",  "reservationLocationId": "string",  "defaultReservationLocationId": "string",  "reservationLocationIds": [    "string"  ],  "type": "string",  "tourType": "string",  "paymentCharge": "none",  "minGuestCount": 0,  "maxGuestCount": 0,  "maxGroupCount": 0,  "minutesAllotted": 0,  "minutesBeforeLocationInUse": 0,  "leadTimeInHours": 0,  "isRequiresAHost": true,  "isAlwaysOccursInDefaultLocation": true,  "allowOnlineCancel": true,  "onlineCancelDeadlineInHours": 0,  "emailInstructions": "string",  "content": "string",  "image": "string",  "seoTitle": "string",  "seoDescription": "string",  "metaData": {    "property1": null,    "property2": null  },  "security": {    "property1": null,    "property2": null  },  "options": [    {      "id": "string",      "reservationTypeId": "string",      "title": "string",      "sku": "string",      "price": 0,      "taxCode": "string",      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "timeSlots": [    {      "id": "string",      "reservationTypeId": "string",      "dayOfWeek": 0,      "times": [        {          "id": "string",          "reservationTypeTimeSlotId": "string",          "time": "string",          "allowCustomersToReserveOnline": true,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve a reservation type

GET
/reservation-type/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/reservation-type/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "title": "string",  "slug": "string",  "status": "active",  "inventoryLocationId": "string",  "reservationLocationId": "string",  "defaultReservationLocationId": "string",  "reservationLocationIds": [    "string"  ],  "type": "string",  "tourType": "string",  "paymentCharge": "none",  "minGuestCount": 0,  "maxGuestCount": 0,  "maxGroupCount": 0,  "minutesAllotted": 0,  "minutesBeforeLocationInUse": 0,  "leadTimeInHours": 0,  "isRequiresAHost": true,  "isAlwaysOccursInDefaultLocation": true,  "allowOnlineCancel": true,  "onlineCancelDeadlineInHours": 0,  "emailInstructions": "string",  "content": "string",  "image": "string",  "seoTitle": "string",  "seoDescription": "string",  "metaData": {    "property1": null,    "property2": null  },  "security": {    "property1": null,    "property2": null  },  "options": [    {      "id": "string",      "reservationTypeId": "string",      "title": "string",      "sku": "string",      "price": 0,      "taxCode": "string",      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "timeSlots": [    {      "id": "string",      "reservationTypeId": "string",      "dayOfWeek": 0,      "times": [        {          "id": "string",          "reservationTypeTimeSlotId": "string",          "time": "string",          "allowCustomersToReserveOnline": true,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a reservation type

DELETE
/reservation-type/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X DELETE "https://example.com/reservation-type/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "title": "string",  "slug": "string",  "status": "active",  "inventoryLocationId": "string",  "reservationLocationId": "string",  "defaultReservationLocationId": "string",  "reservationLocationIds": [    "string"  ],  "type": "string",  "tourType": "string",  "paymentCharge": "none",  "minGuestCount": 0,  "maxGuestCount": 0,  "maxGroupCount": 0,  "minutesAllotted": 0,  "minutesBeforeLocationInUse": 0,  "leadTimeInHours": 0,  "isRequiresAHost": true,  "isAlwaysOccursInDefaultLocation": true,  "allowOnlineCancel": true,  "onlineCancelDeadlineInHours": 0,  "emailInstructions": "string",  "content": "string",  "image": "string",  "seoTitle": "string",  "seoDescription": "string",  "metaData": {    "property1": null,    "property2": null  },  "security": {    "property1": null,    "property2": null  },  "options": [    {      "id": "string",      "reservationTypeId": "string",      "title": "string",      "sku": "string",      "price": 0,      "taxCode": "string",      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "timeSlots": [    {      "id": "string",      "reservationTypeId": "string",      "dayOfWeek": 0,      "times": [        {          "id": "string",          "reservationTypeTimeSlotId": "string",          "time": "string",          "allowCustomersToReserveOnline": true,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update a reservation type

PUT
/reservation-type/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/reservation-type/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "title": "string",  "slug": "string",  "status": "active",  "inventoryLocationId": "string",  "reservationLocationId": "string",  "defaultReservationLocationId": "string",  "reservationLocationIds": [    "string"  ],  "type": "string",  "tourType": "string",  "paymentCharge": "none",  "minGuestCount": 0,  "maxGuestCount": 0,  "maxGroupCount": 0,  "minutesAllotted": 0,  "minutesBeforeLocationInUse": 0,  "leadTimeInHours": 0,  "isRequiresAHost": true,  "isAlwaysOccursInDefaultLocation": true,  "allowOnlineCancel": true,  "onlineCancelDeadlineInHours": 0,  "emailInstructions": "string",  "content": "string",  "image": "string",  "seoTitle": "string",  "seoDescription": "string",  "metaData": {    "property1": null,    "property2": null  },  "security": {    "property1": null,    "property2": null  },  "options": [    {      "id": "string",      "reservationTypeId": "string",      "title": "string",      "sku": "string",      "price": 0,      "taxCode": "string",      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "timeSlots": [    {      "id": "string",      "reservationTypeId": "string",      "dayOfWeek": 0,      "times": [        {          "id": "string",          "reservationTypeTimeSlotId": "string",          "time": "string",          "allowCustomersToReserveOnline": true,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Promotions

Previous Page

Restaurant

Next Page