> ## Documentation Index > Fetch the complete documentation index at: https://docs.craveup.com/llms.txt > Use this file to discover all available pages before exploring further. # Evaluate a configured item's food from the same draft or released source as the menu preview ## OpenAPI ````yaml /generated/catalog-workspace.openapi.json post /api/v1/catalog/workspace/configuration-preview openapi: 3.0.3 info: title: Staff Menu Manager authoring version: 1.0.0 description: >- Persistent tenant-scoped library/relationship authoring and scoped publication review. Prices and POS structure retain their existing authority. Food Unknown is null; a nullable override inherits while [] disables inherited rules. Publication and menu-aware public serving activate together through S1. servers: [] security: [] paths: /api/v1/catalog/workspace/configuration-preview: post: summary: >- Evaluate a configured item's food from the same draft or released source as the menu preview operationId: catalogStaffConfigurationPreview parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StaffConfigurationPreviewRequest' responses: '200': description: >- Committed authoring evidence or read-only review; no publication is activated by a review. content: application/json: schema: $ref: '#/components/schemas/ConfiguredFoodEvaluation' '400': description: Invalid shape, units or identifier. '401': description: >- A current merchant staff session is required. Machine credentials are not admitted. '403': description: >- Current organization role/location grant or POS authority forbids the operation. '404': description: >- The record or location does not exist in the authorized tenant, or the location is outside the staff member's location grants (reported as not found, without foreign details). '409': description: >- CATALOG_DRAFT_STALE_REVISION: refresh the current draft before retrying. CATALOG_PUBLICATION_STALE_REVIEW: the requested release is not the target's active release. '422': description: >- Invalid references, non-ready publication evidence or semantic validation blockers. security: - StaffSession: [] components: schemas: StaffConfigurationPreviewRequest: type: object properties: menuId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ channel: type: string enum: - online - catering quantityUnit: type: string enum: - serving - person - item - dozen - tray - pack - lb - oz - kg - g - gallon - quart - liter - ml - fl_oz quantity: type: integer minimum: 1 maximum: 99 selections: default: [] maxItems: 50 type: array items: $ref: '#/components/schemas/SelectedModifierGroup' preferences: type: object properties: preferences: maxItems: 2 type: array items: type: string enum: - vegetarian - vegan avoidAllergenIds: maxItems: 14 type: array items: type: string enum: - milk - egg - fish - crustacean_shellfish - tree_nuts - peanut - wheat - soy - sesame - celery - mustard - lupin - molluscs - sulphites required: - preferences - avoidAllergenIds additionalProperties: false locationId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ productId: type: string minLength: 1 maxLength: 128 source: oneOf: - type: object properties: kind: type: string enum: - draft expectedDraftRevision: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - kind - expectedDraftRevision additionalProperties: false - type: object properties: kind: type: string enum: - released menuReleaseId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - kind - menuReleaseId additionalProperties: false at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ required: - menuId - channel - quantityUnit - quantity - preferences - locationId - productId - source additionalProperties: false ConfiguredFoodEvaluation: type: object properties: source: oneOf: - type: object properties: menuId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ locationId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ channel: type: string enum: - online - catering kind: type: string enum: - released menuReleaseId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - menuId - locationId - channel - kind - menuReleaseId additionalProperties: false - type: object properties: menuId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ locationId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ channel: type: string enum: - online - catering kind: type: string enum: - draft draftRevision: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - menuId - locationId - channel - kind - draftRevision additionalProperties: false contributions: maxItems: 10000 type: array items: type: object properties: entityId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ selectionPath: maxItems: 80 type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ fraction: type: object properties: numerator: type: number minimum: 0 denominator: type: number minimum: 0 exclusiveMinimum: true required: - numerator - denominator additionalProperties: false provenance: nullable: true oneOf: - type: object properties: kind: type: string enum: - entered required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - provider provider: type: string enum: - square - clover - toast revision: type: string minLength: 1 maxLength: 128 required: - kind - provider - revision additionalProperties: false - type: object properties: kind: type: string enum: - recipe servingsYield: type: number minimum: 0 exclusiveMinimum: true components: minItems: 1 maxItems: 100 type: array items: type: object properties: entityId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ fraction: type: object properties: numerator: type: number minimum: 0 denominator: type: number minimum: 0 exclusiveMinimum: true required: - numerator - denominator additionalProperties: false required: - entityId - fraction additionalProperties: false required: - kind - servingsYield - components additionalProperties: false nutrients: type: object properties: caloriesKcal: nullable: true type: number minimum: 0 proteinGrams: nullable: true type: number minimum: 0 carbohydrateGrams: nullable: true type: number minimum: 0 fatGrams: nullable: true type: number minimum: 0 fiberGrams: nullable: true type: number minimum: 0 sugarGrams: nullable: true type: number minimum: 0 saturatedFatGrams: nullable: true type: number minimum: 0 sodiumMilligrams: nullable: true type: number minimum: 0 required: - caloriesKcal - proteinGrams - carbohydrateGrams - fatGrams - fiberGrams - sugarGrams - saturatedFatGrams - sodiumMilligrams additionalProperties: false required: - entityId - selectionPath - fraction - provenance - nutrients additionalProperties: false serving: type: object properties: label: type: string minLength: 1 maxLength: 255 grams: nullable: true type: number minimum: 0 exclusiveMinimum: true required: - label - grams additionalProperties: false quantity: type: object properties: unit: type: string enum: - serving - person - item - dozen - tray - pack - lb - oz - kg - g - gallon - quart - liter - ml - fl_oz count: type: number minimum: 0 exclusiveMinimum: true maximum: 10000 required: - unit - count additionalProperties: false trayYield: nullable: true type: object properties: servingsPerTray: type: number minimum: 0 exclusiveMinimum: true required: - servingsPerTray additionalProperties: false perServing: type: object properties: caloriesKcal: nullable: true type: number minimum: 0 proteinGrams: nullable: true type: number minimum: 0 carbohydrateGrams: nullable: true type: number minimum: 0 fatGrams: nullable: true type: number minimum: 0 fiberGrams: nullable: true type: number minimum: 0 sugarGrams: nullable: true type: number minimum: 0 saturatedFatGrams: nullable: true type: number minimum: 0 sodiumMilligrams: nullable: true type: number minimum: 0 required: - caloriesKcal - proteinGrams - carbohydrateGrams - fatGrams - fiberGrams - sugarGrams - saturatedFatGrams - sodiumMilligrams additionalProperties: false perTray: nullable: true type: object properties: caloriesKcal: nullable: true type: number minimum: 0 proteinGrams: nullable: true type: number minimum: 0 carbohydrateGrams: nullable: true type: number minimum: 0 fatGrams: nullable: true type: number minimum: 0 fiberGrams: nullable: true type: number minimum: 0 sugarGrams: nullable: true type: number minimum: 0 saturatedFatGrams: nullable: true type: number minimum: 0 sodiumMilligrams: nullable: true type: number minimum: 0 required: - caloriesKcal - proteinGrams - carbohydrateGrams - fatGrams - fiberGrams - sugarGrams - saturatedFatGrams - sodiumMilligrams additionalProperties: false lineTotal: type: object properties: caloriesKcal: nullable: true type: number minimum: 0 proteinGrams: nullable: true type: number minimum: 0 carbohydrateGrams: nullable: true type: number minimum: 0 fatGrams: nullable: true type: number minimum: 0 fiberGrams: nullable: true type: number minimum: 0 sugarGrams: nullable: true type: number minimum: 0 saturatedFatGrams: nullable: true type: number minimum: 0 sodiumMilligrams: nullable: true type: number minimum: 0 required: - caloriesKcal - proteinGrams - carbohydrateGrams - fatGrams - fiberGrams - sugarGrams - saturatedFatGrams - sodiumMilligrams additionalProperties: false completeness: type: string enum: - complete - partial - unknown missing: maxItems: 10000 type: array items: type: object properties: entityId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ nutrient: type: string enum: - caloriesKcal - proteinGrams - carbohydrateGrams - fatGrams - fiberGrams - sugarGrams - saturatedFatGrams - sodiumMilligrams required: - entityId - nutrient additionalProperties: false warnings: maxItems: 10000 type: array items: type: object properties: code: type: string enum: - DIETARY_CONFLICT - ALLERGEN_PRESENT - ALLERGEN_POSSIBLE - DIETARY_INFORMATION_UNKNOWN entityId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ preferenceId: anyOf: - type: string enum: - vegetarian - vegan - type: string enum: - milk - egg - fish - crustacean_shellfish - tree_nuts - peanut - wheat - soy - sesame - celery - mustard - lupin - molluscs - sulphites selectionPath: maxItems: 80 type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - code - entityId - preferenceId - selectionPath additionalProperties: false required: - source - contributions - serving - quantity - trayYield - perServing - perTray - lineTotal - completeness - missing - warnings additionalProperties: false SelectedModifierGroup: type: object properties: groupId: type: string minLength: 1 maxLength: 128 selectedOptions: minItems: 0 maxItems: 50 type: array items: type: object properties: optionId: type: string minLength: 1 maxLength: 128 quantity: type: integer minimum: 1 maximum: 99 children: maxItems: 20 type: array items: $ref: '#/components/schemas/SelectedModifierGroup' required: - optionId - quantity additionalProperties: false required: - groupId - selectedOptions additionalProperties: false securitySchemes: StaffSession: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.