> ## 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. # Preview one selected menu at one location/channel/time from its draft revision or an active release ## OpenAPI ````yaml /generated/catalog-workspace.openapi.json post /api/v1/catalog/workspace/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/preview: post: summary: >- Preview one selected menu at one location/channel/time from its draft revision or an active release operationId: catalogResolvedPreview parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CatalogResolvedPreviewRequest' responses: '200': description: >- Committed authoring evidence or read-only review; no publication is activated by a review. content: application/json: schema: $ref: '#/components/schemas/CatalogResolvedPreviewResult' '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. '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: CatalogResolvedPreviewRequest: 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 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)))$ 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 required: - menuId - locationId - channel - at - source additionalProperties: false CatalogResolvedPreviewResult: type: object properties: target: 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 required: - menuId - locationId - channel additionalProperties: false source: oneOf: - type: object properties: kind: type: string enum: - draft draftRevision: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - kind - draftRevision 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)$ targetRevision: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 draftRevision: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 publishedAt: 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: - kind - menuReleaseId - targetRevision - draftRevision - publishedAt 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)))$ valid: type: boolean blockers: maxItems: 10000 type: array items: type: object properties: severity: type: string enum: - blocker - content_warning code: type: string minLength: 1 maxLength: 128 entityKind: type: string minLength: 1 maxLength: 64 entityId: type: string maxLength: 256 path: type: string maxLength: 512 required: - severity - code - entityKind - entityId - path additionalProperties: false contentWarnings: maxItems: 10000 type: array items: type: object properties: severity: type: string enum: - blocker - content_warning code: type: string minLength: 1 maxLength: 128 entityKind: type: string minLength: 1 maxLength: 64 entityId: type: string maxLength: 256 path: type: string maxLength: 512 required: - severity - code - entityKind - entityId - path additionalProperties: false menu: nullable: true type: object properties: canonicalId: type: string minLength: 1 maxLength: 128 name: type: string description: type: string image: nullable: true type: object properties: url: type: string altText: type: string required: - url - altText additionalProperties: false categories: type: array items: type: object properties: canonicalId: type: string minLength: 1 maxLength: 128 name: type: string parentCategoryId: nullable: true type: string minLength: 1 maxLength: 128 products: type: array items: type: object properties: canonicalId: type: string minLength: 1 maxLength: 128 name: type: string description: type: string images: type: array items: type: object properties: url: type: string altText: type: string required: - url - altText additionalProperties: false price: nullable: true type: object properties: amount: type: string pattern: ^(0|[1-9]\d*)(?:\.\d{1,4})?$ currency: type: string pattern: ^[A-Z]{3}$ source: type: string enum: - crave - provider required: - amount - currency - source additionalProperties: false sellability: type: object properties: sellable: type: boolean blockReasons: type: array items: type: string enum: - ORGANIZATION_ENTITY_INACTIVE - MENU_NOT_ASSIGNED - LOCATION_INACTIVE - LOCATION_OPERATING_SCHEDULE_CLOSED - LOCATION_FULFILLMENT_UNAVAILABLE - PROVIDER_LOCATION_MISSING - RESTAURANT_NOT_ACCEPTING_ORDERS - FULFILLMENT_SCHEDULE_CLOSED - MENU_ITEM_SCHEDULE_CLOSED - PROVIDER_ITEM_UNAVAILABLE - PROVIDER_ITEM_SOLD_OUT - LOCATION_AVAILABILITY_RESTRICTED - LOCATION_SCHEDULE_RESTRICTED - PROVIDER_MAPPING_INCOMPLETE - PROVIDER_PROJECTION_TOMBSTONED - PROVIDER_STATE_STALE - REQUIRED_MODIFIER_UNAVAILABLE required: - sellable - blockReasons additionalProperties: false availabilityEvidence: type: object properties: locationAvailability: nullable: true type: string enum: - available - unavailable - sold_out_until soldOutUntil: nullable: true 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: - locationAvailability - soldOutUntil additionalProperties: false scheduleEvidence: type: object properties: providerFulfillment: nullable: true type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false providerMenuItem: nullable: true type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false locationOperating: type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false locationFulfillment: type: array items: nullable: true type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false locationRestrictions: type: array items: type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false required: - providerFulfillment - providerMenuItem - locationOperating - locationFulfillment - locationRestrictions additionalProperties: false modifierGroups: type: array items: $ref: '#/components/schemas/ResolvedModifierGroup' required: - canonicalId - name - description - images - price - sellability - availabilityEvidence - scheduleEvidence - modifierGroups additionalProperties: false required: - canonicalId - name - parentCategoryId - products additionalProperties: false required: - canonicalId - name - description - image - categories additionalProperties: false food: type: object additionalProperties: type: object properties: foodFacts: nullable: true type: object properties: 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 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 provenance: 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 includedComponentIds: maxItems: 1000 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)$ suitability: type: object properties: vegetarian: type: string enum: - suitable - unsuitable - unknown vegan: type: string enum: - suitable - unsuitable - unknown required: - vegetarian - vegan additionalProperties: false ingredients: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 allergens: maxItems: 14 type: array items: type: object properties: allergenId: type: string enum: - milk - egg - fish - crustacean_shellfish - tree_nuts - peanut - wheat - soy - sesame - celery - mustard - lupin - molluscs - sulphites status: type: string enum: - contains - may_contain - absent - unknown required: - allergenId - status additionalProperties: false crossContact: type: object properties: status: type: string enum: - possible - none_reported - unknown allergenIds: maxItems: 14 type: array items: type: string enum: - milk - egg - fish - crustacean_shellfish - tree_nuts - peanut - wheat - soy - sesame - celery - mustard - lupin - molluscs - sulphites evidence: nullable: true type: string minLength: 1 maxLength: 2000 required: - status - allergenIds - evidence additionalProperties: false required: - serving - nutrients - provenance - includedComponentIds - suitability - ingredients - allergens - crossContact additionalProperties: false portionRules: maxItems: 100 type: array items: oneOf: - type: object properties: precedence: type: integer minimum: 0 maximum: 1000 triggerOptionId: nullable: true 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)$ kind: type: string enum: - scale_component componentId: 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: - precedence - triggerOptionId - kind - componentId - fraction additionalProperties: false - type: object properties: precedence: type: integer minimum: 0 maximum: 1000 triggerOptionId: nullable: true 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)$ kind: type: string enum: - split_group groupId: 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: - precedence - triggerOptionId - kind - groupId - fraction additionalProperties: false - type: object properties: precedence: type: integer minimum: 0 maximum: 1000 triggerOptionId: nullable: true 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)$ kind: type: string enum: - replace_included_component includedComponentId: 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)$ replacementOptionId: 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: - precedence - triggerOptionId - kind - includedComponentId - replacementOptionId - fraction additionalProperties: false exception: type: object properties: foodFacts: type: boolean portionRules: type: boolean required: - foodFacts - portionRules additionalProperties: false required: - foodFacts - portionRules - exception additionalProperties: false commercial: type: object properties: byEntityId: type: object additionalProperties: oneOf: - type: object properties: kind: type: string enum: - menu facts: type: object properties: rules: type: object properties: all: type: object properties: minimumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 minimumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ maximumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ minimumSpend: type: object properties: amountCents: type: integer minimum: 0 maximum: 99999999 basis: type: string enum: - eligible_food_beverage_before_discounts required: - amountCents - basis additionalProperties: false leadTimeHours: type: integer minimum: 0 maximum: 8760 additionalProperties: false byServiceStyle: type: object additionalProperties: type: object properties: minimumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 minimumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ maximumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ minimumSpend: type: object properties: amountCents: type: integer minimum: 0 maximum: 99999999 basis: type: string enum: - eligible_food_beverage_before_discounts required: - amountCents - basis additionalProperties: false leadTimeHours: type: integer minimum: 0 maximum: 8760 additionalProperties: false additionalProperties: false allocationGroups: maxItems: 100 type: array items: type: object properties: groupId: type: string minLength: 1 maxLength: 200 minimumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 minimumGuestsPerProduct: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumDistinctProducts: type: integer minimum: 0 exclusiveMinimum: true maximum: 100 total: type: string enum: - event_headcount required: - groupId - minimumGuests - maximumGuests - minimumGuestsPerProduct - maximumDistinctProducts - total additionalProperties: false reviewFacts: maxItems: 50 type: array items: type: object properties: code: type: string enum: - conflicting_lead_time - unsupported_minimum_spend_basis - unresolved_choice_scope - ambiguous_category_scope - staff_pricing sourceText: type: string minLength: 1 maxLength: 2000 reason: type: string minLength: 1 maxLength: 2000 required: - code - sourceText - reason additionalProperties: false additionalProperties: false required: - kind - facts additionalProperties: false - type: object properties: kind: type: string enum: - category facts: type: object properties: rules: type: object properties: all: type: object properties: minimumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 minimumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ maximumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ minimumSpend: type: object properties: amountCents: type: integer minimum: 0 maximum: 99999999 basis: type: string enum: - eligible_food_beverage_before_discounts required: - amountCents - basis additionalProperties: false leadTimeHours: type: integer minimum: 0 maximum: 8760 additionalProperties: false byServiceStyle: type: object additionalProperties: type: object properties: minimumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 minimumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ maximumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ minimumSpend: type: object properties: amountCents: type: integer minimum: 0 maximum: 99999999 basis: type: string enum: - eligible_food_beverage_before_discounts required: - amountCents - basis additionalProperties: false leadTimeHours: type: integer minimum: 0 maximum: 8760 additionalProperties: false additionalProperties: false serves: nullable: true oneOf: - type: object properties: kind: type: string enum: - exact guests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - guests - sourceText additionalProperties: false - type: object properties: kind: type: string enum: - range minGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maxGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - minGuests - maxGuests - sourceText additionalProperties: false - type: object properties: kind: type: string enum: - up_to maxGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - maxGuests - sourceText additionalProperties: false - type: object properties: kind: type: string enum: - approximate minGuests: nullable: true type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maxGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - minGuests - maxGuests - sourceText additionalProperties: false planningYield: nullable: true type: object properties: guests: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ quantity: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ reviewNote: type: string minLength: 1 maxLength: 2000 required: - guests - quantity - reviewNote additionalProperties: false additionalProperties: false required: - kind - facts additionalProperties: false - type: object properties: kind: type: string enum: - product facts: type: object properties: priceBasis: type: string enum: - per_person - per_item - per_dozen - per_tray - per_pack - per_lb - per_oz - per_kg - per_g - per_gallon - per_quart - per_liter - per_ml - per_fl_oz printedPrice: oneOf: - type: object properties: kind: type: string enum: - exact amountCents: type: integer minimum: 0 maximum: 99999999 required: - kind - amountCents additionalProperties: false - type: object properties: kind: type: string enum: - range minCents: type: integer minimum: 0 maximum: 99999999 maxCents: type: integer minimum: 0 maximum: 99999999 required: - kind - minCents - maxCents additionalProperties: false - type: object properties: kind: type: string enum: - quote_only required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - unknown reason: type: string minLength: 1 maxLength: 2000 required: - kind - reason additionalProperties: false serves: nullable: true oneOf: - type: object properties: kind: type: string enum: - exact guests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - guests - sourceText additionalProperties: false - type: object properties: kind: type: string enum: - range minGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maxGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - minGuests - maxGuests - sourceText additionalProperties: false - type: object properties: kind: type: string enum: - up_to maxGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - maxGuests - sourceText additionalProperties: false - type: object properties: kind: type: string enum: - approximate minGuests: nullable: true type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maxGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - minGuests - maxGuests - sourceText additionalProperties: false quantityRules: type: object properties: increment: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ minimum: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ maximum: nullable: true type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ required: - increment - minimum - maximum additionalProperties: false contents: maxItems: 100 type: array items: type: object properties: name: type: string minLength: 1 maxLength: 2000 quantity: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ unit: type: string enum: - person - item - dozen - tray - pack - lb - oz - kg - g - gallon - quart - liter - ml - fl_oz required: - name - quantity - unit additionalProperties: false planningYield: nullable: true type: object properties: guests: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ quantity: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ reviewNote: type: string minLength: 1 maxLength: 2000 required: - guests - quantity - reviewNote additionalProperties: false minimumSpendEligibility: type: string enum: - food_beverage - excluded - unreviewed allocationGroupId: type: string minLength: 1 maxLength: 200 rules: type: object properties: all: type: object properties: minimumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 minimumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ maximumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ minimumSpend: type: object properties: amountCents: type: integer minimum: 0 maximum: 99999999 basis: type: string enum: - eligible_food_beverage_before_discounts required: - amountCents - basis additionalProperties: false leadTimeHours: type: integer minimum: 0 maximum: 8760 additionalProperties: false byServiceStyle: type: object additionalProperties: type: object properties: minimumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 minimumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ maximumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ minimumSpend: type: object properties: amountCents: type: integer minimum: 0 maximum: 99999999 basis: type: string enum: - eligible_food_beverage_before_discounts required: - amountCents - basis additionalProperties: false leadTimeHours: type: integer minimum: 0 maximum: 8760 additionalProperties: false additionalProperties: false reviewFacts: maxItems: 50 type: array items: type: object properties: code: type: string enum: - conflicting_lead_time - unsupported_minimum_spend_basis - unresolved_choice_scope - ambiguous_category_scope - staff_pricing sourceText: type: string minLength: 1 maxLength: 2000 reason: type: string minLength: 1 maxLength: 2000 required: - code - sourceText - reason additionalProperties: false required: - priceBasis - printedPrice - serves additionalProperties: false required: - kind - facts additionalProperties: false - type: object properties: kind: type: string enum: - modifier_group facts: type: object properties: semanticRole: type: string enum: - size - choice required: - semanticRole additionalProperties: false required: - kind - facts additionalProperties: false - type: object properties: kind: type: string enum: - modifier_option facts: type: object properties: priceSemantics: type: string enum: - replaces_item - adds_to_item printedPrice: nullable: true oneOf: - type: object properties: kind: type: string enum: - exact amountCents: type: integer minimum: 0 maximum: 99999999 required: - kind - amountCents additionalProperties: false - type: object properties: kind: type: string enum: - range minCents: type: integer minimum: 0 maximum: 99999999 maxCents: type: integer minimum: 0 maximum: 99999999 required: - kind - minCents - maxCents additionalProperties: false - type: object properties: kind: type: string enum: - quote_only required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - unknown reason: type: string minLength: 1 maxLength: 2000 required: - kind - reason additionalProperties: false serves: nullable: true oneOf: - type: object properties: kind: type: string enum: - exact guests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - guests - sourceText additionalProperties: false - type: object properties: kind: type: string enum: - range minGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maxGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - minGuests - maxGuests - sourceText additionalProperties: false - type: object properties: kind: type: string enum: - up_to maxGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - maxGuests - sourceText additionalProperties: false - type: object properties: kind: type: string enum: - approximate minGuests: nullable: true type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maxGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 sourceText: type: string minLength: 1 maxLength: 2000 required: - kind - minGuests - maxGuests - sourceText additionalProperties: false planningYield: nullable: true type: object properties: guests: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ quantity: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ reviewNote: type: string minLength: 1 maxLength: 2000 required: - guests - quantity - reviewNote additionalProperties: false charge: type: object properties: chargeId: type: string minLength: 1 maxLength: 200 scope: type: string enum: - sold_unit - affected_person - order minimumSpendEligibility: type: string enum: - food_beverage - excluded - unreviewed required: - chargeId - scope - minimumSpendEligibility additionalProperties: false reviewFacts: maxItems: 50 type: array items: type: object properties: code: type: string enum: - conflicting_lead_time - unsupported_minimum_spend_basis - unresolved_choice_scope - ambiguous_category_scope - staff_pricing sourceText: type: string minLength: 1 maxLength: 2000 reason: type: string minLength: 1 maxLength: 2000 required: - code - sourceText - reason additionalProperties: false required: - priceSemantics - printedPrice - serves additionalProperties: false required: - kind - facts additionalProperties: false policy: type: object properties: servingRangeReading: nullable: true type: string enum: - plan_for_lower - plan_for_higher rangeQuotePolicy: nullable: true type: string enum: - quote_top - quote_range rules: type: object properties: all: type: object properties: minimumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 minimumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ maximumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ minimumSpend: type: object properties: amountCents: type: integer minimum: 0 maximum: 99999999 basis: type: string enum: - eligible_food_beverage_before_discounts required: - amountCents - basis additionalProperties: false leadTimeHours: type: integer minimum: 0 maximum: 8760 additionalProperties: false byServiceStyle: type: object additionalProperties: type: object properties: minimumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 maximumGuests: type: integer minimum: 0 exclusiveMinimum: true maximum: 10000 minimumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ maximumUnits: type: string pattern: ^(?:0|[1-9]\d{0,4})(?:\.\d{1,6})?$ minimumSpend: type: object properties: amountCents: type: integer minimum: 0 maximum: 99999999 basis: type: string enum: - eligible_food_beverage_before_discounts required: - amountCents - basis additionalProperties: false leadTimeHours: type: integer minimum: 0 maximum: 8760 additionalProperties: false additionalProperties: false required: - servingRangeReading - rangeQuotePolicy additionalProperties: false required: - byEntityId - policy additionalProperties: false required: - target - source - at - valid - blockers - contentWarnings - menu - food - commercial additionalProperties: false ResolvedModifierGroup: type: object properties: canonicalId: type: string minLength: 1 maxLength: 128 name: type: string rule: type: object properties: minimum: type: integer minimum: -9007199254740991 maximum: 9007199254740991 maximum: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - minimum - maximum additionalProperties: false defaultSelections: type: array items: type: object properties: optionId: type: string minLength: 1 maxLength: 128 quantity: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - optionId - quantity additionalProperties: false fixedSelections: maxItems: 50 type: array items: type: object properties: optionId: type: string minLength: 1 maxLength: 128 quantity: type: integer minimum: 0 exclusiveMinimum: true maximum: 99 required: - optionId - quantity additionalProperties: false customerVisible: type: boolean selectionPath: type: array items: type: string minLength: 1 maxLength: 128 configurationSources: type: object properties: minimum: type: string enum: - group - attachment - product_path maximum: type: string enum: - group - attachment - product_path defaultSelections: type: string enum: - group - attachment - product_path fixedSelections: type: string enum: - group - attachment - product_path customerVisible: type: string enum: - group - attachment - product_path required: - minimum - maximum - defaultSelections - fixedSelections - customerVisible additionalProperties: false options: type: array items: type: object properties: childGroups: type: array items: type: object properties: groupId: type: string minLength: 1 maxLength: 128 overrides: type: object properties: minimum: type: integer minimum: 0 maximum: 9007199254740991 maximum: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 defaultSelections: maxItems: 50 type: array items: type: object properties: optionId: type: string minLength: 1 maxLength: 128 quantity: type: integer minimum: 0 exclusiveMinimum: true maximum: 99 required: - optionId - quantity additionalProperties: false fixedSelections: maxItems: 50 type: array items: type: object properties: optionId: type: string minLength: 1 maxLength: 128 quantity: type: integer minimum: 0 exclusiveMinimum: true maximum: 99 required: - optionId - quantity additionalProperties: false customerVisible: type: boolean additionalProperties: false applyPerParentQuantity: type: boolean group: $ref: '#/components/schemas/ResolvedModifierGroup' required: - groupId - group additionalProperties: false canonicalId: type: string minLength: 1 maxLength: 128 customerVisible: type: boolean visibilitySource: type: string enum: - option - attachment - product_path selectionPath: type: array items: type: string minLength: 1 maxLength: 128 name: type: string maxQuantity: type: integer minimum: -9007199254740991 maximum: 9007199254740991 price: nullable: true type: object properties: amount: type: string pattern: ^(0|[1-9]\d*)(?:\.\d{1,4})?$ currency: type: string pattern: ^[A-Z]{3}$ source: type: string enum: - crave - provider required: - amount - currency - source additionalProperties: false sellability: type: object properties: sellable: type: boolean blockReasons: type: array items: type: string enum: - ORGANIZATION_ENTITY_INACTIVE - MENU_NOT_ASSIGNED - LOCATION_INACTIVE - LOCATION_OPERATING_SCHEDULE_CLOSED - LOCATION_FULFILLMENT_UNAVAILABLE - PROVIDER_LOCATION_MISSING - RESTAURANT_NOT_ACCEPTING_ORDERS - FULFILLMENT_SCHEDULE_CLOSED - MENU_ITEM_SCHEDULE_CLOSED - PROVIDER_ITEM_UNAVAILABLE - PROVIDER_ITEM_SOLD_OUT - LOCATION_AVAILABILITY_RESTRICTED - LOCATION_SCHEDULE_RESTRICTED - PROVIDER_MAPPING_INCOMPLETE - PROVIDER_PROJECTION_TOMBSTONED - PROVIDER_STATE_STALE - REQUIRED_MODIFIER_UNAVAILABLE required: - sellable - blockReasons additionalProperties: false availabilityEvidence: type: object properties: locationAvailability: nullable: true type: string enum: - available - unavailable - sold_out_until soldOutUntil: nullable: true 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: - locationAvailability - soldOutUntil additionalProperties: false scheduleEvidence: type: object properties: providerFulfillment: nullable: true type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false providerMenuItem: nullable: true type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false locationOperating: type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false locationFulfillment: type: array items: nullable: true type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false locationRestrictions: type: array items: type: object properties: timezone: type: string weekly: type: array items: type: object properties: dayOfWeek: anyOf: - type: number enum: - 0 - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - dayOfWeek - startMinute - endMinute additionalProperties: false dateExceptions: type: array items: type: object properties: localDate: type: string windows: type: array items: type: object properties: startMinute: type: integer minimum: 0 maximum: 1440 endMinute: type: integer minimum: 0 maximum: 1440 required: - startMinute - endMinute additionalProperties: false required: - localDate - windows additionalProperties: false required: - timezone - weekly - dateExceptions additionalProperties: false required: - providerFulfillment - providerMenuItem - locationOperating - locationFulfillment - locationRestrictions additionalProperties: false required: - canonicalId - name - maxQuantity - price - sellability - availabilityEvidence - scheduleEvidence additionalProperties: false required: - canonicalId - name - rule - options 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.