TrellisDevelopers
API reference

Restaurant

Get restaurant branding assets for a location

GET
/restaurant/branding

Query Parameters

locationId*string

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/restaurant/branding?locationId=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"
{  "tenantId": "string",  "locationId": "string",  "logoAssetId": "string",  "receiptLogoAssetId": "string",  "bannerAssetId": "string",  "primaryColor": "string",  "secondaryColor": "string",  "accentColor": "string",  "metadata": {    "property1": null,    "property2": null  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update restaurant branding assets for a location

PUT
/restaurant/branding

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/restaurant/branding" \  -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 '{    "locationId": "string"  }'
{  "tenantId": "string",  "locationId": "string",  "logoAssetId": "string",  "receiptLogoAssetId": "string",  "bannerAssetId": "string",  "primaryColor": "string",  "secondaryColor": "string",  "accentColor": "string",  "metadata": {    "property1": null,    "property2": null  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Assign or transfer an order to a dining table

POST
/orders/{id}/table-assignment

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 POST "https://example.com/orders/string/table-assignment" \  -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 '{    "tableId": "string"  }'
{  "id": "string",  "orderNumber": 0,  "customerId": "string",  "customerName": "string",  "guestName": "string",  "locationId": "string",  "assignedStaffUserId": "string",  "status": "draft",  "source": "pos",  "fulfillmentMode": "dine_in",  "tableId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "tableLabel": "string",  "seatCount": 0,  "note": "string",  "fundraising": {    "campaignId": "string",    "campaignCode": "string",    "campaignName": "string",    "causeName": "string",    "contributionType": "round_up",    "contributionValue": 0,    "contributionAmountCents": 0  },  "lineItems": [    {      "id": "string",      "lineType": "catalog",      "sendStatus": "new",      "productId": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "taxCode": "food",      "category": "string",      "salesCategory": "string",      "openItemScope": "food",      "pricingStrategyApplied": "base",      "menuId": "string",      "sizeName": "string",      "seatId": "string",      "seatNumber": 1,      "course": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "prepTimeSeconds": 0,      "modifiers": [        {          "productId": "string",          "title": "string",          "priceDelta": 0,          "quantity": 1,          "groupId": "string",          "groupTitle": "string",          "portionId": "string",          "portionLabel": "string",          "portionPriceMultiplier": 0,          "pricingStrategy": "no_charge",          "openPriceAmount": 0,          "sizeName": "string",          "sequenceOrdinal": 1,          "preModifierOptionId": "string",          "preModifierLabel": "string",          "preModifierPosition": "prefix",          "displayLabel": "string",          "defaultApplied": true,          "modifiers": [            null          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "immediatePrepStationIds": [              "string"            ],            "modifierRouting": "with_parent",            "ticketDestination": "prep_only",            "appliedRuleIds": [              "string"            ]          }        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "immediatePrepStationIds": [          "string"        ],        "modifierRouting": "with_parent",        "ticketDestination": "prep_only",        "appliedRuleIds": [          "string"        ]      },      "voidReasonId": "string",      "voidReasonName": "string",      "voidedAt": "string",      "voidedByStaffUserId": "string",      "voidedByStaffName": "string",      "giftCardSale": {        "cardType": "Physical",        "code": "string",        "recipientName": "string",        "recipientEmail": "string",        "recipientPhone": "string",        "fromName": "string",        "purchaserEmail": "string",        "purchaserPhone": "string",        "giftMessage": "string",        "notes": "string",        "deliveryChannel": "email",        "deliveryDestination": "string",        "deliveryScheduledAt": "2019-08-24T14:15:22Z",        "notifyPurchaserWhenOpened": true      }    }  ],  "appliedDiscounts": [    {      "id": "string",      "sourceType": "promotion",      "sourceId": "string",      "code": "string",      "title": "string",      "scope": "order",      "lineItemId": "string",      "actionMessage": "string",      "appliesTo": "Store",      "appliesToObjectIds": [        "string"      ],      "combinability": "combinable",      "stackingScope": "order",      "requiresManagerApproval": true,      "managerApprovedByStaffUserId": "string",      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "eligibilitySummary": "string",      "discountType": "amount",      "value": 0,      "amount": 0    }  ],  "subtotal": 0,  "discountTotal": 0,  "taxTotal": 0,  "tipTotal": 0,  "total": 0,  "balanceDue": 0,  "paymentIntentIds": [    "string"  ],  "submittedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "offPremise": {    "channel": {      "kind": "first_party",      "provider": "string"    },    "customer": {      "customerId": "string",      "firstName": "string",      "lastName": "string",      "phone": "string",      "email": "user@example.com"    },    "quote": {      "strategy": "manual",      "quoteTimeApplies": true,      "quotedAt": "2019-08-24T14:15:22Z",      "scheduledFor": "2019-08-24T14:15:22Z",      "promisedFulfillmentAt": "2019-08-24T14:15:22Z",      "takeoutQuoteMinutes": 0,      "deliveryQuoteMinutes": 0,      "takeoutThrottlingMinutes": 0,      "deliveryThrottlingMinutes": 0,      "throttlingAppliedMinutes": 0,      "leadTimeHours": 0,      "minimumLeadTimeSatisfied": true,      "withinConfiguredOrderingHours": true,      "quoteExemptionReason": "third_party_channel"    },    "readyAt": "2019-08-24T14:15:22Z",    "staging": {      "state": "pending",      "batchId": "string",      "batchLabel": "string",      "stagingArea": "string",      "stagingSlot": "string",      "handoffZone": "string",      "batchReadyAt": "2019-08-24T14:15:22Z",      "stagedAt": "2019-08-24T14:15:22Z",      "readyBy": {        "staffUserId": "string",        "displayName": "string"      }    },    "guestMessaging": {      "enabled": true,      "preferredChannel": "sms",      "notifications": [        {          "event": "batch_ready",          "template": "order_ready",          "channel": "sms",          "status": "pending",          "recipient": "string",          "subject": "string",          "body": "string",          "updatedAt": "2019-08-24T14:15:22Z",          "sentAt": "2019-08-24T14:15:22Z",          "failureReason": "string"        }      ],      "lastUpdatedAt": "2019-08-24T14:15:22Z"    },    "pickup": {      "kind": "standard",      "state": "pending",      "stagedAt": "2019-08-24T14:15:22Z",      "arrivedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "curbside": {        "vehicleMakeModel": "string",        "vehicleColor": "string",        "instructions": "string",        "parkingSpot": "string",        "arrivalNote": "string"      }    },    "delivery": {      "addressId": "string",      "addressLabel": "string",      "state": "pending",      "instructions": "string",      "deliveryNotes": "string",      "stagedAt": "2019-08-24T14:15:22Z",      "dispatchedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "dispatchNote": "string",      "dispatch": {        "assignmentMode": "unassigned",        "assignedDriver": {          "staffUserId": "string",          "displayName": "string"        },        "dispatchedBy": {          "staffUserId": "string",          "displayName": "string"        },        "courierName": "string",        "courierPhone": "string",        "vehicleLabel": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Split a check by seat or selected items

POST
/orders/{id}/checks/split

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 POST "https://example.com/orders/string/checks/split" \  -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 '{    "mode": "seat"  }'
{  "sourceOrder": {    "id": "string",    "orderNumber": 0,    "customerId": "string",    "customerName": "string",    "guestName": "string",    "locationId": "string",    "assignedStaffUserId": "string",    "status": "draft",    "source": "pos",    "fulfillmentMode": "dine_in",    "tableId": "string",    "sectionId": "string",    "serviceAreaId": "string",    "tableLabel": "string",    "seatCount": 0,    "note": "string",    "fundraising": {      "campaignId": "string",      "campaignCode": "string",      "campaignName": "string",      "causeName": "string",      "contributionType": "round_up",      "contributionValue": 0,      "contributionAmountCents": 0    },    "lineItems": [      {        "id": "string",        "lineType": "catalog",        "sendStatus": "new",        "productId": "string",        "title": "string",        "quantity": 1,        "unitPrice": 0,        "taxRateBps": 0,        "taxCode": "food",        "category": "string",        "salesCategory": "string",        "openItemScope": "food",        "pricingStrategyApplied": "base",        "menuId": "string",        "sizeName": "string",        "seatId": "string",        "seatNumber": 1,        "course": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "prepTimeSeconds": 0,        "modifiers": [          {            "productId": "string",            "title": "string",            "priceDelta": 0,            "quantity": 1,            "groupId": "string",            "groupTitle": "string",            "portionId": "string",            "portionLabel": "string",            "portionPriceMultiplier": 0,            "pricingStrategy": "no_charge",            "openPriceAmount": 0,            "sizeName": "string",            "sequenceOrdinal": 1,            "preModifierOptionId": "string",            "preModifierLabel": "string",            "preModifierPosition": "prefix",            "displayLabel": "string",            "defaultApplied": true,            "modifiers": [              null            ],            "routing": {              "prepStationIds": [                "string"              ],              "assemblyLineId": "string",              "immediatePrepStationIds": [                "string"              ],              "modifierRouting": "with_parent",              "ticketDestination": "prep_only",              "appliedRuleIds": [                "string"              ]            }          }        ],        "routing": {          "prepStationIds": [            "string"          ],          "assemblyLineId": "string",          "immediatePrepStationIds": [            "string"          ],          "modifierRouting": "with_parent",          "ticketDestination": "prep_only",          "appliedRuleIds": [            "string"          ]        },        "voidReasonId": "string",        "voidReasonName": "string",        "voidedAt": "string",        "voidedByStaffUserId": "string",        "voidedByStaffName": "string",        "giftCardSale": {          "cardType": "Physical",          "code": "string",          "recipientName": "string",          "recipientEmail": "string",          "recipientPhone": "string",          "fromName": "string",          "purchaserEmail": "string",          "purchaserPhone": "string",          "giftMessage": "string",          "notes": "string",          "deliveryChannel": "email",          "deliveryDestination": "string",          "deliveryScheduledAt": "2019-08-24T14:15:22Z",          "notifyPurchaserWhenOpened": true        }      }    ],    "appliedDiscounts": [      {        "id": "string",        "sourceType": "promotion",        "sourceId": "string",        "code": "string",        "title": "string",        "scope": "order",        "lineItemId": "string",        "actionMessage": "string",        "appliesTo": "Store",        "appliesToObjectIds": [          "string"        ],        "combinability": "combinable",        "stackingScope": "order",        "requiresManagerApproval": true,        "managerApprovedByStaffUserId": "string",        "excludesServiceCharges": true,        "serviceChargeInteraction": "pre_discount",        "eligibilitySummary": "string",        "discountType": "amount",        "value": 0,        "amount": 0      }    ],    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "tipTotal": 0,    "total": 0,    "balanceDue": 0,    "paymentIntentIds": [      "string"    ],    "submittedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "offPremise": {      "channel": {        "kind": "first_party",        "provider": "string"      },      "customer": {        "customerId": "string",        "firstName": "string",        "lastName": "string",        "phone": "string",        "email": "user@example.com"      },      "quote": {        "strategy": "manual",        "quoteTimeApplies": true,        "quotedAt": "2019-08-24T14:15:22Z",        "scheduledFor": "2019-08-24T14:15:22Z",        "promisedFulfillmentAt": "2019-08-24T14:15:22Z",        "takeoutQuoteMinutes": 0,        "deliveryQuoteMinutes": 0,        "takeoutThrottlingMinutes": 0,        "deliveryThrottlingMinutes": 0,        "throttlingAppliedMinutes": 0,        "leadTimeHours": 0,        "minimumLeadTimeSatisfied": true,        "withinConfiguredOrderingHours": true,        "quoteExemptionReason": "third_party_channel"      },      "readyAt": "2019-08-24T14:15:22Z",      "staging": {        "state": "pending",        "batchId": "string",        "batchLabel": "string",        "stagingArea": "string",        "stagingSlot": "string",        "handoffZone": "string",        "batchReadyAt": "2019-08-24T14:15:22Z",        "stagedAt": "2019-08-24T14:15:22Z",        "readyBy": {          "staffUserId": "string",          "displayName": "string"        }      },      "guestMessaging": {        "enabled": true,        "preferredChannel": "sms",        "notifications": [          {            "event": "batch_ready",            "template": "order_ready",            "channel": "sms",            "status": "pending",            "recipient": "string",            "subject": "string",            "body": "string",            "updatedAt": "2019-08-24T14:15:22Z",            "sentAt": "2019-08-24T14:15:22Z",            "failureReason": "string"          }        ],        "lastUpdatedAt": "2019-08-24T14:15:22Z"      },      "pickup": {        "kind": "standard",        "state": "pending",        "stagedAt": "2019-08-24T14:15:22Z",        "arrivedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "curbside": {          "vehicleMakeModel": "string",          "vehicleColor": "string",          "instructions": "string",          "parkingSpot": "string",          "arrivalNote": "string"        }      },      "delivery": {        "addressId": "string",        "addressLabel": "string",        "state": "pending",        "instructions": "string",        "deliveryNotes": "string",        "stagedAt": "2019-08-24T14:15:22Z",        "dispatchedAt": "2019-08-24T14:15:22Z",        "deliveredAt": "2019-08-24T14:15:22Z",        "dispatchNote": "string",        "dispatch": {          "assignmentMode": "unassigned",          "assignedDriver": {            "staffUserId": "string",            "displayName": "string"          },          "dispatchedBy": {            "staffUserId": "string",            "displayName": "string"          },          "courierName": "string",          "courierPhone": "string",          "vehicleLabel": "string",          "assignedAt": "2019-08-24T14:15:22Z"        }      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  },  "splitOrder": {    "id": "string",    "orderNumber": 0,    "customerId": "string",    "customerName": "string",    "guestName": "string",    "locationId": "string",    "assignedStaffUserId": "string",    "status": "draft",    "source": "pos",    "fulfillmentMode": "dine_in",    "tableId": "string",    "sectionId": "string",    "serviceAreaId": "string",    "tableLabel": "string",    "seatCount": 0,    "note": "string",    "fundraising": {      "campaignId": "string",      "campaignCode": "string",      "campaignName": "string",      "causeName": "string",      "contributionType": "round_up",      "contributionValue": 0,      "contributionAmountCents": 0    },    "lineItems": [      {        "id": "string",        "lineType": "catalog",        "sendStatus": "new",        "productId": "string",        "title": "string",        "quantity": 1,        "unitPrice": 0,        "taxRateBps": 0,        "taxCode": "food",        "category": "string",        "salesCategory": "string",        "openItemScope": "food",        "pricingStrategyApplied": "base",        "menuId": "string",        "sizeName": "string",        "seatId": "string",        "seatNumber": 1,        "course": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "prepTimeSeconds": 0,        "modifiers": [          {            "productId": "string",            "title": "string",            "priceDelta": 0,            "quantity": 1,            "groupId": "string",            "groupTitle": "string",            "portionId": "string",            "portionLabel": "string",            "portionPriceMultiplier": 0,            "pricingStrategy": "no_charge",            "openPriceAmount": 0,            "sizeName": "string",            "sequenceOrdinal": 1,            "preModifierOptionId": "string",            "preModifierLabel": "string",            "preModifierPosition": "prefix",            "displayLabel": "string",            "defaultApplied": true,            "modifiers": [              null            ],            "routing": {              "prepStationIds": [                "string"              ],              "assemblyLineId": "string",              "immediatePrepStationIds": [                "string"              ],              "modifierRouting": "with_parent",              "ticketDestination": "prep_only",              "appliedRuleIds": [                "string"              ]            }          }        ],        "routing": {          "prepStationIds": [            "string"          ],          "assemblyLineId": "string",          "immediatePrepStationIds": [            "string"          ],          "modifierRouting": "with_parent",          "ticketDestination": "prep_only",          "appliedRuleIds": [            "string"          ]        },        "voidReasonId": "string",        "voidReasonName": "string",        "voidedAt": "string",        "voidedByStaffUserId": "string",        "voidedByStaffName": "string",        "giftCardSale": {          "cardType": "Physical",          "code": "string",          "recipientName": "string",          "recipientEmail": "string",          "recipientPhone": "string",          "fromName": "string",          "purchaserEmail": "string",          "purchaserPhone": "string",          "giftMessage": "string",          "notes": "string",          "deliveryChannel": "email",          "deliveryDestination": "string",          "deliveryScheduledAt": "2019-08-24T14:15:22Z",          "notifyPurchaserWhenOpened": true        }      }    ],    "appliedDiscounts": [      {        "id": "string",        "sourceType": "promotion",        "sourceId": "string",        "code": "string",        "title": "string",        "scope": "order",        "lineItemId": "string",        "actionMessage": "string",        "appliesTo": "Store",        "appliesToObjectIds": [          "string"        ],        "combinability": "combinable",        "stackingScope": "order",        "requiresManagerApproval": true,        "managerApprovedByStaffUserId": "string",        "excludesServiceCharges": true,        "serviceChargeInteraction": "pre_discount",        "eligibilitySummary": "string",        "discountType": "amount",        "value": 0,        "amount": 0      }    ],    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "tipTotal": 0,    "total": 0,    "balanceDue": 0,    "paymentIntentIds": [      "string"    ],    "submittedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "offPremise": {      "channel": {        "kind": "first_party",        "provider": "string"      },      "customer": {        "customerId": "string",        "firstName": "string",        "lastName": "string",        "phone": "string",        "email": "user@example.com"      },      "quote": {        "strategy": "manual",        "quoteTimeApplies": true,        "quotedAt": "2019-08-24T14:15:22Z",        "scheduledFor": "2019-08-24T14:15:22Z",        "promisedFulfillmentAt": "2019-08-24T14:15:22Z",        "takeoutQuoteMinutes": 0,        "deliveryQuoteMinutes": 0,        "takeoutThrottlingMinutes": 0,        "deliveryThrottlingMinutes": 0,        "throttlingAppliedMinutes": 0,        "leadTimeHours": 0,        "minimumLeadTimeSatisfied": true,        "withinConfiguredOrderingHours": true,        "quoteExemptionReason": "third_party_channel"      },      "readyAt": "2019-08-24T14:15:22Z",      "staging": {        "state": "pending",        "batchId": "string",        "batchLabel": "string",        "stagingArea": "string",        "stagingSlot": "string",        "handoffZone": "string",        "batchReadyAt": "2019-08-24T14:15:22Z",        "stagedAt": "2019-08-24T14:15:22Z",        "readyBy": {          "staffUserId": "string",          "displayName": "string"        }      },      "guestMessaging": {        "enabled": true,        "preferredChannel": "sms",        "notifications": [          {            "event": "batch_ready",            "template": "order_ready",            "channel": "sms",            "status": "pending",            "recipient": "string",            "subject": "string",            "body": "string",            "updatedAt": "2019-08-24T14:15:22Z",            "sentAt": "2019-08-24T14:15:22Z",            "failureReason": "string"          }        ],        "lastUpdatedAt": "2019-08-24T14:15:22Z"      },      "pickup": {        "kind": "standard",        "state": "pending",        "stagedAt": "2019-08-24T14:15:22Z",        "arrivedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "curbside": {          "vehicleMakeModel": "string",          "vehicleColor": "string",          "instructions": "string",          "parkingSpot": "string",          "arrivalNote": "string"        }      },      "delivery": {        "addressId": "string",        "addressLabel": "string",        "state": "pending",        "instructions": "string",        "deliveryNotes": "string",        "stagedAt": "2019-08-24T14:15:22Z",        "dispatchedAt": "2019-08-24T14:15:22Z",        "deliveredAt": "2019-08-24T14:15:22Z",        "dispatchNote": "string",        "dispatch": {          "assignmentMode": "unassigned",          "assignedDriver": {            "staffUserId": "string",            "displayName": "string"          },          "dispatchedBy": {            "staffUserId": "string",            "displayName": "string"          },          "courierName": "string",          "courierPhone": "string",          "vehicleLabel": "string",          "assignedAt": "2019-08-24T14:15:22Z"        }      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  }}

Move selected items from one check to another

POST
/orders/{id}/checks/move-items

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 POST "https://example.com/orders/string/checks/move-items" \  -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 '{    "targetOrderId": "string",    "lineItems": [      {        "lineItemId": "string"      }    ]  }'
{  "sourceOrder": {    "id": "string",    "orderNumber": 0,    "customerId": "string",    "customerName": "string",    "guestName": "string",    "locationId": "string",    "assignedStaffUserId": "string",    "status": "draft",    "source": "pos",    "fulfillmentMode": "dine_in",    "tableId": "string",    "sectionId": "string",    "serviceAreaId": "string",    "tableLabel": "string",    "seatCount": 0,    "note": "string",    "fundraising": {      "campaignId": "string",      "campaignCode": "string",      "campaignName": "string",      "causeName": "string",      "contributionType": "round_up",      "contributionValue": 0,      "contributionAmountCents": 0    },    "lineItems": [      {        "id": "string",        "lineType": "catalog",        "sendStatus": "new",        "productId": "string",        "title": "string",        "quantity": 1,        "unitPrice": 0,        "taxRateBps": 0,        "taxCode": "food",        "category": "string",        "salesCategory": "string",        "openItemScope": "food",        "pricingStrategyApplied": "base",        "menuId": "string",        "sizeName": "string",        "seatId": "string",        "seatNumber": 1,        "course": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "prepTimeSeconds": 0,        "modifiers": [          {            "productId": "string",            "title": "string",            "priceDelta": 0,            "quantity": 1,            "groupId": "string",            "groupTitle": "string",            "portionId": "string",            "portionLabel": "string",            "portionPriceMultiplier": 0,            "pricingStrategy": "no_charge",            "openPriceAmount": 0,            "sizeName": "string",            "sequenceOrdinal": 1,            "preModifierOptionId": "string",            "preModifierLabel": "string",            "preModifierPosition": "prefix",            "displayLabel": "string",            "defaultApplied": true,            "modifiers": [              null            ],            "routing": {              "prepStationIds": [                "string"              ],              "assemblyLineId": "string",              "immediatePrepStationIds": [                "string"              ],              "modifierRouting": "with_parent",              "ticketDestination": "prep_only",              "appliedRuleIds": [                "string"              ]            }          }        ],        "routing": {          "prepStationIds": [            "string"          ],          "assemblyLineId": "string",          "immediatePrepStationIds": [            "string"          ],          "modifierRouting": "with_parent",          "ticketDestination": "prep_only",          "appliedRuleIds": [            "string"          ]        },        "voidReasonId": "string",        "voidReasonName": "string",        "voidedAt": "string",        "voidedByStaffUserId": "string",        "voidedByStaffName": "string",        "giftCardSale": {          "cardType": "Physical",          "code": "string",          "recipientName": "string",          "recipientEmail": "string",          "recipientPhone": "string",          "fromName": "string",          "purchaserEmail": "string",          "purchaserPhone": "string",          "giftMessage": "string",          "notes": "string",          "deliveryChannel": "email",          "deliveryDestination": "string",          "deliveryScheduledAt": "2019-08-24T14:15:22Z",          "notifyPurchaserWhenOpened": true        }      }    ],    "appliedDiscounts": [      {        "id": "string",        "sourceType": "promotion",        "sourceId": "string",        "code": "string",        "title": "string",        "scope": "order",        "lineItemId": "string",        "actionMessage": "string",        "appliesTo": "Store",        "appliesToObjectIds": [          "string"        ],        "combinability": "combinable",        "stackingScope": "order",        "requiresManagerApproval": true,        "managerApprovedByStaffUserId": "string",        "excludesServiceCharges": true,        "serviceChargeInteraction": "pre_discount",        "eligibilitySummary": "string",        "discountType": "amount",        "value": 0,        "amount": 0      }    ],    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "tipTotal": 0,    "total": 0,    "balanceDue": 0,    "paymentIntentIds": [      "string"    ],    "submittedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "offPremise": {      "channel": {        "kind": "first_party",        "provider": "string"      },      "customer": {        "customerId": "string",        "firstName": "string",        "lastName": "string",        "phone": "string",        "email": "user@example.com"      },      "quote": {        "strategy": "manual",        "quoteTimeApplies": true,        "quotedAt": "2019-08-24T14:15:22Z",        "scheduledFor": "2019-08-24T14:15:22Z",        "promisedFulfillmentAt": "2019-08-24T14:15:22Z",        "takeoutQuoteMinutes": 0,        "deliveryQuoteMinutes": 0,        "takeoutThrottlingMinutes": 0,        "deliveryThrottlingMinutes": 0,        "throttlingAppliedMinutes": 0,        "leadTimeHours": 0,        "minimumLeadTimeSatisfied": true,        "withinConfiguredOrderingHours": true,        "quoteExemptionReason": "third_party_channel"      },      "readyAt": "2019-08-24T14:15:22Z",      "staging": {        "state": "pending",        "batchId": "string",        "batchLabel": "string",        "stagingArea": "string",        "stagingSlot": "string",        "handoffZone": "string",        "batchReadyAt": "2019-08-24T14:15:22Z",        "stagedAt": "2019-08-24T14:15:22Z",        "readyBy": {          "staffUserId": "string",          "displayName": "string"        }      },      "guestMessaging": {        "enabled": true,        "preferredChannel": "sms",        "notifications": [          {            "event": "batch_ready",            "template": "order_ready",            "channel": "sms",            "status": "pending",            "recipient": "string",            "subject": "string",            "body": "string",            "updatedAt": "2019-08-24T14:15:22Z",            "sentAt": "2019-08-24T14:15:22Z",            "failureReason": "string"          }        ],        "lastUpdatedAt": "2019-08-24T14:15:22Z"      },      "pickup": {        "kind": "standard",        "state": "pending",        "stagedAt": "2019-08-24T14:15:22Z",        "arrivedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "curbside": {          "vehicleMakeModel": "string",          "vehicleColor": "string",          "instructions": "string",          "parkingSpot": "string",          "arrivalNote": "string"        }      },      "delivery": {        "addressId": "string",        "addressLabel": "string",        "state": "pending",        "instructions": "string",        "deliveryNotes": "string",        "stagedAt": "2019-08-24T14:15:22Z",        "dispatchedAt": "2019-08-24T14:15:22Z",        "deliveredAt": "2019-08-24T14:15:22Z",        "dispatchNote": "string",        "dispatch": {          "assignmentMode": "unassigned",          "assignedDriver": {            "staffUserId": "string",            "displayName": "string"          },          "dispatchedBy": {            "staffUserId": "string",            "displayName": "string"          },          "courierName": "string",          "courierPhone": "string",          "vehicleLabel": "string",          "assignedAt": "2019-08-24T14:15:22Z"        }      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  },  "targetOrder": {    "id": "string",    "orderNumber": 0,    "customerId": "string",    "customerName": "string",    "guestName": "string",    "locationId": "string",    "assignedStaffUserId": "string",    "status": "draft",    "source": "pos",    "fulfillmentMode": "dine_in",    "tableId": "string",    "sectionId": "string",    "serviceAreaId": "string",    "tableLabel": "string",    "seatCount": 0,    "note": "string",    "fundraising": {      "campaignId": "string",      "campaignCode": "string",      "campaignName": "string",      "causeName": "string",      "contributionType": "round_up",      "contributionValue": 0,      "contributionAmountCents": 0    },    "lineItems": [      {        "id": "string",        "lineType": "catalog",        "sendStatus": "new",        "productId": "string",        "title": "string",        "quantity": 1,        "unitPrice": 0,        "taxRateBps": 0,        "taxCode": "food",        "category": "string",        "salesCategory": "string",        "openItemScope": "food",        "pricingStrategyApplied": "base",        "menuId": "string",        "sizeName": "string",        "seatId": "string",        "seatNumber": 1,        "course": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "prepTimeSeconds": 0,        "modifiers": [          {            "productId": "string",            "title": "string",            "priceDelta": 0,            "quantity": 1,            "groupId": "string",            "groupTitle": "string",            "portionId": "string",            "portionLabel": "string",            "portionPriceMultiplier": 0,            "pricingStrategy": "no_charge",            "openPriceAmount": 0,            "sizeName": "string",            "sequenceOrdinal": 1,            "preModifierOptionId": "string",            "preModifierLabel": "string",            "preModifierPosition": "prefix",            "displayLabel": "string",            "defaultApplied": true,            "modifiers": [              null            ],            "routing": {              "prepStationIds": [                "string"              ],              "assemblyLineId": "string",              "immediatePrepStationIds": [                "string"              ],              "modifierRouting": "with_parent",              "ticketDestination": "prep_only",              "appliedRuleIds": [                "string"              ]            }          }        ],        "routing": {          "prepStationIds": [            "string"          ],          "assemblyLineId": "string",          "immediatePrepStationIds": [            "string"          ],          "modifierRouting": "with_parent",          "ticketDestination": "prep_only",          "appliedRuleIds": [            "string"          ]        },        "voidReasonId": "string",        "voidReasonName": "string",        "voidedAt": "string",        "voidedByStaffUserId": "string",        "voidedByStaffName": "string",        "giftCardSale": {          "cardType": "Physical",          "code": "string",          "recipientName": "string",          "recipientEmail": "string",          "recipientPhone": "string",          "fromName": "string",          "purchaserEmail": "string",          "purchaserPhone": "string",          "giftMessage": "string",          "notes": "string",          "deliveryChannel": "email",          "deliveryDestination": "string",          "deliveryScheduledAt": "2019-08-24T14:15:22Z",          "notifyPurchaserWhenOpened": true        }      }    ],    "appliedDiscounts": [      {        "id": "string",        "sourceType": "promotion",        "sourceId": "string",        "code": "string",        "title": "string",        "scope": "order",        "lineItemId": "string",        "actionMessage": "string",        "appliesTo": "Store",        "appliesToObjectIds": [          "string"        ],        "combinability": "combinable",        "stackingScope": "order",        "requiresManagerApproval": true,        "managerApprovedByStaffUserId": "string",        "excludesServiceCharges": true,        "serviceChargeInteraction": "pre_discount",        "eligibilitySummary": "string",        "discountType": "amount",        "value": 0,        "amount": 0      }    ],    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "tipTotal": 0,    "total": 0,    "balanceDue": 0,    "paymentIntentIds": [      "string"    ],    "submittedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "offPremise": {      "channel": {        "kind": "first_party",        "provider": "string"      },      "customer": {        "customerId": "string",        "firstName": "string",        "lastName": "string",        "phone": "string",        "email": "user@example.com"      },      "quote": {        "strategy": "manual",        "quoteTimeApplies": true,        "quotedAt": "2019-08-24T14:15:22Z",        "scheduledFor": "2019-08-24T14:15:22Z",        "promisedFulfillmentAt": "2019-08-24T14:15:22Z",        "takeoutQuoteMinutes": 0,        "deliveryQuoteMinutes": 0,        "takeoutThrottlingMinutes": 0,        "deliveryThrottlingMinutes": 0,        "throttlingAppliedMinutes": 0,        "leadTimeHours": 0,        "minimumLeadTimeSatisfied": true,        "withinConfiguredOrderingHours": true,        "quoteExemptionReason": "third_party_channel"      },      "readyAt": "2019-08-24T14:15:22Z",      "staging": {        "state": "pending",        "batchId": "string",        "batchLabel": "string",        "stagingArea": "string",        "stagingSlot": "string",        "handoffZone": "string",        "batchReadyAt": "2019-08-24T14:15:22Z",        "stagedAt": "2019-08-24T14:15:22Z",        "readyBy": {          "staffUserId": "string",          "displayName": "string"        }      },      "guestMessaging": {        "enabled": true,        "preferredChannel": "sms",        "notifications": [          {            "event": "batch_ready",            "template": "order_ready",            "channel": "sms",            "status": "pending",            "recipient": "string",            "subject": "string",            "body": "string",            "updatedAt": "2019-08-24T14:15:22Z",            "sentAt": "2019-08-24T14:15:22Z",            "failureReason": "string"          }        ],        "lastUpdatedAt": "2019-08-24T14:15:22Z"      },      "pickup": {        "kind": "standard",        "state": "pending",        "stagedAt": "2019-08-24T14:15:22Z",        "arrivedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "curbside": {          "vehicleMakeModel": "string",          "vehicleColor": "string",          "instructions": "string",          "parkingSpot": "string",          "arrivalNote": "string"        }      },      "delivery": {        "addressId": "string",        "addressLabel": "string",        "state": "pending",        "instructions": "string",        "deliveryNotes": "string",        "stagedAt": "2019-08-24T14:15:22Z",        "dispatchedAt": "2019-08-24T14:15:22Z",        "deliveredAt": "2019-08-24T14:15:22Z",        "dispatchNote": "string",        "dispatch": {          "assignmentMode": "unassigned",          "assignedDriver": {            "staffUserId": "string",            "displayName": "string"          },          "dispatchedBy": {            "staffUserId": "string",            "displayName": "string"          },          "courierName": "string",          "courierPhone": "string",          "vehicleLabel": "string",          "assignedAt": "2019-08-24T14:15:22Z"        }      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  }}

Retrieve dining room floor state

GET
/restaurant/floor

Query Parameters

locationId*string

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/restaurant/floor?locationId=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"
{  "locationId": "string",  "serviceAreas": [    {      "id": "string",      "locationId": "string",      "title": "string",      "code": "string",      "color": "string",      "revenueCenterId": "string",      "sortOrder": 0,      "active": true,      "tableService": true,      "quickOrder": true,      "barTabs": true,      "defaultDiningOption": "dine_in",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "layouts": [    {      "id": "string",      "locationId": "string",      "serviceAreaId": "string",      "title": "string",      "active": true,      "canvasWidth": 320,      "canvasHeight": 320,      "gridSize": 4,      "snapToGrid": true,      "backgroundImageUrl": "string",      "tableLabelMode": "label",      "elements": [        {          "id": "string",          "type": "border",          "left": 0,          "top": 0,          "width": 1,          "height": 1,          "text": "string"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "sections": [    {      "id": "string",      "locationId": "string",      "serviceAreaId": "string",      "title": "string",      "code": "string",      "color": "string",      "sortOrder": 0,      "active": true,      "layout": {        "posX": 0,        "posY": 0,        "width": 1,        "height": 1      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "tables": [        {          "id": "string",          "locationId": "string",          "sectionId": "string",          "serviceAreaId": "string",          "revenueCenterId": "string",          "label": "string",          "capacity": 1,          "status": "available",          "active": true,          "posX": 0,          "posY": 0,          "layout": {            "shape": "rectangle",            "width": 1,            "height": 1,            "rotation": 0,            "zIndex": 0,            "labelOffsetX": 0,            "labelOffsetY": 0          },          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z",          "seats": [            {              "id": "string",              "tableId": "string",              "seatNumber": 1,              "label": "string",              "active": true,              "createdAt": "2019-08-24T14:15:22Z",              "updatedAt": "2019-08-24T14:15:22Z"            }          ],          "activeChecks": [            {              "id": "string",              "orderNumber": 0,              "status": "string",              "total": 0,              "seatCount": 0            }          ]        }      ]    }  ],  "tables": [    {      "id": "string",      "locationId": "string",      "sectionId": "string",      "serviceAreaId": "string",      "revenueCenterId": "string",      "label": "string",      "capacity": 1,      "status": "available",      "active": true,      "posX": 0,      "posY": 0,      "layout": {        "shape": "rectangle",        "width": 1,        "height": 1,        "rotation": 0,        "zIndex": 0,        "labelOffsetX": 0,        "labelOffsetY": 0      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "seats": [        {          "id": "string",          "tableId": "string",          "seatNumber": 1,          "label": "string",          "active": true,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "activeChecks": [        {          "id": "string",          "orderNumber": 0,          "status": "string",          "total": 0,          "seatCount": 0        }      ]    }  ],  "unsectionedTables": [    {      "id": "string",      "locationId": "string",      "sectionId": "string",      "serviceAreaId": "string",      "revenueCenterId": "string",      "label": "string",      "capacity": 1,      "status": "available",      "active": true,      "posX": 0,      "posY": 0,      "layout": {        "shape": "rectangle",        "width": 1,        "height": 1,        "rotation": 0,        "zIndex": 0,        "labelOffsetX": 0,        "labelOffsetY": 0      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "seats": [        {          "id": "string",          "tableId": "string",          "seatNumber": 1,          "label": "string",          "active": true,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "activeChecks": [        {          "id": "string",          "orderNumber": 0,          "status": "string",          "total": 0,          "seatCount": 0        }      ]    }  ]}

List restaurant service areas

GET
/restaurant/service-areas

Query Parameters

q?string
locationId?string

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/restaurant/service-areas" \  -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"
{  "serviceAreas": [    {      "id": "string",      "locationId": "string",      "title": "string",      "code": "string",      "color": "string",      "revenueCenterId": "string",      "sortOrder": 0,      "active": true,      "tableService": true,      "quickOrder": true,      "barTabs": true,      "defaultDiningOption": "dine_in",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Create restaurant service area

POST
/restaurant/service-areas

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/restaurant/service-areas" \  -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 '{    "locationId": "string",    "title": "string"  }'
{  "id": "string",  "locationId": "string",  "title": "string",  "code": "string",  "color": "string",  "revenueCenterId": "string",  "sortOrder": 0,  "active": true,  "tableService": true,  "quickOrder": true,  "barTabs": true,  "defaultDiningOption": "dine_in",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve restaurant service area

GET
/restaurant/service-areas/{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/restaurant/service-areas/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",  "locationId": "string",  "title": "string",  "code": "string",  "color": "string",  "revenueCenterId": "string",  "sortOrder": 0,  "active": true,  "tableService": true,  "quickOrder": true,  "barTabs": true,  "defaultDiningOption": "dine_in",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete restaurant service area

DELETE
/restaurant/service-areas/{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

curl -X DELETE "https://example.com/restaurant/service-areas/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"
Empty

Update restaurant service area

PUT
/restaurant/service-areas/{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/restaurant/service-areas/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",  "locationId": "string",  "title": "string",  "code": "string",  "color": "string",  "revenueCenterId": "string",  "sortOrder": 0,  "active": true,  "tableService": true,  "quickOrder": true,  "barTabs": true,  "defaultDiningOption": "dine_in",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List floor layouts

GET
/restaurant/floor/layouts

Query Parameters

locationId*string
serviceAreaId?string

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/restaurant/floor/layouts?locationId=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"
{  "layouts": [    {      "id": "string",      "locationId": "string",      "serviceAreaId": "string",      "title": "string",      "active": true,      "canvasWidth": 320,      "canvasHeight": 320,      "gridSize": 4,      "snapToGrid": true,      "backgroundImageUrl": "string",      "tableLabelMode": "label",      "elements": [        {          "id": "string",          "type": "border",          "left": 0,          "top": 0,          "width": 1,          "height": 1,          "text": "string"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Delete floor layout

DELETE
/restaurant/floor/layouts/{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

curl -X DELETE "https://example.com/restaurant/floor/layouts/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"
Empty

Upsert floor layout

PUT
/restaurant/floor/layouts/{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/restaurant/floor/layouts/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 '{    "locationId": "string",    "title": "string"  }'
{  "id": "string",  "locationId": "string",  "serviceAreaId": "string",  "title": "string",  "active": true,  "canvasWidth": 320,  "canvasHeight": 320,  "gridSize": 4,  "snapToGrid": true,  "backgroundImageUrl": "string",  "tableLabelMode": "label",  "elements": [    {      "id": "string",      "type": "border",      "left": 0,      "top": 0,      "width": 1,      "height": 1,      "text": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List dining room sections

GET
/restaurant/sections

Query Parameters

q?string
locationId?string

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/restaurant/sections" \  -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"
{  "sections": [    {      "id": "string",      "locationId": "string",      "serviceAreaId": "string",      "title": "string",      "code": "string",      "color": "string",      "sortOrder": 0,      "active": true,      "layout": {        "posX": 0,        "posY": 0,        "width": 1,        "height": 1      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Create dining room section

POST
/restaurant/sections

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/restaurant/sections" \  -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 '{    "locationId": "string",    "title": "string"  }'
{  "id": "string",  "locationId": "string",  "serviceAreaId": "string",  "title": "string",  "code": "string",  "color": "string",  "sortOrder": 0,  "active": true,  "layout": {    "posX": 0,    "posY": 0,    "width": 1,    "height": 1  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve dining room section

GET
/restaurant/sections/{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/restaurant/sections/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",  "locationId": "string",  "serviceAreaId": "string",  "title": "string",  "code": "string",  "color": "string",  "sortOrder": 0,  "active": true,  "layout": {    "posX": 0,    "posY": 0,    "width": 1,    "height": 1  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete dining room section

DELETE
/restaurant/sections/{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

curl -X DELETE "https://example.com/restaurant/sections/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"
Empty

Update dining room section

PUT
/restaurant/sections/{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/restaurant/sections/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",  "locationId": "string",  "serviceAreaId": "string",  "title": "string",  "code": "string",  "color": "string",  "sortOrder": 0,  "active": true,  "layout": {    "posX": 0,    "posY": 0,    "width": 1,    "height": 1  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List restaurant tables

GET
/restaurant/tables

Query Parameters

q?string
locationId?string
sectionId?string
serviceAreaId?string

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/restaurant/tables" \  -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"
{  "tables": [    {      "id": "string",      "locationId": "string",      "sectionId": "string",      "serviceAreaId": "string",      "revenueCenterId": "string",      "label": "string",      "capacity": 1,      "status": "available",      "active": true,      "posX": 0,      "posY": 0,      "layout": {        "shape": "rectangle",        "width": 1,        "height": 1,        "rotation": 0,        "zIndex": 0,        "labelOffsetX": 0,        "labelOffsetY": 0      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Create restaurant table

POST
/restaurant/tables

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/restaurant/tables" \  -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 '{    "locationId": "string",    "label": "string",    "capacity": 1  }'
{  "id": "string",  "locationId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "revenueCenterId": "string",  "label": "string",  "capacity": 1,  "status": "available",  "active": true,  "posX": 0,  "posY": 0,  "layout": {    "shape": "rectangle",    "width": 1,    "height": 1,    "rotation": 0,    "zIndex": 0,    "labelOffsetX": 0,    "labelOffsetY": 0  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve restaurant table

GET
/restaurant/tables/{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/restaurant/tables/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",  "locationId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "revenueCenterId": "string",  "label": "string",  "capacity": 1,  "status": "available",  "active": true,  "posX": 0,  "posY": 0,  "layout": {    "shape": "rectangle",    "width": 1,    "height": 1,    "rotation": 0,    "zIndex": 0,    "labelOffsetX": 0,    "labelOffsetY": 0  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete restaurant table

DELETE
/restaurant/tables/{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

curl -X DELETE "https://example.com/restaurant/tables/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"
Empty

Update restaurant table

PUT
/restaurant/tables/{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/restaurant/tables/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",  "locationId": "string",  "sectionId": "string",  "serviceAreaId": "string",  "revenueCenterId": "string",  "label": "string",  "capacity": 1,  "status": "available",  "active": true,  "posX": 0,  "posY": 0,  "layout": {    "shape": "rectangle",    "width": 1,    "height": 1,    "rotation": 0,    "zIndex": 0,    "labelOffsetX": 0,    "labelOffsetY": 0  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List seats for a restaurant table

GET
/restaurant/tables/{id}/seats

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/restaurant/tables/string/seats" \  -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"
{  "seats": [    {      "id": "string",      "tableId": "string",      "seatNumber": 1,      "label": "string",      "active": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Create a seat on a restaurant table

POST
/restaurant/tables/{id}/seats

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 POST "https://example.com/restaurant/tables/string/seats" \  -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 '{    "seatNumber": 1  }'
{  "id": "string",  "tableId": "string",  "seatNumber": 1,  "label": "string",  "active": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve restaurant seat

GET
/restaurant/seats/{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/restaurant/seats/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",  "tableId": "string",  "seatNumber": 1,  "label": "string",  "active": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete restaurant seat

DELETE
/restaurant/seats/{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

curl -X DELETE "https://example.com/restaurant/seats/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"
Empty

Update restaurant seat

PUT
/restaurant/seats/{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/restaurant/seats/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",  "tableId": "string",  "seatNumber": 1,  "label": "string",  "active": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Transfer one or more open checks to another staff member

POST
/restaurant/server-control/checks/transfer

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/restaurant/server-control/checks/transfer" \  -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 '{    "orderIds": [      "string"    ],    "targetStaffUserId": "string"  }'
{  "transferredChecks": [    {      "id": "string",      "orderNumber": 0,      "locationId": "string",      "assignedStaffUserId": "string",      "status": "draft",      "fulfillmentMode": "dine_in",      "tableId": "string",      "sectionId": "string",      "serviceAreaId": "string",      "tableLabel": "string",      "seatCount": 1,      "note": "string",      "lineItems": [        {          "id": "string",          "lineType": "catalog",          "productId": "string",          "title": "string",          "quantity": 1,          "seatId": "string",          "seatNumber": 1,          "course": "string"        }      ],      "subtotal": 0,      "discountTotal": 0,      "taxTotal": 0,      "tipTotal": 0,      "total": 0,      "balanceDue": 0,      "submittedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "transfers": [    {      "id": "string",      "orderId": "string",      "sourceStaff": {        "id": "string",        "label": "string"      },      "targetStaff": {        "id": "string",        "label": "string"      },      "mode": "bulk",      "resendToKitchen": true,      "reopenedOrder": true,      "transferredAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Reopen a paid check for follow-up service

POST
/restaurant/server-control/checks/{id}/reopen

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 POST "https://example.com/restaurant/server-control/checks/string/reopen" \  -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 '{}'
{  "order": {    "id": "string",    "orderNumber": 0,    "locationId": "string",    "assignedStaffUserId": "string",    "status": "draft",    "fulfillmentMode": "dine_in",    "tableId": "string",    "sectionId": "string",    "serviceAreaId": "string",    "tableLabel": "string",    "seatCount": 1,    "note": "string",    "lineItems": [      {        "id": "string",        "lineType": "catalog",        "productId": "string",        "title": "string",        "quantity": 1,        "seatId": "string",        "seatNumber": 1,        "course": "string"      }    ],    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "tipTotal": 0,    "total": 0,    "balanceDue": 0,    "submittedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "reopen": {    "id": "string",    "orderId": "string",    "previousStatus": "string",    "reopenedStatus": "string",    "reason": "string",    "authorization": {      "mode": "disabled",      "overrideStaffUserId": "string",      "overrideRoles": [        "string"      ]    },    "reopenedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "kitchenUpdate": {    "ticketIds": [      "string"    ],    "itemIds": [      "string"    ],    "totalItems": 0  }}

Move selected order lines to different seats

POST
/restaurant/server-control/checks/{id}/move-seats

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 POST "https://example.com/restaurant/server-control/checks/string/move-seats" \  -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 '{    "lineItemMoves": [      {        "lineItemId": "string"      }    ]  }'
{  "order": {    "id": "string",    "orderNumber": 0,    "locationId": "string",    "assignedStaffUserId": "string",    "status": "draft",    "fulfillmentMode": "dine_in",    "tableId": "string",    "sectionId": "string",    "serviceAreaId": "string",    "tableLabel": "string",    "seatCount": 1,    "note": "string",    "lineItems": [      {        "id": "string",        "lineType": "catalog",        "productId": "string",        "title": "string",        "quantity": 1,        "seatId": "string",        "seatNumber": 1,        "course": "string"      }    ],    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "tipTotal": 0,    "total": 0,    "balanceDue": 0,    "submittedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Record a guest recovery action and optionally resend items to the kitchen

POST
/restaurant/server-control/checks/{id}/guest-recovery

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 POST "https://example.com/restaurant/server-control/checks/string/guest-recovery" \  -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 '{    "action": "resend",    "reason": "string"  }'
{  "order": {    "id": "string",    "orderNumber": 0,    "locationId": "string",    "assignedStaffUserId": "string",    "status": "draft",    "fulfillmentMode": "dine_in",    "tableId": "string",    "sectionId": "string",    "serviceAreaId": "string",    "tableLabel": "string",    "seatCount": 1,    "note": "string",    "lineItems": [      {        "id": "string",        "lineType": "catalog",        "productId": "string",        "title": "string",        "quantity": 1,        "seatId": "string",        "seatNumber": 1,        "course": "string"      }    ],    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "tipTotal": 0,    "total": 0,    "balanceDue": 0,    "submittedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "recovery": {    "id": "string",    "orderId": "string",    "action": "resend",    "reason": "string",    "issueNote": "string",    "lineItemIds": [      "string"    ],    "refiredTicketIds": [      "string"    ],    "refiredItemIds": [      "string"    ],    "reopenedOrder": true,    "compAmount": 0,    "compScope": "check",    "authorization": {      "mode": "disabled",      "overrideStaffUserId": "string",      "overrideRoles": [        "string"      ]    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "kitchenUpdate": {    "ticketIds": [      "string"    ],    "itemIds": [      "string"    ],    "totalItems": 0  }}

List kitchen or expo tickets

GET
/restaurant/kitchen/tickets

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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/restaurant/kitchen/tickets?locationId=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"
{  "tickets": [    {      "id": "string",      "locationId": "string",      "orderId": "string",      "orderNumber": 0,      "orderStatus": "string",      "stationId": "string",      "stationType": "prep",      "stationTitle": "string",      "ticketState": "preview",      "fulfillmentMode": "string",      "paymentStatus": "paid",      "ageSeconds": 0,      "ageBucket": "new",      "headingColor": "default",      "ticketGroupingMode": "single_ticket",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "layoutMode": "dynamic",      "textSize": "small",      "displayTheme": "light",      "partialFulfillment": true,      "readyItemCount": 0,      "blockedItemCount": 0,      "fulfillmentSequence": 1,      "fulfillmentSequenceTotal": 1,      "tableLabel": "string",      "sectionId": "string",      "items": [        {          "id": "string",          "orderId": "string",          "orderNumber": 0,          "lineItemId": "string",          "parentItemId": "string",          "productId": "string",          "title": "string",          "salesCategory": "string",          "quantity": 1,          "course": "string",          "seatNumber": 1,          "stationId": "string",          "stationType": "prep",          "stationTitle": "string",          "fulfillmentMode": "string",          "diningOption": "dine_in",          "diningOptionLabel": "string",          "ticketDestination": "prep_only",          "itemStatus": "preview",          "fireAt": "2019-08-24T14:15:22Z",          "rushedAt": "2019-08-24T14:15:22Z",          "completedAt": "2019-08-24T14:15:22Z",          "prepTimeSeconds": 0,          "displayLabel": "string",          "displayCategory": "item",          "portionLabel": "string",          "stockAlert": "out_of_stock",          "fulfillmentState": "pending",          "readyForFulfillment": true,          "fulfillmentSequence": 1,          "fulfillmentSequenceTotal": 1,          "blockedByStationIds": [            "string"          ],          "blockedByStationTitles": [            "string"          ],          "otherStationIds": [            "string"          ],          "otherStationTitles": [            "string"          ],          "groupedItemIds": [            "string"          ],          "modifiers": [            "string"          ]        }      ]    }  ],  "total": 0}

Retrieve a kitchen or expo ticket

GET
/restaurant/kitchen/tickets/{id}

Path Parameters

id*string
Length1 <= length

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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/restaurant/kitchen/tickets/string?locationId=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",  "locationId": "string",  "orderId": "string",  "orderNumber": 0,  "orderStatus": "string",  "stationId": "string",  "stationType": "prep",  "stationTitle": "string",  "ticketState": "preview",  "fulfillmentMode": "string",  "paymentStatus": "paid",  "ageSeconds": 0,  "ageBucket": "new",  "headingColor": "default",  "ticketGroupingMode": "single_ticket",  "diningOption": "dine_in",  "diningOptionLabel": "string",  "layoutMode": "dynamic",  "textSize": "small",  "displayTheme": "light",  "partialFulfillment": true,  "readyItemCount": 0,  "blockedItemCount": 0,  "fulfillmentSequence": 1,  "fulfillmentSequenceTotal": 1,  "tableLabel": "string",  "sectionId": "string",  "items": [    {      "id": "string",      "orderId": "string",      "orderNumber": 0,      "lineItemId": "string",      "parentItemId": "string",      "productId": "string",      "title": "string",      "salesCategory": "string",      "quantity": 1,      "course": "string",      "seatNumber": 1,      "stationId": "string",      "stationType": "prep",      "stationTitle": "string",      "fulfillmentMode": "string",      "diningOption": "dine_in",      "diningOptionLabel": "string",      "ticketDestination": "prep_only",      "itemStatus": "preview",      "fireAt": "2019-08-24T14:15:22Z",      "rushedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "prepTimeSeconds": 0,      "displayLabel": "string",      "displayCategory": "item",      "portionLabel": "string",      "stockAlert": "out_of_stock",      "fulfillmentState": "pending",      "readyForFulfillment": true,      "fulfillmentSequence": 1,      "fulfillmentSequenceTotal": 1,      "blockedByStationIds": [        "string"      ],      "blockedByStationTitles": [        "string"      ],      "otherStationIds": [        "string"      ],      "otherStationTitles": [        "string"      ],      "groupedItemIds": [        "string"      ],      "modifiers": [        "string"      ]    }  ]}

List printer device configuration for a location

GET
/restaurant/printers

Query Parameters

locationId?string
q?string

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/restaurant/printers" \  -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"
{  "printers": [    {      "id": "string",      "locationId": "string",      "name": "string",      "role": "receipt",      "model": "virtual",      "ipSetup": "dynamic_ip",      "connectionType": "wired",      "serialNumber": "string",      "wifiSSID": "string",      "wifiPassphrase": "string",      "discoveryMode": "epson_simpleap",      "hostCandidates": [        "string"      ],      "lastKnownIpAddress": "string",      "lastKnownPort": 1,      "lastDiscoveredAt": "2019-08-24T14:15:22Z",      "lastSeenAt": "2019-08-24T14:15:22Z",      "staticIpAddress": "string",      "staticIpPort": 1,      "staticIpSubnetMask": "string",      "staticIpGateway": "string",      "customFooterLines": [        "string"      ],      "kitchenTicketFontSize": "small",      "customerReceiptFontSize": "small",      "paperWidth": "narrow",      "characterSet": "standard",      "backupPrinterId": "string",      "cashDrawerConfiguration": "none",      "assignedServiceAreaIds": [        "string"      ],      "assignedPrepStationIds": [        "string"      ],      "enabled": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Create a printer device configuration

POST
/restaurant/printers

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/restaurant/printers" \  -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 '{    "locationId": "string",    "name": "string",    "role": "receipt",    "model": "virtual",    "ipSetup": "dynamic_ip"  }'
{  "id": "string",  "locationId": "string",  "name": "string",  "role": "receipt",  "model": "virtual",  "ipSetup": "dynamic_ip",  "connectionType": "wired",  "serialNumber": "string",  "wifiSSID": "string",  "wifiPassphrase": "string",  "discoveryMode": "epson_simpleap",  "hostCandidates": [    "string"  ],  "lastKnownIpAddress": "string",  "lastKnownPort": 1,  "lastDiscoveredAt": "2019-08-24T14:15:22Z",  "lastSeenAt": "2019-08-24T14:15:22Z",  "staticIpAddress": "string",  "staticIpPort": 1,  "staticIpSubnetMask": "string",  "staticIpGateway": "string",  "customFooterLines": [    "string"  ],  "kitchenTicketFontSize": "small",  "customerReceiptFontSize": "small",  "paperWidth": "narrow",  "characterSet": "standard",  "backupPrinterId": "string",  "cashDrawerConfiguration": "none",  "assignedServiceAreaIds": [    "string"  ],  "assignedPrepStationIds": [    "string"  ],  "enabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Check a private-network web printer or send an Epson ePOS test page

POST
/restaurant/printers/probe

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/restaurant/printers/probe" \  -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 '{    "action": "status",    "protocol": "http",    "address": "strings",    "port": 1  }'
{  "action": "status",  "reachable": true,  "latencyMs": 0,  "statusCode": 0,  "detail": "string"}

Retrieve a printer device configuration

GET
/restaurant/printers/{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/restaurant/printers/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",  "locationId": "string",  "name": "string",  "role": "receipt",  "model": "virtual",  "ipSetup": "dynamic_ip",  "connectionType": "wired",  "serialNumber": "string",  "wifiSSID": "string",  "wifiPassphrase": "string",  "discoveryMode": "epson_simpleap",  "hostCandidates": [    "string"  ],  "lastKnownIpAddress": "string",  "lastKnownPort": 1,  "lastDiscoveredAt": "2019-08-24T14:15:22Z",  "lastSeenAt": "2019-08-24T14:15:22Z",  "staticIpAddress": "string",  "staticIpPort": 1,  "staticIpSubnetMask": "string",  "staticIpGateway": "string",  "customFooterLines": [    "string"  ],  "kitchenTicketFontSize": "small",  "customerReceiptFontSize": "small",  "paperWidth": "narrow",  "characterSet": "standard",  "backupPrinterId": "string",  "cashDrawerConfiguration": "none",  "assignedServiceAreaIds": [    "string"  ],  "assignedPrepStationIds": [    "string"  ],  "enabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a printer device configuration

DELETE
/restaurant/printers/{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

curl -X DELETE "https://example.com/restaurant/printers/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"
Empty

Update a printer device configuration

PUT
/restaurant/printers/{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/restaurant/printers/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",  "locationId": "string",  "name": "string",  "role": "receipt",  "model": "virtual",  "ipSetup": "dynamic_ip",  "connectionType": "wired",  "serialNumber": "string",  "wifiSSID": "string",  "wifiPassphrase": "string",  "discoveryMode": "epson_simpleap",  "hostCandidates": [    "string"  ],  "lastKnownIpAddress": "string",  "lastKnownPort": 1,  "lastDiscoveredAt": "2019-08-24T14:15:22Z",  "lastSeenAt": "2019-08-24T14:15:22Z",  "staticIpAddress": "string",  "staticIpPort": 1,  "staticIpSubnetMask": "string",  "staticIpGateway": "string",  "customFooterLines": [    "string"  ],  "kitchenTicketFontSize": "small",  "customerReceiptFontSize": "small",  "paperWidth": "narrow",  "characterSet": "standard",  "backupPrinterId": "string",  "cashDrawerConfiguration": "none",  "assignedServiceAreaIds": [    "string"  ],  "assignedPrepStationIds": [    "string"  ],  "enabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List printer routing rules for kitchen, expo, receipt, and label tickets

GET
/restaurant/printer-routing

Query Parameters

locationId?string
printerId?string
ticketType?||||
active?boolean

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/restaurant/printer-routing" \  -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"
{  "rules": [    {      "id": "string",      "locationId": "string",      "name": "string",      "ticketType": "kitchen",      "sourceType": "reservation_chit",      "printerId": "string",      "prepStationId": "string",      "serviceAreaId": "string",      "revenueCenterId": "string",      "fulfillmentMode": "dine_in",      "copies": 1,      "printChangesOnly": true,      "printVoids": true,      "isBackup": true,      "failoverMode": "none",      "backupPrinterId": "string",      "enabled": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Create a printer routing rule

POST
/restaurant/printer-routing

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/restaurant/printer-routing" \  -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 '{    "locationId": "string",    "name": "string",    "ticketType": "kitchen",    "printerId": "string"  }'
{  "id": "string",  "locationId": "string",  "name": "string",  "ticketType": "kitchen",  "sourceType": "reservation_chit",  "printerId": "string",  "prepStationId": "string",  "serviceAreaId": "string",  "revenueCenterId": "string",  "fulfillmentMode": "dine_in",  "copies": 1,  "printChangesOnly": true,  "printVoids": true,  "isBackup": true,  "failoverMode": "none",  "backupPrinterId": "string",  "enabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve a printer routing rule

GET
/restaurant/printer-routing/{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/restaurant/printer-routing/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",  "locationId": "string",  "name": "string",  "ticketType": "kitchen",  "sourceType": "reservation_chit",  "printerId": "string",  "prepStationId": "string",  "serviceAreaId": "string",  "revenueCenterId": "string",  "fulfillmentMode": "dine_in",  "copies": 1,  "printChangesOnly": true,  "printVoids": true,  "isBackup": true,  "failoverMode": "none",  "backupPrinterId": "string",  "enabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a printer routing rule

DELETE
/restaurant/printer-routing/{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

curl -X DELETE "https://example.com/restaurant/printer-routing/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"
Empty

Update a printer routing rule

PUT
/restaurant/printer-routing/{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/restaurant/printer-routing/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",  "locationId": "string",  "name": "string",  "ticketType": "kitchen",  "sourceType": "reservation_chit",  "printerId": "string",  "prepStationId": "string",  "serviceAreaId": "string",  "revenueCenterId": "string",  "fulfillmentMode": "dine_in",  "copies": 1,  "printChangesOnly": true,  "printVoids": true,  "isBackup": true,  "failoverMode": "none",  "backupPrinterId": "string",  "enabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List mirrored print job records reported by POS devices

GET
/restaurant/print-jobs

Query Parameters

locationId?string
printerId?string
deviceId?string
sourceType?||||||
status?||||
limit?integer
Range1 <= value <= 200

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/restaurant/print-jobs" \  -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"
{  "jobs": [    {      "id": "string",      "clientJobId": "string",      "locationId": "string",      "printerId": "string",      "routingRuleId": "string",      "ticketType": "kitchen",      "sourceType": "order_receipt",      "sourceId": "string",      "orderId": "string",      "ticketId": "string",      "deviceId": "string",      "deviceJobId": "string",      "payloadPreview": "string",      "payloadBase64": "string",      "payloadFormat": "plain_text",      "escpos": {        "model": "virtual",        "paperWidth": "narrow",        "widthChars": 20,        "cut": true,        "cashDrawerKick": true,        "characterSet": "standard"      },      "copyIndex": 1,      "copyCount": 1,      "failoverFromJobId": "string",      "failoverReason": "string",      "contentHash": "string",      "copies": 1,      "status": "queued",      "attemptCount": 0,      "maxAttempts": 1,      "queuedAt": "2019-08-24T14:15:22Z",      "sentAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "failedAt": "2019-08-24T14:15:22Z",      "canceledAt": "2019-08-24T14:15:22Z",      "lastError": "string",      "events": [        {          "status": "queued",          "at": "2019-08-24T14:15:22Z",          "deviceId": "string",          "attemptNumber": 0,          "message": "string",          "errorCode": "string"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Mirror a locally queued print job to the server

POST
/restaurant/print-jobs

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

application/json

curl -X POST "https://example.com/restaurant/print-jobs" \  -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 '{    "clientJobId": "string",    "locationId": "string",    "printerId": "string",    "ticketType": "kitchen",    "sourceType": "order_receipt"  }'
{  "id": "string",  "clientJobId": "string",  "locationId": "string",  "printerId": "string",  "routingRuleId": "string",  "ticketType": "kitchen",  "sourceType": "order_receipt",  "sourceId": "string",  "orderId": "string",  "ticketId": "string",  "deviceId": "string",  "deviceJobId": "string",  "payloadPreview": "string",  "payloadBase64": "string",  "payloadFormat": "plain_text",  "escpos": {    "model": "virtual",    "paperWidth": "narrow",    "widthChars": 20,    "cut": true,    "cashDrawerKick": true,    "characterSet": "standard"  },  "copyIndex": 1,  "copyCount": 1,  "failoverFromJobId": "string",  "failoverReason": "string",  "contentHash": "string",  "copies": 1,  "status": "queued",  "attemptCount": 0,  "maxAttempts": 1,  "queuedAt": "2019-08-24T14:15:22Z",  "sentAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "failedAt": "2019-08-24T14:15:22Z",  "canceledAt": "2019-08-24T14:15:22Z",  "lastError": "string",  "events": [    {      "status": "queued",      "at": "2019-08-24T14:15:22Z",      "deviceId": "string",      "attemptNumber": 0,      "message": "string",      "errorCode": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Create a short-lived location-scoped print-job event session

POST
/restaurant/print-jobs/realtime-session

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/restaurant/print-jobs/realtime-session" \  -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 '{    "locationId": "string"  }'
{  "webSocketUrl": "string",  "token": "string",  "expiresAt": "2019-08-24T14:15:22Z"}

Retrieve one mirrored print job record

GET
/restaurant/print-jobs/{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/restaurant/print-jobs/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",  "clientJobId": "string",  "locationId": "string",  "printerId": "string",  "routingRuleId": "string",  "ticketType": "kitchen",  "sourceType": "order_receipt",  "sourceId": "string",  "orderId": "string",  "ticketId": "string",  "deviceId": "string",  "deviceJobId": "string",  "payloadPreview": "string",  "payloadBase64": "string",  "payloadFormat": "plain_text",  "escpos": {    "model": "virtual",    "paperWidth": "narrow",    "widthChars": 20,    "cut": true,    "cashDrawerKick": true,    "characterSet": "standard"  },  "copyIndex": 1,  "copyCount": 1,  "failoverFromJobId": "string",  "failoverReason": "string",  "contentHash": "string",  "copies": 1,  "status": "queued",  "attemptCount": 0,  "maxAttempts": 1,  "queuedAt": "2019-08-24T14:15:22Z",  "sentAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "failedAt": "2019-08-24T14:15:22Z",  "canceledAt": "2019-08-24T14:15:22Z",  "lastError": "string",  "events": [    {      "status": "queued",      "at": "2019-08-24T14:15:22Z",      "deviceId": "string",      "attemptNumber": 0,      "message": "string",      "errorCode": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a mirrored print job record

DELETE
/restaurant/print-jobs/{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/restaurant/print-jobs/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",  "clientJobId": "string",  "locationId": "string",  "printerId": "string",  "routingRuleId": "string",  "ticketType": "kitchen",  "sourceType": "order_receipt",  "sourceId": "string",  "orderId": "string",  "ticketId": "string",  "deviceId": "string",  "deviceJobId": "string",  "payloadPreview": "string",  "payloadBase64": "string",  "payloadFormat": "plain_text",  "escpos": {    "model": "virtual",    "paperWidth": "narrow",    "widthChars": 20,    "cut": true,    "cashDrawerKick": true,    "characterSet": "standard"  },  "copyIndex": 1,  "copyCount": 1,  "failoverFromJobId": "string",  "failoverReason": "string",  "contentHash": "string",  "copies": 1,  "status": "queued",  "attemptCount": 0,  "maxAttempts": 1,  "queuedAt": "2019-08-24T14:15:22Z",  "sentAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "failedAt": "2019-08-24T14:15:22Z",  "canceledAt": "2019-08-24T14:15:22Z",  "lastError": "string",  "events": [    {      "status": "queued",      "at": "2019-08-24T14:15:22Z",      "deviceId": "string",      "attemptNumber": 0,      "message": "string",      "errorCode": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update mirrored print job state from a POS device

POST
/restaurant/print-jobs/{id}/status

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 POST "https://example.com/restaurant/print-jobs/string/status" \  -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 '{    "status": "queued"  }'
{  "id": "string",  "clientJobId": "string",  "locationId": "string",  "printerId": "string",  "routingRuleId": "string",  "ticketType": "kitchen",  "sourceType": "order_receipt",  "sourceId": "string",  "orderId": "string",  "ticketId": "string",  "deviceId": "string",  "deviceJobId": "string",  "payloadPreview": "string",  "payloadBase64": "string",  "payloadFormat": "plain_text",  "escpos": {    "model": "virtual",    "paperWidth": "narrow",    "widthChars": 20,    "cut": true,    "cashDrawerKick": true,    "characterSet": "standard"  },  "copyIndex": 1,  "copyCount": 1,  "failoverFromJobId": "string",  "failoverReason": "string",  "contentHash": "string",  "copies": 1,  "status": "queued",  "attemptCount": 0,  "maxAttempts": 1,  "queuedAt": "2019-08-24T14:15:22Z",  "sentAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "failedAt": "2019-08-24T14:15:22Z",  "canceledAt": "2019-08-24T14:15:22Z",  "lastError": "string",  "events": [    {      "status": "queued",      "at": "2019-08-24T14:15:22Z",      "deviceId": "string",      "attemptNumber": 0,      "message": "string",      "errorCode": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retry a failed print job without creating a duplicate

POST
/restaurant/print-jobs/{id}/retry

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 POST "https://example.com/restaurant/print-jobs/string/retry" \  -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",  "clientJobId": "string",  "locationId": "string",  "printerId": "string",  "routingRuleId": "string",  "ticketType": "kitchen",  "sourceType": "order_receipt",  "sourceId": "string",  "orderId": "string",  "ticketId": "string",  "deviceId": "string",  "deviceJobId": "string",  "payloadPreview": "string",  "payloadBase64": "string",  "payloadFormat": "plain_text",  "escpos": {    "model": "virtual",    "paperWidth": "narrow",    "widthChars": 20,    "cut": true,    "cashDrawerKick": true,    "characterSet": "standard"  },  "copyIndex": 1,  "copyCount": 1,  "failoverFromJobId": "string",  "failoverReason": "string",  "contentHash": "string",  "copies": 1,  "status": "queued",  "attemptCount": 0,  "maxAttempts": 1,  "queuedAt": "2019-08-24T14:15:22Z",  "sentAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "failedAt": "2019-08-24T14:15:22Z",  "canceledAt": "2019-08-24T14:15:22Z",  "lastError": "string",  "events": [    {      "status": "queued",      "at": "2019-08-24T14:15:22Z",      "deviceId": "string",      "attemptNumber": 0,      "message": "string",      "errorCode": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve kitchen printer template settings

GET
/restaurant/kitchen/print-template

Query Parameters

locationId*string

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/restaurant/kitchen/print-template?locationId=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",  "locationId": "string",  "labelFormat": "ticket_number",  "fontSize": "small",  "widthChars": 20,  "separatorStyle": "line",  "printGuestDetails": true,  "printDefaultModifiersBlack": true,  "printTicketChanges": "changes_and_voids",  "printItemSizesInline": true,  "groupByPlate": true,  "splitTicketsByCourse": true,  "individualPrintMode": "single_ticket",  "ticketFooterMode": "none",  "showSeatNumbers": true,  "showSequenceInfo": true,  "showFulfillmentState": true,  "showFireTimes": true,  "itemSpacing": 0,  "headerSpacing": 0,  "customFooterLines": [    "string"  ],  "updatedAt": "2019-08-24T14:15:22Z"}

Update kitchen printer template settings

PUT
/restaurant/kitchen/print-template

Query Parameters

locationId*string

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/restaurant/kitchen/print-template?locationId=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",  "locationId": "string",  "labelFormat": "ticket_number",  "fontSize": "small",  "widthChars": 20,  "separatorStyle": "line",  "printGuestDetails": true,  "printDefaultModifiersBlack": true,  "printTicketChanges": "changes_and_voids",  "printItemSizesInline": true,  "groupByPlate": true,  "splitTicketsByCourse": true,  "individualPrintMode": "single_ticket",  "ticketFooterMode": "none",  "showSeatNumbers": true,  "showSequenceInfo": true,  "showFulfillmentState": true,  "showFireTimes": true,  "itemSpacing": 0,  "headerSpacing": 0,  "customFooterLines": [    "string"  ],  "updatedAt": "2019-08-24T14:15:22Z"}

Render a printable kitchen ticket

GET
/restaurant/kitchen/tickets/{id}/print

Path Parameters

id*string
Length1 <= length

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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/restaurant/kitchen/tickets/string/print?locationId=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"
{  "ticketId": "string",  "locationId": "string",  "template": {    "id": "string",    "locationId": "string",    "labelFormat": "ticket_number",    "fontSize": "small",    "widthChars": 20,    "separatorStyle": "line",    "printGuestDetails": true,    "printDefaultModifiersBlack": true,    "printTicketChanges": "changes_and_voids",    "printItemSizesInline": true,    "groupByPlate": true,    "splitTicketsByCourse": true,    "individualPrintMode": "single_ticket",    "ticketFooterMode": "none",    "showSeatNumbers": true,    "showSequenceInfo": true,    "showFulfillmentState": true,    "showFireTimes": true,    "itemSpacing": 0,    "headerSpacing": 0,    "customFooterLines": [      "string"    ],    "updatedAt": "2019-08-24T14:15:22Z"  },  "lines": [    {      "text": "string",      "emphasis": "normal",      "colorHint": "default",      "role": "string"    }  ],  "plainText": "string"}

Queue routed print jobs for a kitchen or expo ticket

POST
/restaurant/kitchen/tickets/{id}/print-jobs

Path Parameters

id*string
Length1 <= length

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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/restaurant/kitchen/tickets/string/print-jobs?locationId=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 '{}'
{  "ticket": {    "id": "string",    "locationId": "string",    "orderId": "string",    "orderNumber": 0,    "orderStatus": "string",    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "ticketState": "preview",    "fulfillmentMode": "string",    "paymentStatus": "paid",    "ageSeconds": 0,    "ageBucket": "new",    "headingColor": "default",    "ticketGroupingMode": "single_ticket",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "layoutMode": "dynamic",    "textSize": "small",    "displayTheme": "light",    "partialFulfillment": true,    "readyItemCount": 0,    "blockedItemCount": 0,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "tableLabel": "string",    "sectionId": "string",    "items": [      {        "id": "string",        "orderId": "string",        "orderNumber": 0,        "lineItemId": "string",        "parentItemId": "string",        "productId": "string",        "title": "string",        "salesCategory": "string",        "quantity": 1,        "course": "string",        "seatNumber": 1,        "stationId": "string",        "stationType": "prep",        "stationTitle": "string",        "fulfillmentMode": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "ticketDestination": "prep_only",        "itemStatus": "preview",        "fireAt": "2019-08-24T14:15:22Z",        "rushedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "prepTimeSeconds": 0,        "displayLabel": "string",        "displayCategory": "item",        "portionLabel": "string",        "stockAlert": "out_of_stock",        "fulfillmentState": "pending",        "readyForFulfillment": true,        "fulfillmentSequence": 1,        "fulfillmentSequenceTotal": 1,        "blockedByStationIds": [          "string"        ],        "blockedByStationTitles": [          "string"        ],        "otherStationIds": [          "string"        ],        "otherStationTitles": [          "string"        ],        "groupedItemIds": [          "string"        ],        "modifiers": [          "string"        ]      }    ]  },  "jobs": [    {      "id": "string",      "clientJobId": "string",      "locationId": "string",      "printerId": "string",      "routingRuleId": "string",      "ticketType": "kitchen",      "sourceType": "order_receipt",      "sourceId": "string",      "orderId": "string",      "ticketId": "string",      "deviceId": "string",      "deviceJobId": "string",      "payloadPreview": "string",      "payloadBase64": "string",      "payloadFormat": "plain_text",      "escpos": {        "model": "virtual",        "paperWidth": "narrow",        "widthChars": 20,        "cut": true,        "cashDrawerKick": true,        "characterSet": "standard"      },      "copyIndex": 1,      "copyCount": 1,      "failoverFromJobId": "string",      "failoverReason": "string",      "contentHash": "string",      "copies": 1,      "status": "queued",      "attemptCount": 0,      "maxAttempts": 1,      "queuedAt": "2019-08-24T14:15:22Z",      "sentAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "failedAt": "2019-08-24T14:15:22Z",      "canceledAt": "2019-08-24T14:15:22Z",      "lastError": "string",      "events": [        {          "status": "queued",          "at": "2019-08-24T14:15:22Z",          "deviceId": "string",          "attemptNumber": 0,          "message": "string",          "errorCode": "string"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Refire a kitchen item

POST
/restaurant/kitchen/tickets/{id}/items/{itemId}/refire

Path Parameters

id*string
itemId*string

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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 POST "https://example.com/restaurant/kitchen/tickets/string/items/string/refire?locationId=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"
{  "ticket": {    "id": "string",    "locationId": "string",    "orderId": "string",    "orderNumber": 0,    "orderStatus": "string",    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "ticketState": "preview",    "fulfillmentMode": "string",    "paymentStatus": "paid",    "ageSeconds": 0,    "ageBucket": "new",    "headingColor": "default",    "ticketGroupingMode": "single_ticket",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "layoutMode": "dynamic",    "textSize": "small",    "displayTheme": "light",    "partialFulfillment": true,    "readyItemCount": 0,    "blockedItemCount": 0,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "tableLabel": "string",    "sectionId": "string",    "items": [      {        "id": "string",        "orderId": "string",        "orderNumber": 0,        "lineItemId": "string",        "parentItemId": "string",        "productId": "string",        "title": "string",        "salesCategory": "string",        "quantity": 1,        "course": "string",        "seatNumber": 1,        "stationId": "string",        "stationType": "prep",        "stationTitle": "string",        "fulfillmentMode": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "ticketDestination": "prep_only",        "itemStatus": "preview",        "fireAt": "2019-08-24T14:15:22Z",        "rushedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "prepTimeSeconds": 0,        "displayLabel": "string",        "displayCategory": "item",        "portionLabel": "string",        "stockAlert": "out_of_stock",        "fulfillmentState": "pending",        "readyForFulfillment": true,        "fulfillmentSequence": 1,        "fulfillmentSequenceTotal": 1,        "blockedByStationIds": [          "string"        ],        "blockedByStationTitles": [          "string"        ],        "otherStationIds": [          "string"        ],        "otherStationTitles": [          "string"        ],        "groupedItemIds": [          "string"        ],        "modifiers": [          "string"        ]      }    ]  },  "item": {    "id": "string",    "orderId": "string",    "orderNumber": 0,    "lineItemId": "string",    "parentItemId": "string",    "productId": "string",    "title": "string",    "salesCategory": "string",    "quantity": 1,    "course": "string",    "seatNumber": 1,    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "fulfillmentMode": "string",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "ticketDestination": "prep_only",    "itemStatus": "preview",    "fireAt": "2019-08-24T14:15:22Z",    "rushedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "prepTimeSeconds": 0,    "displayLabel": "string",    "displayCategory": "item",    "portionLabel": "string",    "stockAlert": "out_of_stock",    "fulfillmentState": "pending",    "readyForFulfillment": true,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "blockedByStationIds": [      "string"    ],    "blockedByStationTitles": [      "string"    ],    "otherStationIds": [      "string"    ],    "otherStationTitles": [      "string"    ],    "groupedItemIds": [      "string"    ],    "modifiers": [      "string"    ]  }}

Resend a kitchen item without changing routing

POST
/restaurant/kitchen/tickets/{id}/items/{itemId}/resend

Path Parameters

id*string
itemId*string

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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 POST "https://example.com/restaurant/kitchen/tickets/string/items/string/resend?locationId=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"
{  "ticket": {    "id": "string",    "locationId": "string",    "orderId": "string",    "orderNumber": 0,    "orderStatus": "string",    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "ticketState": "preview",    "fulfillmentMode": "string",    "paymentStatus": "paid",    "ageSeconds": 0,    "ageBucket": "new",    "headingColor": "default",    "ticketGroupingMode": "single_ticket",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "layoutMode": "dynamic",    "textSize": "small",    "displayTheme": "light",    "partialFulfillment": true,    "readyItemCount": 0,    "blockedItemCount": 0,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "tableLabel": "string",    "sectionId": "string",    "items": [      {        "id": "string",        "orderId": "string",        "orderNumber": 0,        "lineItemId": "string",        "parentItemId": "string",        "productId": "string",        "title": "string",        "salesCategory": "string",        "quantity": 1,        "course": "string",        "seatNumber": 1,        "stationId": "string",        "stationType": "prep",        "stationTitle": "string",        "fulfillmentMode": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "ticketDestination": "prep_only",        "itemStatus": "preview",        "fireAt": "2019-08-24T14:15:22Z",        "rushedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "prepTimeSeconds": 0,        "displayLabel": "string",        "displayCategory": "item",        "portionLabel": "string",        "stockAlert": "out_of_stock",        "fulfillmentState": "pending",        "readyForFulfillment": true,        "fulfillmentSequence": 1,        "fulfillmentSequenceTotal": 1,        "blockedByStationIds": [          "string"        ],        "blockedByStationTitles": [          "string"        ],        "otherStationIds": [          "string"        ],        "otherStationTitles": [          "string"        ],        "groupedItemIds": [          "string"        ],        "modifiers": [          "string"        ]      }    ]  },  "item": {    "id": "string",    "orderId": "string",    "orderNumber": 0,    "lineItemId": "string",    "parentItemId": "string",    "productId": "string",    "title": "string",    "salesCategory": "string",    "quantity": 1,    "course": "string",    "seatNumber": 1,    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "fulfillmentMode": "string",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "ticketDestination": "prep_only",    "itemStatus": "preview",    "fireAt": "2019-08-24T14:15:22Z",    "rushedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "prepTimeSeconds": 0,    "displayLabel": "string",    "displayCategory": "item",    "portionLabel": "string",    "stockAlert": "out_of_stock",    "fulfillmentState": "pending",    "readyForFulfillment": true,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "blockedByStationIds": [      "string"    ],    "blockedByStationTitles": [      "string"    ],    "otherStationIds": [      "string"    ],    "otherStationTitles": [      "string"    ],    "groupedItemIds": [      "string"    ],    "modifiers": [      "string"    ]  }}

Fire a held kitchen item

POST
/restaurant/kitchen/tickets/{id}/items/{itemId}/fire

Path Parameters

id*string
itemId*string

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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 POST "https://example.com/restaurant/kitchen/tickets/string/items/string/fire?locationId=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"
{  "ticket": {    "id": "string",    "locationId": "string",    "orderId": "string",    "orderNumber": 0,    "orderStatus": "string",    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "ticketState": "preview",    "fulfillmentMode": "string",    "paymentStatus": "paid",    "ageSeconds": 0,    "ageBucket": "new",    "headingColor": "default",    "ticketGroupingMode": "single_ticket",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "layoutMode": "dynamic",    "textSize": "small",    "displayTheme": "light",    "partialFulfillment": true,    "readyItemCount": 0,    "blockedItemCount": 0,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "tableLabel": "string",    "sectionId": "string",    "items": [      {        "id": "string",        "orderId": "string",        "orderNumber": 0,        "lineItemId": "string",        "parentItemId": "string",        "productId": "string",        "title": "string",        "salesCategory": "string",        "quantity": 1,        "course": "string",        "seatNumber": 1,        "stationId": "string",        "stationType": "prep",        "stationTitle": "string",        "fulfillmentMode": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "ticketDestination": "prep_only",        "itemStatus": "preview",        "fireAt": "2019-08-24T14:15:22Z",        "rushedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "prepTimeSeconds": 0,        "displayLabel": "string",        "displayCategory": "item",        "portionLabel": "string",        "stockAlert": "out_of_stock",        "fulfillmentState": "pending",        "readyForFulfillment": true,        "fulfillmentSequence": 1,        "fulfillmentSequenceTotal": 1,        "blockedByStationIds": [          "string"        ],        "blockedByStationTitles": [          "string"        ],        "otherStationIds": [          "string"        ],        "otherStationTitles": [          "string"        ],        "groupedItemIds": [          "string"        ],        "modifiers": [          "string"        ]      }    ]  },  "item": {    "id": "string",    "orderId": "string",    "orderNumber": 0,    "lineItemId": "string",    "parentItemId": "string",    "productId": "string",    "title": "string",    "salesCategory": "string",    "quantity": 1,    "course": "string",    "seatNumber": 1,    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "fulfillmentMode": "string",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "ticketDestination": "prep_only",    "itemStatus": "preview",    "fireAt": "2019-08-24T14:15:22Z",    "rushedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "prepTimeSeconds": 0,    "displayLabel": "string",    "displayCategory": "item",    "portionLabel": "string",    "stockAlert": "out_of_stock",    "fulfillmentState": "pending",    "readyForFulfillment": true,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "blockedByStationIds": [      "string"    ],    "blockedByStationTitles": [      "string"    ],    "otherStationIds": [      "string"    ],    "otherStationTitles": [      "string"    ],    "groupedItemIds": [      "string"    ],    "modifiers": [      "string"    ]  }}

Hold a kitchen item

POST
/restaurant/kitchen/tickets/{id}/items/{itemId}/hold

Path Parameters

id*string
itemId*string

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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 POST "https://example.com/restaurant/kitchen/tickets/string/items/string/hold?locationId=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"
{  "ticket": {    "id": "string",    "locationId": "string",    "orderId": "string",    "orderNumber": 0,    "orderStatus": "string",    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "ticketState": "preview",    "fulfillmentMode": "string",    "paymentStatus": "paid",    "ageSeconds": 0,    "ageBucket": "new",    "headingColor": "default",    "ticketGroupingMode": "single_ticket",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "layoutMode": "dynamic",    "textSize": "small",    "displayTheme": "light",    "partialFulfillment": true,    "readyItemCount": 0,    "blockedItemCount": 0,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "tableLabel": "string",    "sectionId": "string",    "items": [      {        "id": "string",        "orderId": "string",        "orderNumber": 0,        "lineItemId": "string",        "parentItemId": "string",        "productId": "string",        "title": "string",        "salesCategory": "string",        "quantity": 1,        "course": "string",        "seatNumber": 1,        "stationId": "string",        "stationType": "prep",        "stationTitle": "string",        "fulfillmentMode": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "ticketDestination": "prep_only",        "itemStatus": "preview",        "fireAt": "2019-08-24T14:15:22Z",        "rushedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "prepTimeSeconds": 0,        "displayLabel": "string",        "displayCategory": "item",        "portionLabel": "string",        "stockAlert": "out_of_stock",        "fulfillmentState": "pending",        "readyForFulfillment": true,        "fulfillmentSequence": 1,        "fulfillmentSequenceTotal": 1,        "blockedByStationIds": [          "string"        ],        "blockedByStationTitles": [          "string"        ],        "otherStationIds": [          "string"        ],        "otherStationTitles": [          "string"        ],        "groupedItemIds": [          "string"        ],        "modifiers": [          "string"        ]      }    ]  },  "item": {    "id": "string",    "orderId": "string",    "orderNumber": 0,    "lineItemId": "string",    "parentItemId": "string",    "productId": "string",    "title": "string",    "salesCategory": "string",    "quantity": 1,    "course": "string",    "seatNumber": 1,    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "fulfillmentMode": "string",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "ticketDestination": "prep_only",    "itemStatus": "preview",    "fireAt": "2019-08-24T14:15:22Z",    "rushedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "prepTimeSeconds": 0,    "displayLabel": "string",    "displayCategory": "item",    "portionLabel": "string",    "stockAlert": "out_of_stock",    "fulfillmentState": "pending",    "readyForFulfillment": true,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "blockedByStationIds": [      "string"    ],    "blockedByStationTitles": [      "string"    ],    "otherStationIds": [      "string"    ],    "otherStationTitles": [      "string"    ],    "groupedItemIds": [      "string"    ],    "modifiers": [      "string"    ]  }}

Rush a kitchen item

POST
/restaurant/kitchen/tickets/{id}/items/{itemId}/rush

Path Parameters

id*string
itemId*string

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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 POST "https://example.com/restaurant/kitchen/tickets/string/items/string/rush?locationId=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"
{  "ticket": {    "id": "string",    "locationId": "string",    "orderId": "string",    "orderNumber": 0,    "orderStatus": "string",    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "ticketState": "preview",    "fulfillmentMode": "string",    "paymentStatus": "paid",    "ageSeconds": 0,    "ageBucket": "new",    "headingColor": "default",    "ticketGroupingMode": "single_ticket",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "layoutMode": "dynamic",    "textSize": "small",    "displayTheme": "light",    "partialFulfillment": true,    "readyItemCount": 0,    "blockedItemCount": 0,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "tableLabel": "string",    "sectionId": "string",    "items": [      {        "id": "string",        "orderId": "string",        "orderNumber": 0,        "lineItemId": "string",        "parentItemId": "string",        "productId": "string",        "title": "string",        "salesCategory": "string",        "quantity": 1,        "course": "string",        "seatNumber": 1,        "stationId": "string",        "stationType": "prep",        "stationTitle": "string",        "fulfillmentMode": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "ticketDestination": "prep_only",        "itemStatus": "preview",        "fireAt": "2019-08-24T14:15:22Z",        "rushedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "prepTimeSeconds": 0,        "displayLabel": "string",        "displayCategory": "item",        "portionLabel": "string",        "stockAlert": "out_of_stock",        "fulfillmentState": "pending",        "readyForFulfillment": true,        "fulfillmentSequence": 1,        "fulfillmentSequenceTotal": 1,        "blockedByStationIds": [          "string"        ],        "blockedByStationTitles": [          "string"        ],        "otherStationIds": [          "string"        ],        "otherStationTitles": [          "string"        ],        "groupedItemIds": [          "string"        ],        "modifiers": [          "string"        ]      }    ]  },  "item": {    "id": "string",    "orderId": "string",    "orderNumber": 0,    "lineItemId": "string",    "parentItemId": "string",    "productId": "string",    "title": "string",    "salesCategory": "string",    "quantity": 1,    "course": "string",    "seatNumber": 1,    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "fulfillmentMode": "string",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "ticketDestination": "prep_only",    "itemStatus": "preview",    "fireAt": "2019-08-24T14:15:22Z",    "rushedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "prepTimeSeconds": 0,    "displayLabel": "string",    "displayCategory": "item",    "portionLabel": "string",    "stockAlert": "out_of_stock",    "fulfillmentState": "pending",    "readyForFulfillment": true,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "blockedByStationIds": [      "string"    ],    "blockedByStationTitles": [      "string"    ],    "otherStationIds": [      "string"    ],    "otherStationTitles": [      "string"    ],    "groupedItemIds": [      "string"    ],    "modifiers": [      "string"    ]  }}

Mark a kitchen item complete

POST
/restaurant/kitchen/tickets/{id}/items/{itemId}/complete

Path Parameters

id*string
itemId*string

Query Parameters

locationId*string
stationType?|
stationId?string
fulfillmentMode?||||
ticketState?||
includeCompleted?boolean

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 POST "https://example.com/restaurant/kitchen/tickets/string/items/string/complete?locationId=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"
{  "ticket": {    "id": "string",    "locationId": "string",    "orderId": "string",    "orderNumber": 0,    "orderStatus": "string",    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "ticketState": "preview",    "fulfillmentMode": "string",    "paymentStatus": "paid",    "ageSeconds": 0,    "ageBucket": "new",    "headingColor": "default",    "ticketGroupingMode": "single_ticket",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "layoutMode": "dynamic",    "textSize": "small",    "displayTheme": "light",    "partialFulfillment": true,    "readyItemCount": 0,    "blockedItemCount": 0,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "tableLabel": "string",    "sectionId": "string",    "items": [      {        "id": "string",        "orderId": "string",        "orderNumber": 0,        "lineItemId": "string",        "parentItemId": "string",        "productId": "string",        "title": "string",        "salesCategory": "string",        "quantity": 1,        "course": "string",        "seatNumber": 1,        "stationId": "string",        "stationType": "prep",        "stationTitle": "string",        "fulfillmentMode": "string",        "diningOption": "dine_in",        "diningOptionLabel": "string",        "ticketDestination": "prep_only",        "itemStatus": "preview",        "fireAt": "2019-08-24T14:15:22Z",        "rushedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "prepTimeSeconds": 0,        "displayLabel": "string",        "displayCategory": "item",        "portionLabel": "string",        "stockAlert": "out_of_stock",        "fulfillmentState": "pending",        "readyForFulfillment": true,        "fulfillmentSequence": 1,        "fulfillmentSequenceTotal": 1,        "blockedByStationIds": [          "string"        ],        "blockedByStationTitles": [          "string"        ],        "otherStationIds": [          "string"        ],        "otherStationTitles": [          "string"        ],        "groupedItemIds": [          "string"        ],        "modifiers": [          "string"        ]      }    ]  },  "item": {    "id": "string",    "orderId": "string",    "orderNumber": 0,    "lineItemId": "string",    "parentItemId": "string",    "productId": "string",    "title": "string",    "salesCategory": "string",    "quantity": 1,    "course": "string",    "seatNumber": 1,    "stationId": "string",    "stationType": "prep",    "stationTitle": "string",    "fulfillmentMode": "string",    "diningOption": "dine_in",    "diningOptionLabel": "string",    "ticketDestination": "prep_only",    "itemStatus": "preview",    "fireAt": "2019-08-24T14:15:22Z",    "rushedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "prepTimeSeconds": 0,    "displayLabel": "string",    "displayCategory": "item",    "portionLabel": "string",    "stockAlert": "out_of_stock",    "fulfillmentState": "pending",    "readyForFulfillment": true,    "fulfillmentSequence": 1,    "fulfillmentSequenceTotal": 1,    "blockedByStationIds": [      "string"    ],    "blockedByStationTitles": [      "string"    ],    "otherStationIds": [      "string"    ],    "otherStationTitles": [      "string"    ],    "groupedItemIds": [      "string"    ],    "modifiers": [      "string"    ]  }}

Get alternate payment types

GET
/config/v2/alternatePaymentTypes

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/alternatePaymentTypes" \  -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"
[]

Get an alternate payment type

GET
/config/v2/alternatePaymentTypes/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/alternatePaymentTypes/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"
{  "guid": "string",  "entityType": "AlternatePaymentType",  "externalId": "string",  "name": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get break types

GET
/config/v2/breakTypes

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/breakTypes" \  -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"
[]

Get a break type

GET
/config/v2/breakTypes/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/breakTypes/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"
{  "guid": "string",  "entityType": "BreakConfig",  "name": "string",  "active": true,  "paid": true,  "duration": 0,  "enforceMinimumTime": true,  "trackMissedBreaks": true,  "breakIntervalHrs": 0,  "breakIntervalMins": 0,  "trackBreakAcknowledgement": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get cash drawers

GET
/config/v2/cashDrawers

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/cashDrawers" \  -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"
[]

Get a cash drawer

GET
/config/v2/cashDrawers/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/cashDrawers/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"
{  "guid": "string",  "entityType": "CashDrawer",  "printer": {    "guid": "string",    "entityType": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get menus

GET
/config/v2/menus

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/menus" \  -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"
[]

Get a menus

GET
/config/v2/menus/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/menus/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"
null

Get menu items

GET
/config/v2/menuItems

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/menuItems" \  -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"
[]

Get a menu items

GET
/config/v2/menuItems/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/menuItems/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"
null

Get menu groups

GET
/config/v2/menuGroups

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/menuGroups" \  -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"
[]

Get a menu groups

GET
/config/v2/menuGroups/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/menuGroups/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"
null

Get menu option groups

GET
/config/v2/menuOptionGroups

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/menuOptionGroups" \  -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"
[]

Get a menu option groups

GET
/config/v2/menuOptionGroups/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/menuOptionGroups/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"
null

Get pre modifier groups

GET
/config/v2/preModifierGroups

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/preModifierGroups" \  -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"
[]

Get a pre modifier groups

GET
/config/v2/preModifierGroups/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/preModifierGroups/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"
null

Get pre modifiers

GET
/config/v2/preModifiers

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/preModifiers" \  -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"
[]

Get a pre modifiers

GET
/config/v2/preModifiers/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/preModifiers/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"
null

Get dining options

GET
/config/v2/diningOptions

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/diningOptions" \  -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"
[]

Create a dining option

POST
/config/v2/diningOptions

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/config/v2/diningOptions" \  -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 '{    "name": "string",    "behavior": "DINE_IN"  }'
{  "guid": "string",  "entityType": "DiningOption",  "externalId": "string",  "name": "string",  "behavior": "DINE_IN",  "curbside": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a dining option

GET
/config/v2/diningOptions/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/diningOptions/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"
{  "guid": "string",  "entityType": "DiningOption",  "externalId": "string",  "name": "string",  "behavior": "DINE_IN",  "curbside": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a dining option

DELETE
/config/v2/diningOptions/{guid}

Path Parameters

guid*string
Length1 <= length

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

curl -X DELETE "https://example.com/config/v2/diningOptions/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"
Empty

Update a dining option

PUT
/config/v2/diningOptions/{guid}

Path Parameters

guid*string
Length1 <= length

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/config/v2/diningOptions/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 '{    "name": "string",    "behavior": "DINE_IN"  }'
{  "guid": "string",  "entityType": "DiningOption",  "externalId": "string",  "name": "string",  "behavior": "DINE_IN",  "curbside": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get service areas

GET
/config/v2/serviceAreas

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/serviceAreas" \  -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"
[]

Get a service area

GET
/config/v2/serviceAreas/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/serviceAreas/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"
{  "guid": "string",  "entityType": "ServiceArea",  "name": "string",  "revenueCenter": {    "guid": "string",    "entityType": "string",    "externalId": "string"  }}

Get tables

GET
/config/v2/tables

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/tables" \  -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"
[]

Get a table

GET
/config/v2/tables/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/tables/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"
{  "guid": "string",  "entityType": "Table",  "name": "string",  "serviceArea": {    "guid": "string",    "entityType": "string"  },  "revenueCenter": {    "guid": "string",    "entityType": "string",    "externalId": "string"  }}

Get discount reasons

GET
/config/v2/discountReasons

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/discountReasons" \  -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"
[]

Get a discount reason

GET
/config/v2/discountReasons/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/discountReasons/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"
{  "guid": "string",  "entityType": "DiscountReason",  "name": "string",  "description": "string",  "active": true,  "deleted": true,  "sortOrder": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get discounts

GET
/config/v2/discounts

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/discounts" \  -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"
[]

Get a discount

GET
/config/v2/discounts/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/discounts/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"
{  "guid": "string",  "entityType": "Discount",  "amount": 0,  "selectionType": "string",  "promoCodes": [    {      "guid": "string",      "entityType": "string",      "code": "string",      "name": "string",      "usageType": "string"    }  ],  "nonExclusive": true,  "percentage": 0,  "name": "string",  "active": true,  "itemPickingPriority": "string",  "type": "string",  "fixedTotal": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get food waste reasons

GET
/config/v2/foodWasteReasons

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/foodWasteReasons" \  -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"
[]

Create a food waste reason

POST
/config/v2/foodWasteReasons

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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/config/v2/foodWasteReasons" \  -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 '{    "name": "string"  }'
{  "guid": "string",  "entityType": "FoodWasteReason",  "name": "string",  "description": "string",  "active": true,  "deleted": true,  "sortOrder": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a food waste reason

GET
/config/v2/foodWasteReasons/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/foodWasteReasons/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"
{  "guid": "string",  "entityType": "FoodWasteReason",  "name": "string",  "description": "string",  "active": true,  "deleted": true,  "sortOrder": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a food waste reason

DELETE
/config/v2/foodWasteReasons/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

curl -X DELETE "https://example.com/config/v2/foodWasteReasons/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"
Empty

Update a food waste reason

PUT
/config/v2/foodWasteReasons/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/config/v2/foodWasteReasons/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 '{}'
{  "guid": "string",  "entityType": "FoodWasteReason",  "name": "string",  "description": "string",  "active": true,  "deleted": true,  "sortOrder": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get front-of-house workflow configuration

GET
/config/v2/frontOfHouse

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/frontOfHouse" \  -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"
{  "guid": "string",  "entityType": "FrontOfHouseConfig",  "enableServerItemFiring": true,  "individuallyHoldAndSendItems": true,  "groupMenuItems": 0,  "showMenuItemSearch": true,  "showSentTimestamp": true,  "consolidateDiscounts": true,  "promptForEditOthersTable": true,  "searchPromoCode": true,  "sendChecksAfterPaymentOnly": true,  "closeOnPrint": true,  "manualEntryForScaleEnabled": true,  "autoSwitchUser": true,  "showTotalItemQuantity": true,  "tableServiceConfig": {    "chitPrinter": {      "guid": "string",      "name": "string"    },    "autoPrintChit": true,    "seatNumberBehavior": "REQUIRED",    "tableServiceCourseRequirementThreshold": 0  },  "quickOrderConfig": {    "seatNumberBehavior": "REQUIRED",    "sendButtons": [      "SEND"    ],    "fastCash": true,    "promptForTab": true,    "promptForDiningOption": true,    "quickOrderCourseRequirementThreshold": 0  },  "systemOptionGroupsModifyingItems": [    {      "type": "DINING_OPTION",      "enabled": true    }  ],  "isMenuItemSearchEnabled": true,  "showSpecialRequestPriceEntry": true,  "showSaagStockSection": true,  "isIdScanningEnabled": true,  "isIdScanningManagerApprovalEnabled": true,  "isDriveThruModeEnabled": true,  "isPromptForVehicleDescriptionEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update front-of-house workflow configuration

PUT
/config/v2/frontOfHouse

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/config/v2/frontOfHouse" \  -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 '{}'
{  "guid": "string",  "entityType": "FrontOfHouseConfig",  "enableServerItemFiring": true,  "individuallyHoldAndSendItems": true,  "groupMenuItems": 0,  "showMenuItemSearch": true,  "showSentTimestamp": true,  "consolidateDiscounts": true,  "promptForEditOthersTable": true,  "searchPromoCode": true,  "sendChecksAfterPaymentOnly": true,  "closeOnPrint": true,  "manualEntryForScaleEnabled": true,  "autoSwitchUser": true,  "showTotalItemQuantity": true,  "tableServiceConfig": {    "chitPrinter": {      "guid": "string",      "name": "string"    },    "autoPrintChit": true,    "seatNumberBehavior": "REQUIRED",    "tableServiceCourseRequirementThreshold": 0  },  "quickOrderConfig": {    "seatNumberBehavior": "REQUIRED",    "sendButtons": [      "SEND"    ],    "fastCash": true,    "promptForTab": true,    "promptForDiningOption": true,    "quickOrderCourseRequirementThreshold": 0  },  "systemOptionGroupsModifyingItems": [    {      "type": "DINING_OPTION",      "enabled": true    }  ],  "isMenuItemSearchEnabled": true,  "showSpecialRequestPriceEntry": true,  "showSaagStockSection": true,  "isIdScanningEnabled": true,  "isIdScanningManagerApprovalEnabled": true,  "isDriveThruModeEnabled": true,  "isPromptForVehicleDescriptionEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get published and draft front-of-house configuration

GET
/config/v2/frontOfHouse/workspace

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/frontOfHouse/workspace" \  -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"
{  "published": {    "guid": "string",    "entityType": "FrontOfHouseConfig",    "enableServerItemFiring": true,    "individuallyHoldAndSendItems": true,    "groupMenuItems": 0,    "showMenuItemSearch": true,    "showSentTimestamp": true,    "consolidateDiscounts": true,    "promptForEditOthersTable": true,    "searchPromoCode": true,    "sendChecksAfterPaymentOnly": true,    "closeOnPrint": true,    "manualEntryForScaleEnabled": true,    "autoSwitchUser": true,    "showTotalItemQuantity": true,    "tableServiceConfig": {      "chitPrinter": {        "guid": "string",        "name": "string"      },      "autoPrintChit": true,      "seatNumberBehavior": "REQUIRED",      "tableServiceCourseRequirementThreshold": 0    },    "quickOrderConfig": {      "seatNumberBehavior": "REQUIRED",      "sendButtons": [        "SEND"      ],      "fastCash": true,      "promptForTab": true,      "promptForDiningOption": true,      "quickOrderCourseRequirementThreshold": 0    },    "systemOptionGroupsModifyingItems": [      {        "type": "DINING_OPTION",        "enabled": true      }    ],    "isMenuItemSearchEnabled": true,    "showSpecialRequestPriceEntry": true,    "showSaagStockSection": true,    "isIdScanningEnabled": true,    "isIdScanningManagerApprovalEnabled": true,    "isDriveThruModeEnabled": true,    "isPromptForVehicleDescriptionEnabled": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "draft": {    "guid": "string",    "entityType": "FrontOfHouseConfig",    "enableServerItemFiring": true,    "individuallyHoldAndSendItems": true,    "groupMenuItems": 0,    "showMenuItemSearch": true,    "showSentTimestamp": true,    "consolidateDiscounts": true,    "promptForEditOthersTable": true,    "searchPromoCode": true,    "sendChecksAfterPaymentOnly": true,    "closeOnPrint": true,    "manualEntryForScaleEnabled": true,    "autoSwitchUser": true,    "showTotalItemQuantity": true,    "tableServiceConfig": {      "chitPrinter": {        "guid": "string",        "name": "string"      },      "autoPrintChit": true,      "seatNumberBehavior": "REQUIRED",      "tableServiceCourseRequirementThreshold": 0    },    "quickOrderConfig": {      "seatNumberBehavior": "REQUIRED",      "sendButtons": [        "SEND"      ],      "fastCash": true,      "promptForTab": true,      "promptForDiningOption": true,      "quickOrderCourseRequirementThreshold": 0    },    "systemOptionGroupsModifyingItems": [      {        "type": "DINING_OPTION",        "enabled": true      }    ],    "isMenuItemSearchEnabled": true,    "showSpecialRequestPriceEntry": true,    "showSaagStockSection": true,    "isIdScanningEnabled": true,    "isIdScanningManagerApprovalEnabled": true,    "isDriveThruModeEnabled": true,    "isPromptForVehicleDescriptionEnabled": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "hasUnpublishedChanges": true}

Save an unpublished front-of-house configuration draft

PUT
/config/v2/frontOfHouse/draft

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/config/v2/frontOfHouse/draft" \  -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 '{}'
{  "published": {    "guid": "string",    "entityType": "FrontOfHouseConfig",    "enableServerItemFiring": true,    "individuallyHoldAndSendItems": true,    "groupMenuItems": 0,    "showMenuItemSearch": true,    "showSentTimestamp": true,    "consolidateDiscounts": true,    "promptForEditOthersTable": true,    "searchPromoCode": true,    "sendChecksAfterPaymentOnly": true,    "closeOnPrint": true,    "manualEntryForScaleEnabled": true,    "autoSwitchUser": true,    "showTotalItemQuantity": true,    "tableServiceConfig": {      "chitPrinter": {        "guid": "string",        "name": "string"      },      "autoPrintChit": true,      "seatNumberBehavior": "REQUIRED",      "tableServiceCourseRequirementThreshold": 0    },    "quickOrderConfig": {      "seatNumberBehavior": "REQUIRED",      "sendButtons": [        "SEND"      ],      "fastCash": true,      "promptForTab": true,      "promptForDiningOption": true,      "quickOrderCourseRequirementThreshold": 0    },    "systemOptionGroupsModifyingItems": [      {        "type": "DINING_OPTION",        "enabled": true      }    ],    "isMenuItemSearchEnabled": true,    "showSpecialRequestPriceEntry": true,    "showSaagStockSection": true,    "isIdScanningEnabled": true,    "isIdScanningManagerApprovalEnabled": true,    "isDriveThruModeEnabled": true,    "isPromptForVehicleDescriptionEnabled": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "draft": {    "guid": "string",    "entityType": "FrontOfHouseConfig",    "enableServerItemFiring": true,    "individuallyHoldAndSendItems": true,    "groupMenuItems": 0,    "showMenuItemSearch": true,    "showSentTimestamp": true,    "consolidateDiscounts": true,    "promptForEditOthersTable": true,    "searchPromoCode": true,    "sendChecksAfterPaymentOnly": true,    "closeOnPrint": true,    "manualEntryForScaleEnabled": true,    "autoSwitchUser": true,    "showTotalItemQuantity": true,    "tableServiceConfig": {      "chitPrinter": {        "guid": "string",        "name": "string"      },      "autoPrintChit": true,      "seatNumberBehavior": "REQUIRED",      "tableServiceCourseRequirementThreshold": 0    },    "quickOrderConfig": {      "seatNumberBehavior": "REQUIRED",      "sendButtons": [        "SEND"      ],      "fastCash": true,      "promptForTab": true,      "promptForDiningOption": true,      "quickOrderCourseRequirementThreshold": 0    },    "systemOptionGroupsModifyingItems": [      {        "type": "DINING_OPTION",        "enabled": true      }    ],    "isMenuItemSearchEnabled": true,    "showSpecialRequestPriceEntry": true,    "showSaagStockSection": true,    "isIdScanningEnabled": true,    "isIdScanningManagerApprovalEnabled": true,    "isDriveThruModeEnabled": true,    "isPromptForVehicleDescriptionEnabled": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "hasUnpublishedChanges": true}

Publish the saved front-of-house configuration draft

POST
/config/v2/frontOfHouse/publish

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X POST "https://example.com/config/v2/frontOfHouse/publish" \  -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"
{  "published": {    "guid": "string",    "entityType": "FrontOfHouseConfig",    "enableServerItemFiring": true,    "individuallyHoldAndSendItems": true,    "groupMenuItems": 0,    "showMenuItemSearch": true,    "showSentTimestamp": true,    "consolidateDiscounts": true,    "promptForEditOthersTable": true,    "searchPromoCode": true,    "sendChecksAfterPaymentOnly": true,    "closeOnPrint": true,    "manualEntryForScaleEnabled": true,    "autoSwitchUser": true,    "showTotalItemQuantity": true,    "tableServiceConfig": {      "chitPrinter": {        "guid": "string",        "name": "string"      },      "autoPrintChit": true,      "seatNumberBehavior": "REQUIRED",      "tableServiceCourseRequirementThreshold": 0    },    "quickOrderConfig": {      "seatNumberBehavior": "REQUIRED",      "sendButtons": [        "SEND"      ],      "fastCash": true,      "promptForTab": true,      "promptForDiningOption": true,      "quickOrderCourseRequirementThreshold": 0    },    "systemOptionGroupsModifyingItems": [      {        "type": "DINING_OPTION",        "enabled": true      }    ],    "isMenuItemSearchEnabled": true,    "showSpecialRequestPriceEntry": true,    "showSaagStockSection": true,    "isIdScanningEnabled": true,    "isIdScanningManagerApprovalEnabled": true,    "isDriveThruModeEnabled": true,    "isPromptForVehicleDescriptionEnabled": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "draft": {    "guid": "string",    "entityType": "FrontOfHouseConfig",    "enableServerItemFiring": true,    "individuallyHoldAndSendItems": true,    "groupMenuItems": 0,    "showMenuItemSearch": true,    "showSentTimestamp": true,    "consolidateDiscounts": true,    "promptForEditOthersTable": true,    "searchPromoCode": true,    "sendChecksAfterPaymentOnly": true,    "closeOnPrint": true,    "manualEntryForScaleEnabled": true,    "autoSwitchUser": true,    "showTotalItemQuantity": true,    "tableServiceConfig": {      "chitPrinter": {        "guid": "string",        "name": "string"      },      "autoPrintChit": true,      "seatNumberBehavior": "REQUIRED",      "tableServiceCourseRequirementThreshold": 0    },    "quickOrderConfig": {      "seatNumberBehavior": "REQUIRED",      "sendButtons": [        "SEND"      ],      "fastCash": true,      "promptForTab": true,      "promptForDiningOption": true,      "quickOrderCourseRequirementThreshold": 0    },    "systemOptionGroupsModifyingItems": [      {        "type": "DINING_OPTION",        "enabled": true      }    ],    "isMenuItemSearchEnabled": true,    "showSpecialRequestPriceEntry": true,    "showSaagStockSection": true,    "isIdScanningEnabled": true,    "isIdScanningManagerApprovalEnabled": true,    "isDriveThruModeEnabled": true,    "isPromptForVehicleDescriptionEnabled": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "hasUnpublishedChanges": true}

Get front-of-house workflow configuration

GET
/restaurant/front-of-house/config

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/restaurant/front-of-house/config" \  -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"
{  "guid": "string",  "entityType": "FrontOfHouseConfig",  "enableServerItemFiring": true,  "individuallyHoldAndSendItems": true,  "groupMenuItems": 0,  "showMenuItemSearch": true,  "showSentTimestamp": true,  "consolidateDiscounts": true,  "promptForEditOthersTable": true,  "searchPromoCode": true,  "sendChecksAfterPaymentOnly": true,  "closeOnPrint": true,  "manualEntryForScaleEnabled": true,  "autoSwitchUser": true,  "showTotalItemQuantity": true,  "tableServiceConfig": {    "chitPrinter": {      "guid": "string",      "name": "string"    },    "autoPrintChit": true,    "seatNumberBehavior": "REQUIRED",    "tableServiceCourseRequirementThreshold": 0  },  "quickOrderConfig": {    "seatNumberBehavior": "REQUIRED",    "sendButtons": [      "SEND"    ],    "fastCash": true,    "promptForTab": true,    "promptForDiningOption": true,    "quickOrderCourseRequirementThreshold": 0  },  "systemOptionGroupsModifyingItems": [    {      "type": "DINING_OPTION",      "enabled": true    }  ],  "isMenuItemSearchEnabled": true,  "showSpecialRequestPriceEntry": true,  "showSaagStockSection": true,  "isIdScanningEnabled": true,  "isIdScanningManagerApprovalEnabled": true,  "isDriveThruModeEnabled": true,  "isPromptForVehicleDescriptionEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update front-of-house workflow configuration

PUT
/restaurant/front-of-house/config

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/restaurant/front-of-house/config" \  -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 '{}'
{  "guid": "string",  "entityType": "FrontOfHouseConfig",  "enableServerItemFiring": true,  "individuallyHoldAndSendItems": true,  "groupMenuItems": 0,  "showMenuItemSearch": true,  "showSentTimestamp": true,  "consolidateDiscounts": true,  "promptForEditOthersTable": true,  "searchPromoCode": true,  "sendChecksAfterPaymentOnly": true,  "closeOnPrint": true,  "manualEntryForScaleEnabled": true,  "autoSwitchUser": true,  "showTotalItemQuantity": true,  "tableServiceConfig": {    "chitPrinter": {      "guid": "string",      "name": "string"    },    "autoPrintChit": true,    "seatNumberBehavior": "REQUIRED",    "tableServiceCourseRequirementThreshold": 0  },  "quickOrderConfig": {    "seatNumberBehavior": "REQUIRED",    "sendButtons": [      "SEND"    ],    "fastCash": true,    "promptForTab": true,    "promptForDiningOption": true,    "quickOrderCourseRequirementThreshold": 0  },  "systemOptionGroupsModifyingItems": [    {      "type": "DINING_OPTION",      "enabled": true    }  ],  "isMenuItemSearchEnabled": true,  "showSpecialRequestPriceEntry": true,  "showSaagStockSection": true,  "isIdScanningEnabled": true,  "isIdScanningManagerApprovalEnabled": true,  "isDriveThruModeEnabled": true,  "isPromptForVehicleDescriptionEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get kitchen ticket and ticket screen configuration

GET
/config/v2/kitchenSetup

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/kitchenSetup" \  -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"
{  "guid": "string",  "entityType": "KitchenSetupConfig"}

Get kitchen ticket and ticket screen configuration

GET
/restaurant/kitchen-setup/config

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/restaurant/kitchen-setup/config" \  -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"
{  "guid": "string",  "entityType": "KitchenSetupConfig"}

Get service charges

GET
/config/v2/serviceCharges

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/serviceCharges" \  -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"
[]

Get a service charge type

GET
/config/v2/serviceCharges/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/serviceCharges/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"
{  "guid": "string",  "entityType": "ServiceCharge",  "externalId": "string",  "name": "string",  "amountType": "FIXED",  "amount": 0,  "percent": 0,  "criteria": {    "minCheckAmount": 0,    "delivery": true,    "maxCheckAmount": 0,    "minDeliveryDistance": 0,    "takeout": true,    "dineIn": true  },  "gratuity": true,  "taxable": true,  "applicableTaxes": [    {      "guid": "string",      "entityType": "string",      "externalId": "string",      "name": "string"    }  ],  "serviceChargeCalculation": "PRE_DISCOUNT",  "destination": "RESTAURANT",  "taxInclusive": true,  "taxProrated": true,  "active": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get void reasons

GET
/config/v2/voidReasons

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/voidReasons" \  -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"
[]

Get a void sale reason

GET
/config/v2/voidReasons/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/voidReasons/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"
{  "guid": "string",  "entityType": "VoidReason",  "name": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get no sale reasons

GET
/config/v2/noSaleReasons

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/noSaleReasons" \  -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"
[]

Get a no sale reason

GET
/config/v2/noSaleReasons/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/noSaleReasons/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"
{  "guid": "string",  "entityType": "NoSaleReason",  "name": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get payout reasons

GET
/config/v2/payoutReasons

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/payoutReasons" \  -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"
[]

Get a payout reason

GET
/config/v2/payoutReasons/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/payoutReasons/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"
{  "guid": "string",  "entityType": "PayoutReason",  "externalId": "string",  "name": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "active": true,  "classification": "string"}

Get price levels for menu items

GET
/config/v2/priceGroups

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/priceGroups" \  -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"
[]

Create a price level for menu items

POST
/config/v2/priceGroups

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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/config/v2/priceGroups" \  -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 '{    "name": "string"  }'
{  "guid": "string",  "entityType": "PriceGroup",  "name": "string",  "status": "active",  "active": true,  "adjustmentType": "percentage",  "adjustmentValue": 0,  "percentage": 0,  "amount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a price level for menu items

GET
/config/v2/priceGroups/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/priceGroups/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"
{  "guid": "string",  "entityType": "PriceGroup",  "name": "string",  "status": "active",  "active": true,  "adjustmentType": "percentage",  "adjustmentValue": 0,  "percentage": 0,  "amount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete an unassigned price level

DELETE
/config/v2/priceGroups/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

curl -X DELETE "https://example.com/config/v2/priceGroups/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"
Empty

Update a price level for menu items

PUT
/config/v2/priceGroups/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/config/v2/priceGroups/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 '{}'
{  "guid": "string",  "entityType": "PriceGroup",  "name": "string",  "status": "active",  "active": true,  "adjustmentType": "percentage",  "adjustmentValue": 0,  "percentage": 0,  "amount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get printers

GET
/config/v2/printers

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/printers" \  -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"
[]

Get a printer

GET
/config/v2/printers/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/printers/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"
{  "guid": "string",  "entityType": "Printer",  "name": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get guest receipt configuration

GET
/config/v2/receiptConfig

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/receiptConfig" \  -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"
{  "guid": "string",  "entityType": "ReceiptConfig"}

Get guest receipt configuration

GET
/restaurant/receipt-config

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/restaurant/receipt-config" \  -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"
{  "guid": "string",  "entityType": "ReceiptConfig"}

Get revenue centers

GET
/config/v2/revenueCenters

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/revenueCenters" \  -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"
[]

Create a revenue center

POST
/config/v2/revenueCenters

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/config/v2/revenueCenters" \  -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 '{    "name": "string"  }'
{  "guid": "string",  "entityType": "RevenueCenter",  "name": "string",  "description": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a revenue center

GET
/config/v2/revenueCenters/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/revenueCenters/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"
{  "guid": "string",  "entityType": "RevenueCenter",  "name": "string",  "description": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a revenue center

DELETE
/config/v2/revenueCenters/{guid}

Path Parameters

guid*string
Length1 <= length

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

curl -X DELETE "https://example.com/config/v2/revenueCenters/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"
Empty

Update a revenue center

PUT
/config/v2/revenueCenters/{guid}

Path Parameters

guid*string
Length1 <= length

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/config/v2/revenueCenters/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 '{    "name": "string"  }'
{  "guid": "string",  "entityType": "RevenueCenter",  "name": "string",  "description": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get restaurant service periods

GET
/config/v2/restaurantServices

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/restaurantServices" \  -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"
[]

Get a restaurant service period

GET
/config/v2/restaurantServices/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/restaurantServices/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"
{  "guid": "string",  "entityType": "RestaurantService",  "name": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get menu item sales categories

GET
/config/v2/salesCategories

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/salesCategories" \  -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"
[]

Get a menu item sales category

GET
/config/v2/salesCategories/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/salesCategories/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"
{  "guid": "string",  "entityType": "SalesCategory",  "name": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get tax rates

GET
/config/v2/taxRates

Query Parameters

pageToken?string
lastModified?string
Formatdate-time
locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/taxRates" \  -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"
[]

Get a tax rate

GET
/config/v2/taxRates/{guid}

Path Parameters

guid*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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/taxRates/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"
{  "guid": "string",  "entityType": "TaxRate",  "name": "string",  "isDefault": true,  "conditionalTaxRates": [    {      "condition": "string",      "rate": 0    }  ],  "taxTable": [    {      "start": 0,      "end": 0,      "tax": 0,      "pattern": true    }  ],  "rate": 0,  "roundingType": "string",  "type": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get the percentage withheld for credit card tips

GET
/config/v2/tipWithholding

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/tipWithholding" \  -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"
{  "guid": "string",  "entityType": "TipDistributionConfig",  "enabled": true,  "percentage": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get restaurant UI options configuration

GET
/config/v2/uiOptions

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/config/v2/uiOptions" \  -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"
{  "guid": "string",  "entityType": "UIOptionsConfig"}

Get restaurant UI options configuration

GET
/restaurant/ui-options/config

Query Parameters

locationId?string

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.

toast-restaurant-external-id?string

Response Body

application/json

curl -X GET "https://example.com/restaurant/ui-options/config" \  -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"
{  "guid": "string",  "entityType": "UIOptionsConfig"}

List canonical prep stations using the Toast Kitchen contract

GET
/kitchen/v1/published/prepStations

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.

toast-restaurant-external-id*string

Response Body

application/json

curl -X GET "https://example.com/kitchen/v1/published/prepStations" \  -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 "toast-restaurant-external-id: string"
[  null]

Get canonical packaging choices using the Toast Packaging contract

GET
/packaging/v1/published/packagingConfig

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.

toast-restaurant-external-id*string

Response Body

application/json

curl -X GET "https://example.com/packaging/v1/published/packagingConfig" \  -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 "toast-restaurant-external-id: string"
null

Get canonical online ordering availability using the Toast contract

GET
/restaurant-availability/v1/availability

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.

toast-restaurant-external-id*string

Response Body

application/json

curl -X GET "https://example.com/restaurant-availability/v1/availability" \  -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 "toast-restaurant-external-id: string"
null

Export Toast-compatible kitchen item fulfillment records

GET
/kitchen/v1/export/itemFulfillments

Query Parameters

businessDate*string
Match^\d{8}$

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.

toast-restaurant-external-id*string

Response Body

application/json

curl -X GET "https://example.com/kitchen/v1/export/itemFulfillments?businessDate=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 "toast-restaurant-external-id: string"
[  null]

Reservations

Previous Page

Shipping

Next Page