Catalog

List products

Commerce7 basis: Products, Collections, and Departments. This slice supports restaurant menu items, retail SKUs, modifiers, and gift card products.

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.

`application/json`

curl -X GET "https://example.com/catalog/products" \  -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"

{  "products": [    {      "id": "string",      "internalKey": "string",      "barcode": "string",      "sku": "string",      "title": "string",      "description": "string",      "posLabel": "string",      "kitchenLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "imageUrl": "string",      "imageUrls": [        "string"      ],      "tags": [        {          "id": "string",          "name": "string"        }      ],      "salesCategory": "string",      "plu": "string",      "calories": 0,      "nutrition": {        "calories": 0      },      "unitOfMeasure": "string",      "guestCount": 0,      "dimensions": {        "length": 0,        "width": 0,        "height": 0,        "unit": "string"      },      "weight": {        "value": 0,        "unit": "string"      },      "sortOrder": 0,      "discountable": true,      "deferredRevenue": true,      "contentAdvisories": {        "containsAlcohol": true      },      "taxRateIds": [        "string"      ],      "overrideItemTaxRates": true,      "kind": "restaurant_menu_item",      "status": "draft",      "category": "string",      "price": 0,      "pricingStrategy": "base",      "taxCode": "food",      "modifierGroupIds": [        "string"      ],      "trackInventory": true,      "availableLocationIds": [        "string"      ],      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "prepTimeSeconds": 0,      "portionIds": [        "string"      ],      "sizePricing": [        {          "sizeName": "string",          "price": 0        }      ],      "stockState": {        "mode": "in_stock",        "quantityRemaining": 0,        "locations": [          {            "locationId": "string",            "mode": "in_stock",            "quantityRemaining": 0          }        ]      },      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      },      "metadata": {        "property1": null,        "property2": null      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "page": {    "total": 0  }}

Create a product

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.

sku*string

title*string

description?string

posLabel?string

kitchenLabel?string

buttonColor?

imageUrl?string|null

imageUrls?array<string>

tags?array<>

salesCategory?string

plu?string

calories?integer

Range0 <= value

nutrition?

unitOfMeasure?string

guestCount?integer

Range0 <= value

dimensions?

weight?

sortOrder?integer

discountable?boolean

deferredRevenue?boolean

contentAdvisories?

taxRateIds?array<string>

overrideItemTaxRates?boolean

kind*|||

status?||

category*string

price*integer

pricingStrategy?||

taxCode*||||||

modifierGroupIds?array<string>

trackInventory*boolean

availableLocationIds*array<string>

visibility?

prepTimeSeconds?integer

Range0 <= value

portionIds?array<string>

sizePricing?array<>

stockState?

routing?

metadata?

`application/json`

curl -X POST "https://example.com/catalog/products" \  -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 '{    "sku": "string",    "title": "string",    "kind": "restaurant_menu_item",    "category": "string",    "price": 0,    "taxCode": "food",    "trackInventory": true,    "availableLocationIds": [      "string"    ]  }'

{  "id": "string",  "internalKey": "string",  "barcode": "string",  "sku": "string",  "title": "string",  "description": "string",  "posLabel": "string",  "kitchenLabel": "string",  "buttonColor": {    "light": "string",    "dark": "string"  },  "imageUrl": "string",  "imageUrls": [    "string"  ],  "tags": [    {      "id": "string",      "name": "string"    }  ],  "salesCategory": "string",  "plu": "string",  "calories": 0,  "nutrition": {    "calories": 0  },  "unitOfMeasure": "string",  "guestCount": 0,  "dimensions": {    "length": 0,    "width": 0,    "height": 0,    "unit": "string"  },  "weight": {    "value": 0,    "unit": "string"  },  "sortOrder": 0,  "discountable": true,  "deferredRevenue": true,  "contentAdvisories": {    "containsAlcohol": true  },  "taxRateIds": [    "string"  ],  "overrideItemTaxRates": true,  "kind": "restaurant_menu_item",  "status": "draft",  "category": "string",  "price": 0,  "pricingStrategy": "base",  "taxCode": "food",  "modifierGroupIds": [    "string"  ],  "trackInventory": true,  "availableLocationIds": [    "string"  ],  "visibility": {    "pos": true,    "online": true,    "kiosk": true,    "partners": true  },  "prepTimeSeconds": 0,  "portionIds": [    "string"  ],  "sizePricing": [    {      "sizeName": "string",      "price": 0    }  ],  "stockState": {    "mode": "in_stock",    "quantityRemaining": 0,    "locations": [      {        "locationId": "string",        "mode": "in_stock",        "quantityRemaining": 0      }    ]  },  "routing": {    "prepStationIds": [      "string"    ],    "assemblyLineId": "string",    "modifierRouting": "inherit",    "ticketDestination": "prep_only"  },  "metadata": {    "property1": null,    "property2": null  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Apply Quick Edit updates across products and menus

Toast-style Quick Edit support inside the existing catalog API. Supports bulk 86 and quantity mutations, menu availability changes, manager overrides, audit logging, and immediate inventory/kitchen propagation.

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.

locationId*string

managerOverrideStaffUserId?string

overrideReason?string

productUpdates?array<>

menuUpdates?array<>

Response Body

`application/json`

curl -X POST "https://example.com/catalog/quick-edit/bulk" \  -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"  }'

{  "authorization": {    "mode": "disabled",    "actorRoles": [      "string"    ],    "overrideStaffUserId": "string",    "overrideRoles": [      "string"    ]  },  "products": [    {      "id": "string",      "internalKey": "string",      "barcode": "string",      "sku": "string",      "title": "string",      "description": "string",      "posLabel": "string",      "kitchenLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "imageUrl": "string",      "imageUrls": [        "string"      ],      "tags": [        {          "id": "string",          "name": "string"        }      ],      "salesCategory": "string",      "plu": "string",      "calories": 0,      "nutrition": {        "calories": 0      },      "unitOfMeasure": "string",      "guestCount": 0,      "dimensions": {        "length": 0,        "width": 0,        "height": 0,        "unit": "string"      },      "weight": {        "value": 0,        "unit": "string"      },      "sortOrder": 0,      "discountable": true,      "deferredRevenue": true,      "contentAdvisories": {        "containsAlcohol": true      },      "taxRateIds": [        "string"      ],      "overrideItemTaxRates": true,      "kind": "restaurant_menu_item",      "status": "draft",      "category": "string",      "price": 0,      "pricingStrategy": "base",      "taxCode": "food",      "modifierGroupIds": [        "string"      ],      "trackInventory": true,      "availableLocationIds": [        "string"      ],      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "prepTimeSeconds": 0,      "portionIds": [        "string"      ],      "sizePricing": [        {          "sizeName": "string",          "price": 0        }      ],      "stockState": {        "mode": "in_stock",        "quantityRemaining": 0,        "locations": [          {            "locationId": "string",            "mode": "in_stock",            "quantityRemaining": 0          }        ]      },      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      },      "metadata": {        "property1": null,        "property2": null      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "menus": [    {      "id": "string",      "title": "string",      "icon": "string",      "description": "string",      "posLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "imageUrl": "string",      "highResImageUrl": "string",      "serviceType": "restaurant",      "locationIds": [        "string"      ],      "productIds": [        "string"      ],      "modifierGroups": [        {          "id": "string",          "title": "string",          "posLabel": "string",          "buttonColor": {            "light": "string",            "dark": "string"          },          "minSelections": 0,          "maxSelections": 0,          "sortOrder": 0,          "modifierProductIds": [            "string"          ],          "requiredMode": "REQUIRED",          "behavior": "required",          "pricingStrategy": "no_charge",          "groupPrice": 0,          "sizePrices": [            {              "sizeName": "string",              "price": 0,              "modifierPrices": [                {                  "modifierProductId": "string",                  "price": 0                }              ]            }          ],          "sequencePrices": [            {              "ordinal": 1,              "price": 0            }          ],          "sizeSequencePrices": [            {              "sizeName": "string",              "sequencePrices": [                {                  "ordinal": 1,                  "price": 0                }              ]            }          ],          "defaultModifierProductIds": [            "string"          ],          "allowDuplicates": true,          "maxDuplicateQuantity": 1,          "perModifierDuplicateLimits": [            {              "modifierProductId": "string",              "allowDuplicates": true,              "maxQuantity": 1            }          ],          "preModifierGroupId": "string",          "displayOrder": "listed",          "visibility": {            "pos": true,            "online": true,            "kiosk": true,            "partners": true          },          "prepMode": "integral",          "prepTimeSeconds": 0,          "defaultModifierPricingMode": "charge",          "enableSubstitutionPricing": true,          "sizeSelectionMode": "inherit_parent",          "portionIds": [            "string"          ],          "modifierItemReferences": [            {              "productId": "string",              "overrideName": "string",              "overrideBasePrice": 0,              "pricingStrategy": "base",              "menuPrices": [                {                  "menuId": "string",                  "price": 0                }              ],              "locationPrices": [                {                  "locationId": "string",                  "price": 0                }              ],              "sizePrices": [                {                  "sizeName": "string",                  "price": 0                }              ],              "timePrices": [                {                  "days": [                    "mon"                  ],                  "startTime": "string",                  "endTime": "string",                  "price": 0                }              ]            }          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "modifierRouting": "inherit",            "ticketDestination": "prep_only"          },          "basedOnMenuGroupId": "string",          "metadata": {            "property1": null,            "property2": null          }        }      ],      "groups": [        {          "id": "string",          "title": "string",          "icon": "string",          "subgroupIds": [            "string"          ],          "productIds": [            "string"          ],          "description": "string",          "posLabel": "string",          "buttonColor": {            "light": "string",            "dark": "string"          },          "imageUrl": "string",          "tags": [            {              "id": "string",              "name": "string"            }          ],          "visibility": {            "pos": true,            "online": true,            "kiosk": true,            "partners": true          },          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "modifierRouting": "inherit",            "ticketDestination": "prep_only"          },          "sortOrder": 0        }      ],      "preModifierGroups": [        {          "id": "string",          "title": "string",          "options": [            {              "id": "string",              "label": "string",              "posLabel": "string",              "buttonColor": {                "light": "string",                "dark": "string"              },              "position": "prefix",              "fixedPrice": 0,              "multiplicationFactor": 0,              "chargeAsExtra": true,              "plu": "string"            }          ]        }      ],      "portions": [        {          "id": "string",          "label": "string",          "posLabel": "string",          "priceMultiplier": 0,          "modifierGroupIds": [            "string"          ]        }      ],      "availability": [        {          "days": [            "mon"          ],          "startTime": "string",          "endTime": "string"        }      ],      "eligibility": {        "fulfillmentModes": [          "dine_in"        ],        "serviceModes": [          "table_service"        ],        "diningOptions": [          {            "behavior": "DINE_IN",            "curbside": true          }        ],        "dayparts": [          {            "id": "string",            "label": "string",            "availability": [              {                "days": [                  "mon"                ],                "startTime": "string",                "endTime": "string"              }            ]          }        ]      },      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "kitchen": {        "prepStations": [          {            "id": "string",            "title": "string",            "supportedFulfillmentModes": [              "dine_in"            ],            "fulfillmentTargets": [              "prep"            ],            "printingMode": "always",            "printerId": "string",            "expediterRouting": "send_to_expediter",            "connectedPrepStationIds": [              "string"            ]          }        ],        "assemblyLines": [          {            "id": "string",            "title": "string",            "prepStationIds": [              "string"            ]          }        ],        "itemRoutingRules": [          {            "id": "string",            "conditionType": "fulfillment_mode",            "conditionValue": "string",            "rerouteFromPrepStationId": "string",            "rerouteToPrepStationIds": [              "string"            ]          }        ],        "defaultModifierRouting": "with_parent",        "kdsTicketMode": "single_ticket",        "consolidateIdenticalItems": true,        "showOtherPrepStations": true,        "previewTickets": true,        "fireItemsByPrepTime": true,        "sendingCourses": "send_all_immediately",        "expediterCanFireAhead": true,        "heldTicketsVisibleOnPrep": true,        "kdsAppearance": {          "ticketLayout": "dynamic",          "rows": 1,          "columns": 1,          "textSize": "small",          "displayTheme": "light"        },        "courseFireSchedule": [          {            "course": "string",            "delaySeconds": 0          }        ]      },      "metadata": {        "property1": null,        "property2": null      },      "active": true    }  ],  "inventorySync": [    {      "productId": "string",      "inventoryItemId": "string",      "locationId": "string",      "onHand": 0,      "reserved": 0,      "available": 0,      "action": "Reset"    }  ],  "affectedOpenOrders": [    {      "orderId": "string",      "orderNumber": 0,      "status": "string",      "matchingProductIds": [        "string"      ]    }  ]}

Retrieve Toast-style open item settings for a location

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/catalog/open-items/settings?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",  "enabled": true,  "posOnly": true,  "allowCustomName": true,  "allowCustomPrice": true,  "allowOpenPriceItems": true,  "allowedRoles": [    "string"  ],  "allowedScopes": [    "food"  ],  "defaultScope": "food",  "scopeDefaults": [    {      "scope": "food",      "category": "string",      "salesCategory": "string",      "taxCode": "food",      "prepTimeSeconds": 0,      "modifierGroupIds": [        "string"      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      }    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update Toast-style open item settings for a location

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.

enabled?boolean

posOnly?boolean

allowCustomName?boolean

allowCustomPrice?boolean

allowOpenPriceItems?boolean

allowedRoles?array<string>

allowedScopes?array<||||>

defaultScope?||||

scopeDefaults?array<>

Response Body

`application/json`

curl -X PUT "https://example.com/catalog/open-items/settings?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 '{}'

{  "tenantId": "string",  "locationId": "string",  "enabled": true,  "posOnly": true,  "allowCustomName": true,  "allowCustomPrice": true,  "allowOpenPriceItems": true,  "allowedRoles": [    "string"  ],  "allowedScopes": [    "food"  ],  "defaultScope": "food",  "scopeDefaults": [    {      "scope": "food",      "category": "string",      "salesCategory": "string",      "taxCode": "food",      "prepTimeSeconds": 0,      "modifierGroupIds": [        "string"      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      }    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Retrieve a product

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/catalog/products/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",  "internalKey": "string",  "barcode": "string",  "sku": "string",  "title": "string",  "description": "string",  "posLabel": "string",  "kitchenLabel": "string",  "buttonColor": {    "light": "string",    "dark": "string"  },  "imageUrl": "string",  "imageUrls": [    "string"  ],  "tags": [    {      "id": "string",      "name": "string"    }  ],  "salesCategory": "string",  "plu": "string",  "calories": 0,  "nutrition": {    "calories": 0  },  "unitOfMeasure": "string",  "guestCount": 0,  "dimensions": {    "length": 0,    "width": 0,    "height": 0,    "unit": "string"  },  "weight": {    "value": 0,    "unit": "string"  },  "sortOrder": 0,  "discountable": true,  "deferredRevenue": true,  "contentAdvisories": {    "containsAlcohol": true  },  "taxRateIds": [    "string"  ],  "overrideItemTaxRates": true,  "kind": "restaurant_menu_item",  "status": "draft",  "category": "string",  "price": 0,  "pricingStrategy": "base",  "taxCode": "food",  "modifierGroupIds": [    "string"  ],  "trackInventory": true,  "availableLocationIds": [    "string"  ],  "visibility": {    "pos": true,    "online": true,    "kiosk": true,    "partners": true  },  "prepTimeSeconds": 0,  "portionIds": [    "string"  ],  "sizePricing": [    {      "sizeName": "string",      "price": 0    }  ],  "stockState": {    "mode": "in_stock",    "quantityRemaining": 0,    "locations": [      {        "locationId": "string",        "mode": "in_stock",        "quantityRemaining": 0      }    ]  },  "routing": {    "prepStationIds": [      "string"    ],    "assemblyLineId": "string",    "modifierRouting": "inherit",    "ticketDestination": "prep_only"  },  "metadata": {    "property1": null,    "property2": null  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update a product

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.

sku?string

title?string

description?string

posLabel?string

kitchenLabel?string

buttonColor?

imageUrl?string|null

imageUrls?array<string>

tags?array<>

salesCategory?string

plu?string

calories?integer

Range0 <= value

nutrition?

unitOfMeasure?string

guestCount?integer

Range0 <= value

dimensions?

weight?

sortOrder?integer

discountable?boolean

deferredRevenue?boolean

contentAdvisories?

taxRateIds?array<string>

overrideItemTaxRates?boolean

kind?|||

status?||

category?string

price?integer

pricingStrategy?||

taxCode?||||||

modifierGroupIds?array<string>

trackInventory?boolean

availableLocationIds?array<string>

visibility?

prepTimeSeconds?integer

Range0 <= value

portionIds?array<string>

sizePricing?array<>

stockState?

routing?

metadata?

Response Body

`application/json`

curl -X PUT "https://example.com/catalog/products/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",  "internalKey": "string",  "barcode": "string",  "sku": "string",  "title": "string",  "description": "string",  "posLabel": "string",  "kitchenLabel": "string",  "buttonColor": {    "light": "string",    "dark": "string"  },  "imageUrl": "string",  "imageUrls": [    "string"  ],  "tags": [    {      "id": "string",      "name": "string"    }  ],  "salesCategory": "string",  "plu": "string",  "calories": 0,  "nutrition": {    "calories": 0  },  "unitOfMeasure": "string",  "guestCount": 0,  "dimensions": {    "length": 0,    "width": 0,    "height": 0,    "unit": "string"  },  "weight": {    "value": 0,    "unit": "string"  },  "sortOrder": 0,  "discountable": true,  "deferredRevenue": true,  "contentAdvisories": {    "containsAlcohol": true  },  "taxRateIds": [    "string"  ],  "overrideItemTaxRates": true,  "kind": "restaurant_menu_item",  "status": "draft",  "category": "string",  "price": 0,  "pricingStrategy": "base",  "taxCode": "food",  "modifierGroupIds": [    "string"  ],  "trackInventory": true,  "availableLocationIds": [    "string"  ],  "visibility": {    "pos": true,    "online": true,    "kiosk": true,    "partners": true  },  "prepTimeSeconds": 0,  "portionIds": [    "string"  ],  "sizePricing": [    {      "sizeName": "string",      "price": 0    }  ],  "stockState": {    "mode": "in_stock",    "quantityRemaining": 0,    "locations": [      {        "locationId": "string",        "mode": "in_stock",        "quantityRemaining": 0      }    ]  },  "routing": {    "prepStationIds": [      "string"    ],    "assemblyLineId": "string",    "modifierRouting": "inherit",    "ticketDestination": "prep_only"  },  "metadata": {    "property1": null,    "property2": null  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List shared modifier groups

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/catalog/modifier-groups" \  -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"

{  "modifierGroups": [    {      "id": "string",      "title": "string",      "posLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "minSelections": 0,      "maxSelections": 0,      "sortOrder": 0,      "modifierProductIds": [        "string"      ],      "requiredMode": "REQUIRED",      "behavior": "required",      "pricingStrategy": "no_charge",      "groupPrice": 0,      "sizePrices": [        {          "sizeName": "string",          "price": 0,          "modifierPrices": [            {              "modifierProductId": "string",              "price": 0            }          ]        }      ],      "sequencePrices": [        {          "ordinal": 1,          "price": 0        }      ],      "sizeSequencePrices": [        {          "sizeName": "string",          "sequencePrices": [            {              "ordinal": 1,              "price": 0            }          ]        }      ],      "defaultModifierProductIds": [        "string"      ],      "allowDuplicates": true,      "maxDuplicateQuantity": 1,      "perModifierDuplicateLimits": [        {          "modifierProductId": "string",          "allowDuplicates": true,          "maxQuantity": 1        }      ],      "preModifierGroupId": "string",      "displayOrder": "listed",      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "prepMode": "integral",      "prepTimeSeconds": 0,      "defaultModifierPricingMode": "charge",      "enableSubstitutionPricing": true,      "sizeSelectionMode": "inherit_parent",      "portionIds": [        "string"      ],      "modifierItemReferences": [        {          "productId": "string",          "overrideName": "string",          "overrideBasePrice": 0,          "pricingStrategy": "base",          "menuPrices": [            {              "menuId": "string",              "price": 0            }          ],          "locationPrices": [            {              "locationId": "string",              "price": 0            }          ],          "sizePrices": [            {              "sizeName": "string",              "price": 0            }          ],          "timePrices": [            {              "days": [                "mon"              ],              "startTime": "string",              "endTime": "string",              "price": 0            }          ]        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      },      "basedOnMenuGroupId": "string",      "metadata": {        "property1": null,        "property2": null      }    }  ],  "page": {    "total": 0  }}

Create a shared modifier group

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.

title*string

Length1 <= length <= 160

posLabel?string

Lengthlength <= 160

minSelections*integer

Range0 <= value <= 100

maxSelections*integer

Range0 <= value <= 100

modifierProductIds*array<string>

Itemsitems <= 500

metadata?

Response Body

`application/json`

curl -X POST "https://example.com/catalog/modifier-groups" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "minSelections": 0,    "maxSelections": 0,    "modifierProductIds": [      "string"    ]  }'

{  "id": "string",  "title": "string",  "posLabel": "string",  "buttonColor": {    "light": "string",    "dark": "string"  },  "minSelections": 0,  "maxSelections": 0,  "sortOrder": 0,  "modifierProductIds": [    "string"  ],  "requiredMode": "REQUIRED",  "behavior": "required",  "pricingStrategy": "no_charge",  "groupPrice": 0,  "sizePrices": [    {      "sizeName": "string",      "price": 0,      "modifierPrices": [        {          "modifierProductId": "string",          "price": 0        }      ]    }  ],  "sequencePrices": [    {      "ordinal": 1,      "price": 0    }  ],  "sizeSequencePrices": [    {      "sizeName": "string",      "sequencePrices": [        {          "ordinal": 1,          "price": 0        }      ]    }  ],  "defaultModifierProductIds": [    "string"  ],  "allowDuplicates": true,  "maxDuplicateQuantity": 1,  "perModifierDuplicateLimits": [    {      "modifierProductId": "string",      "allowDuplicates": true,      "maxQuantity": 1    }  ],  "preModifierGroupId": "string",  "displayOrder": "listed",  "visibility": {    "pos": true,    "online": true,    "kiosk": true,    "partners": true  },  "prepMode": "integral",  "prepTimeSeconds": 0,  "defaultModifierPricingMode": "charge",  "enableSubstitutionPricing": true,  "sizeSelectionMode": "inherit_parent",  "portionIds": [    "string"  ],  "modifierItemReferences": [    {      "productId": "string",      "overrideName": "string",      "overrideBasePrice": 0,      "pricingStrategy": "base",      "menuPrices": [        {          "menuId": "string",          "price": 0        }      ],      "locationPrices": [        {          "locationId": "string",          "price": 0        }      ],      "sizePrices": [        {          "sizeName": "string",          "price": 0        }      ],      "timePrices": [        {          "days": [            "mon"          ],          "startTime": "string",          "endTime": "string",          "price": 0        }      ]    }  ],  "routing": {    "prepStationIds": [      "string"    ],    "assemblyLineId": "string",    "modifierRouting": "inherit",    "ticketDestination": "prep_only"  },  "basedOnMenuGroupId": "string",  "metadata": {    "property1": null,    "property2": null  }}

Delete a shared modifier group

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/catalog/modifier-groups/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 shared modifier group

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.

title?string

Length1 <= length <= 160

posLabel?string

Lengthlength <= 160

minSelections?integer

Range0 <= value <= 100

maxSelections?integer

Range0 <= value <= 100

modifierProductIds?array<string>

Itemsitems <= 500

metadata?

Response Body

`application/json`

curl -X PUT "https://example.com/catalog/modifier-groups/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "title": "string",  "posLabel": "string",  "buttonColor": {    "light": "string",    "dark": "string"  },  "minSelections": 0,  "maxSelections": 0,  "sortOrder": 0,  "modifierProductIds": [    "string"  ],  "requiredMode": "REQUIRED",  "behavior": "required",  "pricingStrategy": "no_charge",  "groupPrice": 0,  "sizePrices": [    {      "sizeName": "string",      "price": 0,      "modifierPrices": [        {          "modifierProductId": "string",          "price": 0        }      ]    }  ],  "sequencePrices": [    {      "ordinal": 1,      "price": 0    }  ],  "sizeSequencePrices": [    {      "sizeName": "string",      "sequencePrices": [        {          "ordinal": 1,          "price": 0        }      ]    }  ],  "defaultModifierProductIds": [    "string"  ],  "allowDuplicates": true,  "maxDuplicateQuantity": 1,  "perModifierDuplicateLimits": [    {      "modifierProductId": "string",      "allowDuplicates": true,      "maxQuantity": 1    }  ],  "preModifierGroupId": "string",  "displayOrder": "listed",  "visibility": {    "pos": true,    "online": true,    "kiosk": true,    "partners": true  },  "prepMode": "integral",  "prepTimeSeconds": 0,  "defaultModifierPricingMode": "charge",  "enableSubstitutionPricing": true,  "sizeSelectionMode": "inherit_parent",  "portionIds": [    "string"  ],  "modifierItemReferences": [    {      "productId": "string",      "overrideName": "string",      "overrideBasePrice": 0,      "pricingStrategy": "base",      "menuPrices": [        {          "menuId": "string",          "price": 0        }      ],      "locationPrices": [        {          "locationId": "string",          "price": 0        }      ],      "sizePrices": [        {          "sizeName": "string",          "price": 0        }      ],      "timePrices": [        {          "days": [            "mon"          ],          "startTime": "string",          "endTime": "string",          "price": 0        }      ]    }  ],  "routing": {    "prepStationIds": [      "string"    ],    "assemblyLineId": "string",    "modifierRouting": "inherit",    "ticketDestination": "prep_only"  },  "basedOnMenuGroupId": "string",  "metadata": {    "property1": null,    "property2": null  }}

List menus

Restaurant-focused menu composition with modifier groups. This is the bridge between retail catalog data and service-specific POS presentation.

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/catalog/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"

{  "menus": [    {      "id": "string",      "title": "string",      "icon": "string",      "description": "string",      "posLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "imageUrl": "string",      "highResImageUrl": "string",      "serviceType": "restaurant",      "locationIds": [        "string"      ],      "productIds": [        "string"      ],      "modifierGroups": [        {          "id": "string",          "title": "string",          "posLabel": "string",          "buttonColor": {            "light": "string",            "dark": "string"          },          "minSelections": 0,          "maxSelections": 0,          "sortOrder": 0,          "modifierProductIds": [            "string"          ],          "requiredMode": "REQUIRED",          "behavior": "required",          "pricingStrategy": "no_charge",          "groupPrice": 0,          "sizePrices": [            {              "sizeName": "string",              "price": 0,              "modifierPrices": [                {                  "modifierProductId": "string",                  "price": 0                }              ]            }          ],          "sequencePrices": [            {              "ordinal": 1,              "price": 0            }          ],          "sizeSequencePrices": [            {              "sizeName": "string",              "sequencePrices": [                {                  "ordinal": 1,                  "price": 0                }              ]            }          ],          "defaultModifierProductIds": [            "string"          ],          "allowDuplicates": true,          "maxDuplicateQuantity": 1,          "perModifierDuplicateLimits": [            {              "modifierProductId": "string",              "allowDuplicates": true,              "maxQuantity": 1            }          ],          "preModifierGroupId": "string",          "displayOrder": "listed",          "visibility": {            "pos": true,            "online": true,            "kiosk": true,            "partners": true          },          "prepMode": "integral",          "prepTimeSeconds": 0,          "defaultModifierPricingMode": "charge",          "enableSubstitutionPricing": true,          "sizeSelectionMode": "inherit_parent",          "portionIds": [            "string"          ],          "modifierItemReferences": [            {              "productId": "string",              "overrideName": "string",              "overrideBasePrice": 0,              "pricingStrategy": "base",              "menuPrices": [                {                  "menuId": "string",                  "price": 0                }              ],              "locationPrices": [                {                  "locationId": "string",                  "price": 0                }              ],              "sizePrices": [                {                  "sizeName": "string",                  "price": 0                }              ],              "timePrices": [                {                  "days": [                    "mon"                  ],                  "startTime": "string",                  "endTime": "string",                  "price": 0                }              ]            }          ],          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "modifierRouting": "inherit",            "ticketDestination": "prep_only"          },          "basedOnMenuGroupId": "string",          "metadata": {            "property1": null,            "property2": null          }        }      ],      "groups": [        {          "id": "string",          "title": "string",          "icon": "string",          "subgroupIds": [            "string"          ],          "productIds": [            "string"          ],          "description": "string",          "posLabel": "string",          "buttonColor": {            "light": "string",            "dark": "string"          },          "imageUrl": "string",          "tags": [            {              "id": "string",              "name": "string"            }          ],          "visibility": {            "pos": true,            "online": true,            "kiosk": true,            "partners": true          },          "routing": {            "prepStationIds": [              "string"            ],            "assemblyLineId": "string",            "modifierRouting": "inherit",            "ticketDestination": "prep_only"          },          "sortOrder": 0        }      ],      "preModifierGroups": [        {          "id": "string",          "title": "string",          "options": [            {              "id": "string",              "label": "string",              "posLabel": "string",              "buttonColor": {                "light": "string",                "dark": "string"              },              "position": "prefix",              "fixedPrice": 0,              "multiplicationFactor": 0,              "chargeAsExtra": true,              "plu": "string"            }          ]        }      ],      "portions": [        {          "id": "string",          "label": "string",          "posLabel": "string",          "priceMultiplier": 0,          "modifierGroupIds": [            "string"          ]        }      ],      "availability": [        {          "days": [            "mon"          ],          "startTime": "string",          "endTime": "string"        }      ],      "eligibility": {        "fulfillmentModes": [          "dine_in"        ],        "serviceModes": [          "table_service"        ],        "diningOptions": [          {            "behavior": "DINE_IN",            "curbside": true          }        ],        "dayparts": [          {            "id": "string",            "label": "string",            "availability": [              {                "days": [                  "mon"                ],                "startTime": "string",                "endTime": "string"              }            ]          }        ]      },      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "kitchen": {        "prepStations": [          {            "id": "string",            "title": "string",            "supportedFulfillmentModes": [              "dine_in"            ],            "fulfillmentTargets": [              "prep"            ],            "printingMode": "always",            "printerId": "string",            "expediterRouting": "send_to_expediter",            "connectedPrepStationIds": [              "string"            ]          }        ],        "assemblyLines": [          {            "id": "string",            "title": "string",            "prepStationIds": [              "string"            ]          }        ],        "itemRoutingRules": [          {            "id": "string",            "conditionType": "fulfillment_mode",            "conditionValue": "string",            "rerouteFromPrepStationId": "string",            "rerouteToPrepStationIds": [              "string"            ]          }        ],        "defaultModifierRouting": "with_parent",        "kdsTicketMode": "single_ticket",        "consolidateIdenticalItems": true,        "showOtherPrepStations": true,        "previewTickets": true,        "fireItemsByPrepTime": true,        "sendingCourses": "send_all_immediately",        "expediterCanFireAhead": true,        "heldTicketsVisibleOnPrep": true,        "kdsAppearance": {          "ticketLayout": "dynamic",          "rows": 1,          "columns": 1,          "textSize": "small",          "displayTheme": "light"        },        "courseFireSchedule": [          {            "course": "string",            "delaySeconds": 0          }        ]      },      "metadata": {        "property1": null,        "property2": null      },      "active": true    }  ],  "page": {    "total": 0  }}

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.

title*string

icon?string

Match^(?:lucide|lucide-lab):[a-z0-9]+(?:-[a-z0-9]+)*$

Lengthlength <= 80

description?string

posLabel?string

buttonColor?

imageUrl?string|null

highResImageUrl?string|null

serviceType*|

locationIds*array<string>

productIds*array<string>

modifierGroups*array<>

groups?array<>

preModifierGroups?array<>

portions?array<>

availability?array<>

eligibility?

visibility?

kitchen?

metadata?

active?boolean

Response Body

`application/json`

curl -X POST "https://example.com/catalog/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" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "serviceType": "restaurant",    "locationIds": [      "string"    ],    "productIds": [      "string"    ],    "modifierGroups": [      {        "id": "string",        "title": "string",        "minSelections": 0,        "maxSelections": 0,        "modifierProductIds": [          "string"        ]      }    ]  }'

{  "id": "string",  "title": "string",  "icon": "string",  "description": "string",  "posLabel": "string",  "buttonColor": {    "light": "string",    "dark": "string"  },  "imageUrl": "string",  "highResImageUrl": "string",  "serviceType": "restaurant",  "locationIds": [    "string"  ],  "productIds": [    "string"  ],  "modifierGroups": [    {      "id": "string",      "title": "string",      "posLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "minSelections": 0,      "maxSelections": 0,      "sortOrder": 0,      "modifierProductIds": [        "string"      ],      "requiredMode": "REQUIRED",      "behavior": "required",      "pricingStrategy": "no_charge",      "groupPrice": 0,      "sizePrices": [        {          "sizeName": "string",          "price": 0,          "modifierPrices": [            {              "modifierProductId": "string",              "price": 0            }          ]        }      ],      "sequencePrices": [        {          "ordinal": 1,          "price": 0        }      ],      "sizeSequencePrices": [        {          "sizeName": "string",          "sequencePrices": [            {              "ordinal": 1,              "price": 0            }          ]        }      ],      "defaultModifierProductIds": [        "string"      ],      "allowDuplicates": true,      "maxDuplicateQuantity": 1,      "perModifierDuplicateLimits": [        {          "modifierProductId": "string",          "allowDuplicates": true,          "maxQuantity": 1        }      ],      "preModifierGroupId": "string",      "displayOrder": "listed",      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "prepMode": "integral",      "prepTimeSeconds": 0,      "defaultModifierPricingMode": "charge",      "enableSubstitutionPricing": true,      "sizeSelectionMode": "inherit_parent",      "portionIds": [        "string"      ],      "modifierItemReferences": [        {          "productId": "string",          "overrideName": "string",          "overrideBasePrice": 0,          "pricingStrategy": "base",          "menuPrices": [            {              "menuId": "string",              "price": 0            }          ],          "locationPrices": [            {              "locationId": "string",              "price": 0            }          ],          "sizePrices": [            {              "sizeName": "string",              "price": 0            }          ],          "timePrices": [            {              "days": [                "mon"              ],              "startTime": "string",              "endTime": "string",              "price": 0            }          ]        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      },      "basedOnMenuGroupId": "string",      "metadata": {        "property1": null,        "property2": null      }    }  ],  "groups": [    {      "id": "string",      "title": "string",      "icon": "string",      "subgroupIds": [        "string"      ],      "productIds": [        "string"      ],      "description": "string",      "posLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "imageUrl": "string",      "tags": [        {          "id": "string",          "name": "string"        }      ],      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      },      "sortOrder": 0    }  ],  "preModifierGroups": [    {      "id": "string",      "title": "string",      "options": [        {          "id": "string",          "label": "string",          "posLabel": "string",          "buttonColor": {            "light": "string",            "dark": "string"          },          "position": "prefix",          "fixedPrice": 0,          "multiplicationFactor": 0,          "chargeAsExtra": true,          "plu": "string"        }      ]    }  ],  "portions": [    {      "id": "string",      "label": "string",      "posLabel": "string",      "priceMultiplier": 0,      "modifierGroupIds": [        "string"      ]    }  ],  "availability": [    {      "days": [        "mon"      ],      "startTime": "string",      "endTime": "string"    }  ],  "eligibility": {    "fulfillmentModes": [      "dine_in"    ],    "serviceModes": [      "table_service"    ],    "diningOptions": [      {        "behavior": "DINE_IN",        "curbside": true      }    ],    "dayparts": [      {        "id": "string",        "label": "string",        "availability": [          {            "days": [              "mon"            ],            "startTime": "string",            "endTime": "string"          }        ]      }    ]  },  "visibility": {    "pos": true,    "online": true,    "kiosk": true,    "partners": true  },  "kitchen": {    "prepStations": [      {        "id": "string",        "title": "string",        "supportedFulfillmentModes": [          "dine_in"        ],        "fulfillmentTargets": [          "prep"        ],        "printingMode": "always",        "printerId": "string",        "expediterRouting": "send_to_expediter",        "connectedPrepStationIds": [          "string"        ]      }    ],    "assemblyLines": [      {        "id": "string",        "title": "string",        "prepStationIds": [          "string"        ]      }    ],    "itemRoutingRules": [      {        "id": "string",        "conditionType": "fulfillment_mode",        "conditionValue": "string",        "rerouteFromPrepStationId": "string",        "rerouteToPrepStationIds": [          "string"        ]      }    ],    "defaultModifierRouting": "with_parent",    "kdsTicketMode": "single_ticket",    "consolidateIdenticalItems": true,    "showOtherPrepStations": true,    "previewTickets": true,    "fireItemsByPrepTime": true,    "sendingCourses": "send_all_immediately",    "expediterCanFireAhead": true,    "heldTicketsVisibleOnPrep": true,    "kdsAppearance": {      "ticketLayout": "dynamic",      "rows": 1,      "columns": 1,      "textSize": "small",      "displayTheme": "light"    },    "courseFireSchedule": [      {        "course": "string",        "delaySeconds": 0      }    ]  },  "metadata": {    "property1": null,    "property2": null  },  "active": true}

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/catalog/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"

{  "id": "string",  "title": "string",  "icon": "string",  "description": "string",  "posLabel": "string",  "buttonColor": {    "light": "string",    "dark": "string"  },  "imageUrl": "string",  "highResImageUrl": "string",  "serviceType": "restaurant",  "locationIds": [    "string"  ],  "productIds": [    "string"  ],  "modifierGroups": [    {      "id": "string",      "title": "string",      "posLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "minSelections": 0,      "maxSelections": 0,      "sortOrder": 0,      "modifierProductIds": [        "string"      ],      "requiredMode": "REQUIRED",      "behavior": "required",      "pricingStrategy": "no_charge",      "groupPrice": 0,      "sizePrices": [        {          "sizeName": "string",          "price": 0,          "modifierPrices": [            {              "modifierProductId": "string",              "price": 0            }          ]        }      ],      "sequencePrices": [        {          "ordinal": 1,          "price": 0        }      ],      "sizeSequencePrices": [        {          "sizeName": "string",          "sequencePrices": [            {              "ordinal": 1,              "price": 0            }          ]        }      ],      "defaultModifierProductIds": [        "string"      ],      "allowDuplicates": true,      "maxDuplicateQuantity": 1,      "perModifierDuplicateLimits": [        {          "modifierProductId": "string",          "allowDuplicates": true,          "maxQuantity": 1        }      ],      "preModifierGroupId": "string",      "displayOrder": "listed",      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "prepMode": "integral",      "prepTimeSeconds": 0,      "defaultModifierPricingMode": "charge",      "enableSubstitutionPricing": true,      "sizeSelectionMode": "inherit_parent",      "portionIds": [        "string"      ],      "modifierItemReferences": [        {          "productId": "string",          "overrideName": "string",          "overrideBasePrice": 0,          "pricingStrategy": "base",          "menuPrices": [            {              "menuId": "string",              "price": 0            }          ],          "locationPrices": [            {              "locationId": "string",              "price": 0            }          ],          "sizePrices": [            {              "sizeName": "string",              "price": 0            }          ],          "timePrices": [            {              "days": [                "mon"              ],              "startTime": "string",              "endTime": "string",              "price": 0            }          ]        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      },      "basedOnMenuGroupId": "string",      "metadata": {        "property1": null,        "property2": null      }    }  ],  "groups": [    {      "id": "string",      "title": "string",      "icon": "string",      "subgroupIds": [        "string"      ],      "productIds": [        "string"      ],      "description": "string",      "posLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "imageUrl": "string",      "tags": [        {          "id": "string",          "name": "string"        }      ],      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      },      "sortOrder": 0    }  ],  "preModifierGroups": [    {      "id": "string",      "title": "string",      "options": [        {          "id": "string",          "label": "string",          "posLabel": "string",          "buttonColor": {            "light": "string",            "dark": "string"          },          "position": "prefix",          "fixedPrice": 0,          "multiplicationFactor": 0,          "chargeAsExtra": true,          "plu": "string"        }      ]    }  ],  "portions": [    {      "id": "string",      "label": "string",      "posLabel": "string",      "priceMultiplier": 0,      "modifierGroupIds": [        "string"      ]    }  ],  "availability": [    {      "days": [        "mon"      ],      "startTime": "string",      "endTime": "string"    }  ],  "eligibility": {    "fulfillmentModes": [      "dine_in"    ],    "serviceModes": [      "table_service"    ],    "diningOptions": [      {        "behavior": "DINE_IN",        "curbside": true      }    ],    "dayparts": [      {        "id": "string",        "label": "string",        "availability": [          {            "days": [              "mon"            ],            "startTime": "string",            "endTime": "string"          }        ]      }    ]  },  "visibility": {    "pos": true,    "online": true,    "kiosk": true,    "partners": true  },  "kitchen": {    "prepStations": [      {        "id": "string",        "title": "string",        "supportedFulfillmentModes": [          "dine_in"        ],        "fulfillmentTargets": [          "prep"        ],        "printingMode": "always",        "printerId": "string",        "expediterRouting": "send_to_expediter",        "connectedPrepStationIds": [          "string"        ]      }    ],    "assemblyLines": [      {        "id": "string",        "title": "string",        "prepStationIds": [          "string"        ]      }    ],    "itemRoutingRules": [      {        "id": "string",        "conditionType": "fulfillment_mode",        "conditionValue": "string",        "rerouteFromPrepStationId": "string",        "rerouteToPrepStationIds": [          "string"        ]      }    ],    "defaultModifierRouting": "with_parent",    "kdsTicketMode": "single_ticket",    "consolidateIdenticalItems": true,    "showOtherPrepStations": true,    "previewTickets": true,    "fireItemsByPrepTime": true,    "sendingCourses": "send_all_immediately",    "expediterCanFireAhead": true,    "heldTicketsVisibleOnPrep": true,    "kdsAppearance": {      "ticketLayout": "dynamic",      "rows": 1,      "columns": 1,      "textSize": "small",      "displayTheme": "light"    },    "courseFireSchedule": [      {        "course": "string",        "delaySeconds": 0      }    ]  },  "metadata": {    "property1": null,    "property2": null  },  "active": true}

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/catalog/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"

Empty

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.

title?string

icon?string

Match^(?:lucide|lucide-lab):[a-z0-9]+(?:-[a-z0-9]+)*$

Lengthlength <= 80

description?string

posLabel?string

buttonColor?

imageUrl?string|null

highResImageUrl?string|null

serviceType?|

locationIds?array<string>

productIds?array<string>

modifierGroups?array<>

groups?array<>

preModifierGroups?array<>

portions?array<>

availability?array<>

eligibility?

visibility?

kitchen?

metadata?

active?boolean

Response Body

`application/json`

curl -X PUT "https://example.com/catalog/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" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "title": "string",  "icon": "string",  "description": "string",  "posLabel": "string",  "buttonColor": {    "light": "string",    "dark": "string"  },  "imageUrl": "string",  "highResImageUrl": "string",  "serviceType": "restaurant",  "locationIds": [    "string"  ],  "productIds": [    "string"  ],  "modifierGroups": [    {      "id": "string",      "title": "string",      "posLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "minSelections": 0,      "maxSelections": 0,      "sortOrder": 0,      "modifierProductIds": [        "string"      ],      "requiredMode": "REQUIRED",      "behavior": "required",      "pricingStrategy": "no_charge",      "groupPrice": 0,      "sizePrices": [        {          "sizeName": "string",          "price": 0,          "modifierPrices": [            {              "modifierProductId": "string",              "price": 0            }          ]        }      ],      "sequencePrices": [        {          "ordinal": 1,          "price": 0        }      ],      "sizeSequencePrices": [        {          "sizeName": "string",          "sequencePrices": [            {              "ordinal": 1,              "price": 0            }          ]        }      ],      "defaultModifierProductIds": [        "string"      ],      "allowDuplicates": true,      "maxDuplicateQuantity": 1,      "perModifierDuplicateLimits": [        {          "modifierProductId": "string",          "allowDuplicates": true,          "maxQuantity": 1        }      ],      "preModifierGroupId": "string",      "displayOrder": "listed",      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "prepMode": "integral",      "prepTimeSeconds": 0,      "defaultModifierPricingMode": "charge",      "enableSubstitutionPricing": true,      "sizeSelectionMode": "inherit_parent",      "portionIds": [        "string"      ],      "modifierItemReferences": [        {          "productId": "string",          "overrideName": "string",          "overrideBasePrice": 0,          "pricingStrategy": "base",          "menuPrices": [            {              "menuId": "string",              "price": 0            }          ],          "locationPrices": [            {              "locationId": "string",              "price": 0            }          ],          "sizePrices": [            {              "sizeName": "string",              "price": 0            }          ],          "timePrices": [            {              "days": [                "mon"              ],              "startTime": "string",              "endTime": "string",              "price": 0            }          ]        }      ],      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      },      "basedOnMenuGroupId": "string",      "metadata": {        "property1": null,        "property2": null      }    }  ],  "groups": [    {      "id": "string",      "title": "string",      "icon": "string",      "subgroupIds": [        "string"      ],      "productIds": [        "string"      ],      "description": "string",      "posLabel": "string",      "buttonColor": {        "light": "string",        "dark": "string"      },      "imageUrl": "string",      "tags": [        {          "id": "string",          "name": "string"        }      ],      "visibility": {        "pos": true,        "online": true,        "kiosk": true,        "partners": true      },      "routing": {        "prepStationIds": [          "string"        ],        "assemblyLineId": "string",        "modifierRouting": "inherit",        "ticketDestination": "prep_only"      },      "sortOrder": 0    }  ],  "preModifierGroups": [    {      "id": "string",      "title": "string",      "options": [        {          "id": "string",          "label": "string",          "posLabel": "string",          "buttonColor": {            "light": "string",            "dark": "string"          },          "position": "prefix",          "fixedPrice": 0,          "multiplicationFactor": 0,          "chargeAsExtra": true,          "plu": "string"        }      ]    }  ],  "portions": [    {      "id": "string",      "label": "string",      "posLabel": "string",      "priceMultiplier": 0,      "modifierGroupIds": [        "string"      ]    }  ],  "availability": [    {      "days": [        "mon"      ],      "startTime": "string",      "endTime": "string"    }  ],  "eligibility": {    "fulfillmentModes": [      "dine_in"    ],    "serviceModes": [      "table_service"    ],    "diningOptions": [      {        "behavior": "DINE_IN",        "curbside": true      }    ],    "dayparts": [      {        "id": "string",        "label": "string",        "availability": [          {            "days": [              "mon"            ],            "startTime": "string",            "endTime": "string"          }        ]      }    ]  },  "visibility": {    "pos": true,    "online": true,    "kiosk": true,    "partners": true  },  "kitchen": {    "prepStations": [      {        "id": "string",        "title": "string",        "supportedFulfillmentModes": [          "dine_in"        ],        "fulfillmentTargets": [          "prep"        ],        "printingMode": "always",        "printerId": "string",        "expediterRouting": "send_to_expediter",        "connectedPrepStationIds": [          "string"        ]      }    ],    "assemblyLines": [      {        "id": "string",        "title": "string",        "prepStationIds": [          "string"        ]      }    ],    "itemRoutingRules": [      {        "id": "string",        "conditionType": "fulfillment_mode",        "conditionValue": "string",        "rerouteFromPrepStationId": "string",        "rerouteToPrepStationIds": [          "string"        ]      }    ],    "defaultModifierRouting": "with_parent",    "kdsTicketMode": "single_ticket",    "consolidateIdenticalItems": true,    "showOtherPrepStations": true,    "previewTickets": true,    "fireItemsByPrepTime": true,    "sendingCourses": "send_all_immediately",    "expediterCanFireAhead": true,    "heldTicketsVisibleOnPrep": true,    "kdsAppearance": {      "ticketLayout": "dynamic",      "rows": 1,      "columns": 1,      "textSize": "small",      "displayTheme": "light"    },    "courseFireSchedule": [      {        "course": "string",        "delaySeconds": 0      }    ]  },  "metadata": {    "property1": null,    "property2": null  },  "active": true}

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/catalog/menus/string/publication" \  -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"

{  "menuId": "string",  "draft": {    "id": "string",    "menuId": "string",    "revisionNumber": 0,    "version": 0,    "status": "draft",    "definition": {      "property1": null,      "property2": null    },    "baseMenuUpdatedAt": "2019-08-24T14:15:22Z",    "reviewedAt": "2019-08-24T14:15:22Z",    "publishedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "published": {    "id": "string",    "menuId": "string",    "revisionNumber": 0,    "version": 0,    "status": "draft",    "definition": {      "property1": null,      "property2": null    },    "baseMenuUpdatedAt": "2019-08-24T14:15:22Z",    "reviewedAt": "2019-08-24T14:15:22Z",    "publishedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "revisions": [    {      "id": "string",      "menuId": "string",      "revisionNumber": 0,      "version": 0,      "status": "draft",      "definition": {        "property1": null,        "property2": null      },      "baseMenuUpdatedAt": "2019-08-24T14:15:22Z",      "reviewedAt": "2019-08-24T14:15:22Z",      "publishedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

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.

expectedVersion*integer

Range0 <= value

changes*

Response Body

`application/json`

curl -X PUT "https://example.com/catalog/menus/string/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 '{    "expectedVersion": 0,    "changes": {      "property1": null,      "property2": null    }  }'

{  "id": "string",  "menuId": "string",  "revisionNumber": 0,  "version": 0,  "status": "draft",  "definition": {    "property1": null,    "property2": null  },  "baseMenuUpdatedAt": "2019-08-24T14:15:22Z",  "reviewedAt": "2019-08-24T14:15:22Z",  "publishedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

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.

expectedVersion*integer

Range1 <= value

Response Body

`application/json`

curl -X POST "https://example.com/catalog/menus/string/review" \  -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 '{    "expectedVersion": 1  }'

{  "id": "string",  "menuId": "string",  "revisionNumber": 0,  "version": 0,  "status": "draft",  "definition": {    "property1": null,    "property2": null  },  "baseMenuUpdatedAt": "2019-08-24T14:15:22Z",  "reviewedAt": "2019-08-24T14:15:22Z",  "publishedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

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.

idempotency-key*string

Length8 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

expectedVersion*integer

Range1 <= value

Response Body

`application/json`

curl -X POST "https://example.com/catalog/menus/string/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" \  -H "idempotency-key: stringst" \  -H "Content-Type: application/json" \  -d '{    "expectedVersion": 1  }'

{  "property1": null,  "property2": null}

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.

idempotency-key*string

Length8 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

revisionId*string

expectedCurrentRevisionId*string

Response Body

`application/json`

curl -X POST "https://example.com/catalog/menus/string/rollback" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "idempotency-key: stringst" \  -H "Content-Type: application/json" \  -d '{    "revisionId": "string",    "expectedCurrentRevisionId": "string"  }'

{  "property1": null,  "property2": null}

Path Parameters

kind*||||

Query Parameters

locationId*string

Length1 <= length

restaurantGuid?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/catalog/menu-settings/sales-categories?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"

{  "settings": [    {      "id": "string",      "kind": "sales-categories",      "name": "string",      "description": "string",      "status": "active",      "sortOrder": 0,      "metadata": {},      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Path Parameters

kind*||||

Query Parameters

locationId*string

Length1 <= length

restaurantGuid?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.

name*string

Length1 <= length <= 160

description?string

Lengthlength <= 500

status?|

sortOrder?integer

metadata?

Response Body

`application/json`

curl -X POST "https://example.com/catalog/menu-settings/sales-categories?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 '{    "name": "string"  }'

{  "id": "string",  "kind": "sales-categories",  "name": "string",  "description": "string",  "status": "active",  "sortOrder": 0,  "metadata": {},  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Path Parameters

kind*||||

Query Parameters

locationId*string

Length1 <= length

restaurantGuid?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.

orderedIds*array<>

Items1 <= items <= 300

Response Body

`application/json`

curl -X PUT "https://example.com/catalog/menu-settings/sales-categories/order?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 '{    "orderedIds": [      "string"    ]  }'

{  "settings": [    {      "id": "string",      "kind": "sales-categories",      "name": "string",      "description": "string",      "status": "active",      "sortOrder": 0,      "metadata": {},      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Path Parameters

kind*||||

id*string

Length1 <= length

Query Parameters

locationId*string

Length1 <= length

restaurantGuid?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.

name?string

Length1 <= length <= 160

description?string

Lengthlength <= 500

status?|

sortOrder?integer

metadata?

Response Body

`application/json`

curl -X PUT "https://example.com/catalog/menu-settings/sales-categories/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" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "kind": "sales-categories",  "name": "string",  "description": "string",  "status": "active",  "sortOrder": 0,  "metadata": {},  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get the currently published Toast Menus V3 catalog

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/menus/v3/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" \  -H "toast-restaurant-external-id: string"

null

Get the Toast Menus V3 publication timestamp

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/menus/v3/metadata" \  -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 the canonical published catalog using the Toast Menus V2 contract

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/menus/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" \  -H "toast-restaurant-external-id: string"

null

Get the canonical Toast Menus V2 publication timestamp

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/menus/v2/metadata" \  -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

200application/json

201application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

201application/json

204

200application/json

200application/json

201application/json

200application/json

204

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

201application/json

200application/json

200application/json

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`