CloudKitchens Menus Endpoints API

openapi: 3.2.0
info:
  title: Public Menus Endpoints API
  description: "# Overview\n\nThe API endpoints are developed around [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) principles secure via the OAuth2.0 protocol.\n\nBeyond the entry points, the API also provides a line of communication into your system via [webhooks](https://en.wikipedia.org/wiki/Webhook).\n\nFor testing purposes, we offer a staging environment. Also, more detailed information about the business rules and workflows can be found on the [**Documentation Section**](/docs/)\n\n## Versioning\nEach API is versioned individually, but we follow these rules:\n- Non breaking changes (eg: adding new fields) are added in the current version without previous communication\n- Breaking changes (fields removal, semantic changed or schema update) have the version incremented\n- Users will be notified about new versions and will be given time to migrate (the time will be set on a case by case basis)\n- Once users migrate to the new version, we will deprecate the old ones\n- Once there is a new version for an API, we won't accept new integrations targeting old versions\n\n## API General Definitions\nThe APIs use resource-oriented URLs communicating, primarily, via JSON and leveraging the HTTP headers, [response status codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status), and verbs.\n\nTo exemplify how the API is to be consumed, consider a fake GET resource endpoint invocation below:\n\n```\ncurl --request GET 'https://{{public-api-url}}/v1/resource/123' \\\n--header 'Authorization: Bearer 34fdabeeafds=' --header 'X-Store-Id: 321'\n```\n\n|      Header      | Description |\n| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|`Authorization`   | Standard HTTP header is used to associate the request with the originating invoker. The content of this header is a `Bearer` token generated from you client_secret, defined in the [API Auth](#/section/Guides/API-Auth) guide.|\n|`X-Store-Id`      | The ID of the store in your system this call acts on behalf of. |\n\n_All resource endpoints expect the `Authorization` header, the remaining headers are explicitly stated in the individual endpoint documentation section._\n\nWith these headers, the system will:\n - Validate the client token, making sure the call is originating from a trusted source.\n - Validate that the Application has the permission to access the `v1/resource/{id}` resource via the Application's pre-configured scopes.\n - Translate your X-Store-Id to our internal store ID (e.g. `AAA`).\n - Validate and retrieve resource `AAA`, that is associated to your Application via store id `321`.\n\nPOST/PUT methods will look similar to the GET calls, but they'll take in a body in the HTTP request (default to the application/json content-type).\n\n```\ncurl --location --request POST 'https://{{public-api-url}}/v1/resource' \\\n--header 'Authorization: Bearer 34fdabeeafds=' --header 'X-Store-Id: 321'\n--data '{\"foo\": \"bar\"}'\n```\n\n## API Authentication/Authorization\n\n<SecurityDefinitions />\n\n## Webhook\n\nThe Public API is able to send notifications to your system via HTTP POST requests.\n\nEvery webhook is signed using HMAC-SHA256 that is present in the header `X-HMAC-SHA256`, and you can also authenticate the requests using Basic Auth, Bearer Token or HMAC-SHA1 (legacy). Please, refer to [**Webhook Authentication Guide**](/docs/guides-webhook-authentication/) for more details.\n\n_Please work with your Account Representative to setup your Application's Webhook configurations._\n\n```\nExample Base-URL = https://{{your-server-url}}/webhook\n```\n\n### Notification Schema\n\n| **Name**                | **Type** | **Description**                                                      |\n| ------------------------| ---------| -------------------------------------------------------------------- |\n| eventId                 | string   | Unique id of the event.                                              |\n| eventTime               | string   | The time the event occurred.                                         |\n| eventType               | string   | The type of event (e.g. create_order).                               |\n| metadata.storeId        | string   | Id of the store for which the event is being published.              |\n| metadata.applicationId  | string   | Id of the application for which the event is being published.        |\n| metadata.resourceId     | string   | The external identifier of the resource that this event refers to.   |\n| metadata.resourceHref   | string   | The endpoint to fetch the details of the resource.                   |\n| metadata.payload        | object   | The event object which will be detailed in each Webhook description. |\n\n### Notification Request Example\n\n```\ncurl --location --request POST 'https://{{your-server-url}}/webhook' \\\n--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36' \\\n--header 'Authorization: MAC <hash signature>' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n   \"eventId\": \"123456\",\n   \"eventTime\": \"2020-10-10T20:06:02:123Z\",\n   \"eventType\": \"orders.new_order\",\n   \"metadata\": {\n      \"storeId\": \"755fd19a-7562-487a-b615-171a9f89d669\",\n      \"applicationId\": \"e22f94b3-967c-4e26-bf39-9e364066b68b\",\n      \"resourceHref\": \"https://{{public-api-url}}/v1/orders/bf9f1d81-f213-496e-a026-91b6af44996c\",\n      \"resourceId\": \"bf9f1d81-f213-496e-a026-91b6af44996c\",\n      \"payload\": {}\n   }\n}\n```\n\n### Expected Response\n\nThe partner application should return an HTTP 200 response code with an empty response body to acknowledge receipt of the webhook event.\n## Rate Limiting\nPlease, refer to [**Rate Limiting Guide**](/docs/guides-rate-limiting/) for more details.\n\n## Error codes\nThe APIs use standard HTTP status codes to indicate the success or failure of a request. Error codes are divided into two categories: 4XX codes for client-side errors and 5xx codes for server-side errors.\n### 4XX Client-Side Errors\nClient-side errors are indicated by status codes in the 4xx range. These errors are typically the result of a problem with the request made by your application.\nIf a client-side error occurs, our API will return a response that includes an appropriate error message. This message will provide information about the cause of the error. The aim of these messages is to assist you in identifying and resolving the issue.\nFor example, if you submit a request with missing or invalid parameters, you might receive a 400 Bad Request error with a message indicating which parameters were missing or incorrect.\n### 5XX Server-Side Errors\nServer-side errors are represented by status codes in the 5xx range. These errors suggest a problem with our server, not with your application's request.\nServer-side errors are typically transient, meaning they are temporary. If a server-side error occurs, we recommend that the client retries the same request with the exact same parameters.\nFor example, if you get a 500 Internal Server Error, it's possible that our server is suffering a temporary problem. In such cases, retrying the request after a short delay is often successful.\nIf you continually receive server-side errors, reach out to our support team for further assistance."
  version: v1
  license:
    name: Proprietary
servers:
- url: https://{{public-api-url}}
  description: Staging server url
tags:
- name: menus_endpoints
  description: Endpoints to manage menus.
  x-displayName: Menus
paths:
  /v1/menus:
    post:
      tags:
      - menus_endpoints
      summary: Upsert menus for a store
      description: '`RATE LIMIT: 2 per minute`

        '
      operationId: upsertMenu
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MenusUpsertRequest'
        required: true
      responses:
        '202':
          description: The menu update will be processed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MenuAsynchronousJob'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - menus.upsert
  /v1/menus/publish:
    post:
      tags:
      - menus_endpoints
      summary: Notify the result of a Publish Menu event
      description: '`RATE LIMIT: 8 per minute`


        Successful callback response for the [**publish menu**](/api-reference/#operation/menuPublishWebhook) webhook. If an error occurred, please publish a [**callback error**](/api-reference/#operation/publishError) instead. See [**failed event flow**](/docs/menus-integrations-failed-event-flow/) for details.

        '
      operationId: menuPublishCallback
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertFullMenuEventCallback'
        required: true
      responses:
        '204':
          description: The Publish menu event result was successfully processed
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - menus.publish
  /v1/menus/current:
    post:
      tags:
      - menus_endpoints
      summary: Notify the result of a Send Menu event
      description: '`RATE LIMIT: 4 per minute`


        Successful callback response for the [**send menu**](/api-reference/#operation/menuSendCallback) webhook. If an error occurred, please publish a [**callback error**](/api-reference/#operation/publishError) instead. See [**failed event flow**](/docs/menus-integrations-failed-event-flow/) for details.

        '
      operationId: menuSendCallback
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendMenuEventCallback'
        required: true
      responses:
        '204':
          description: The Send Menu event result was successfully processed
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - menus.get_current
  /v1/menus/hours:
    post:
      tags:
      - menus_endpoints
      summary: Notify the receival of a Upsert Hours Menu event
      description: '`RATE LIMIT: 8 per minute`


        Successful callback response for the [**upsert hours**](/api-reference/#operation/upsertMenuHoursWebhook) webhook. If an error occurred, please publish a [**callback error**](/api-reference/#operation/publishError) instead. See [**failed event flow**](/docs/menus-integrations-failed-event-flow/) for details.

        '
      operationId: menuUpsertHours
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      responses:
        '204':
          description: The Upsert Hours Menu event result was successfully processed
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - menus.upsert_hours
  /v1/menus/menu-sync:
    post:
      tags:
      - menus_endpoints
      summary: Synchronize store menu with POS menu
      description: This endpoint is used to synchronize the store menu with the connected POS.
      operationId: posMenuSync
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PosMenuSyncRequest'
        required: false
      responses:
        '202':
          description: The Menu Sync will be processed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PosMenuSyncResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - menus.sync
  /v1/menus/entity/availability/bulk:
    post:
      tags:
      - menus_endpoints
      summary: Notify the result of an Update Menu Entities Availabilities event
      description: '`RATE LIMIT: 32 per minute`


        Successful callback response for the [**update menu entities availabilities**](/api-reference/#operation/updateMenuEntitiesAvailabilitiesWebhook) webhook. If an error occurred, please publish a [**callback error**](/api-reference/#operation/publishError) instead. See [**failed event flow**](/docs/menus-integrations-failed-event-flow/) for details.

        '
      operationId: updateMenuEntitiesAvailabilitiesCallback
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      responses:
        '204':
          description: The Update Menu Entities Availabilities menu entity event result was successfully processed
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
      security:
      - OAuth2.0:
        - menus.entity_suspension
components:
  schemas:
    SpecialHours:
      required:
      - date
      - timeRanges
      - type
      type: object
      properties:
        date:
          type: string
          description: Date the special hour configuration applies.
          format: date
          example: '2021-10-01'
        timeRanges:
          type: array
          minItems: 0
          description: Hours range applied to configured date. For open days, the timeRanges field is required. For closed days, the timeRanges field is ignored.
          items:
            $ref: '#/components/schemas/TimeRange'
        type:
          type: string
          description: Store state that should be applied during the configured special hour. If this field is set to CLOSED, the timeRanges field is ignored.
          enum:
          - OPEN
          - CLOSED
      description: Describes the configuration of special store hours.
    JobReference:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the job.
          format: uuid
        status:
          type: string
          description: The status of the job.
          enum:
          - PENDING
          - FAILED
          - SUCCESS
          - UNKNOWN
      description: The job reference.
    MenusUpsertRequest:
      required:
      - categories
      - menus
      - modifierGroups
      type: object
      properties:
        categories:
          title: All Categories for the store, indexed by ID
          type: object
          additionalProperties:
            x-additionalPropertiesName: categoryId
            $ref: '#/components/schemas/Category'
          example:
            b01485b0-034a-47c5-8a0a-0eeca08bf994:
              name: Drinks
              description: All drink items served up nice and fresh!
              id: b01485b0-034a-47c5-8a0a-0eeca08bf994
              itemIds:
              - fa4f0192-4c4e-4455-9db8-61d428c34969
        modifierGroups:
          title: All ModifierGroups for the Store, indexed by ID
          type: object
          additionalProperties:
            x-additionalPropertiesName: modifierGroupId
            $ref: '#/components/schemas/ModifierGroupUpdateRequest'
          example:
            f4c69056-3ae3-4517-9294-5ceec8df5f81:
              id: f4c69056-3ae3-4517-9294-5ceec8df5f81
              name: Add Straw
              minimumSelections: 0
              maximumSelections: 1
              defaultModifierSelectionData:
                defaultModifierSelections:
                - itemId: 6d53cf04-9d62-40f5-a8b3-706e3377668f
                  selectionQuantity: 1
              itemIds:
              - 6d53cf04-9d62-40f5-a8b3-706e3377668f
              type: DEFAULT
              exposedThirdPartyInfos:
              - externalId: ff6dd693-5e55-4a92-a359-ea61b23ed423
                externalServiceSlug: 3PD
        menus:
          title: All Menus for the store, indexed by ID
          type: object
          minProperties: 1
          additionalProperties:
            x-additionalPropertiesName: menuId
            $ref: '#/components/schemas/Menu_POS'
          example:
            ff6dd693-5e55-4a92-a359-ea61b23ed423:
              id: ff6dd693-5e55-4a92-a359-ea61b23ed423
              name: Tasty BBQ
              categoryIds:
              - b01485b0-034a-47c5-8a0a-0eeca08bf994
              fulfillmentModes:
              - DELIVERY
              description: Cooking up BBQ deliciousness from around the globe!
              hours:
                intervals:
                - day: MONDAY
                  fromHour: 7
                  fromMinute: 30
                  toHour: 22
                  toMinute: 0
              additionalCharges:
              - chargeType: PACKAGING_CHARGE
                flatCharge:
                  currencyCode: USD
                  amount: 1.5
        items:
          title: All Items for the store, indexed by ID
          type: object
          additionalProperties:
            x-additionalPropertiesName: itemId
            $ref: '#/components/schemas/ItemUpdateRequest'
          example:
            fa4f0192-4c4e-4455-9db8-61d428c34969:
              id: fa4f0192-4c4e-4455-9db8-61d428c34969
              name: Canned Coke
              description: Best soda pop ever made
              price:
                currencyCode: USD
                amount: 7.65
              status:
                saleStatus: FOR_SALE
              modifierGroupIds:
              - f4c69056-3ae3-4517-9294-5ceec8df5f81
              photoUrls:
              - https://example.com/photos/c75d9460-5d48-423d-8d01-f825fd5b1672.jpeg
              priceOverrides:
              - rules:
                - externalServiceSlug: ubereats
                currencyCode: USD
                amount: 7
              skuDetails:
                skuSlug: canned-coke-355ml
                dietaryClassifications:
                - tag: VEGAN
                allergenClassifications:
                - tag: GLUTEN
                  containsAllergen: false
                - tag: PEANUT
                  containsAllergen: true
                storageRequirements:
                - tag: FROZEN
            6d53cf04-9d62-40f5-a8b3-706e3377668f:
              id: 6d53cf04-9d62-40f5-a8b3-706e3377668f
              name: Paper straw
              description: A paper straw
              price:
                currencyCode: USD
                amount: 0.5
              status:
                saleStatus: FOR_SALE
              type: DEFAULT
      description: All menus associated with a store.
    CustomBulkResolutionOptions:
      type:
      - object
      - 'null'
      properties:
        updateNames:
          type: boolean
          description: Update the linked entity's names to match the linked external entity's.
        updatePrices:
          type: boolean
          description: Update the linked entity's price to match the linked external entity's.
        updateDescriptions:
          type: boolean
          description: Update the linked entity's description to match the linked external entity's.
        createUnmatchedEntities:
          type: boolean
          description: Create unmatched external entities in the menu.
        deleteMissingEntities:
          type: boolean
          description: Delete entities that are missing external links.
        bootstrapPhotosToEntities:
          type: boolean
          description: Bootstrap linked item photos.
        copyEntityPaths:
          type: boolean
          description: Copies the entity paths from the external menu.
        updateItemSuspensionStatus:
          type: boolean
          description: Update Item suspension status.
        updateHours:
          type: boolean
          description: Update menu hours.
        assignItemsToLocations:
          type: boolean
          description: If an item exists at a location in the POS, it will automatically be assigned to that location.
        unassignItemsFromLocations:
          type: boolean
          description: If an item is removed from a location in the POS, it will automatically be unassigned from that location.
        updateMenuOrganization:
          type: boolean
          description: The organization of modifiers into modifier groups, modifier groups into items and items into categories will be replicated from the POS menu.
        updateItemArrangement:
          type: boolean
          description: The arrangement of menu products as displayed in your POS will be replicated.
        updateModifierGroupRules:
          type: boolean
          description: Update modifier group selection rules.
        updateTaxes:
          type: boolean
          description: Update taxes.
    Menu_POS:
      title: All Menus for the store, indexed by ID
      required:
      - id
      - name
      type: object
      properties:
        id:
          type: string
          description: Internal identifier for Menu.
          example: ff6dd693-5e55-4a92-a359-ea61b23ed423
        name:
          type: string
          description: Name of the Menu.
          example: Tasty BBQ
        categoryIds:
          type: array
          default: []
          description: Identifiers of the categories within this Menu.
          items:
            type: string
        fulfillmentModes:
          type: array
          default: []
          description: The ways in which this menu may be fulfilled. If no values are specified, it is assumed that all fulfillment types are allowed.
          items:
            type: string
            description: How an item from a menu is allowed to be fulfilled when ordered by a user.
            enum:
            - DELIVERY
            - PICK_UP
            - DINE_IN
        description:
          type: string
          description: Description of the Menu.
          example: Cooking up BBQ deliciousness from around the globe!
        hours:
          $ref: '#/components/schemas/Hours'
        additionalCharges:
          type:
          - array
          - 'null'
          description: Additional charges to apply for this menu. All additional charges specified on a menu will only be applied once per order.
          items:
            $ref: '#/components/schemas/AdditionalCharge'
      description: A menu for a store.
    PosMenuSyncRequest:
      type: object
      properties:
        shouldPublishChanges:
          type:
          - boolean
          - 'null'
          description: Whether or not to publish changes to external services after bulk resolution.
        useCustomOptions:
          type:
          - boolean
          - 'null'
          description: If true, use `customBulkResolutionOptions` instead of menu configuration.
        customBulkResolutionOptions:
          $ref: '#/components/schemas/CustomBulkResolutionOptions'
    Menu_3PD:
      title: All Menus for the store, indexed by ID
      required:
      - id
      - name
      type: object
      properties:
        id:
          type: string
          description: The identifier that exists in the third party system. During a menu publish event, uuidV4 ids will be generated for new entities that do not yet exist in the internal menu.
          example: da0e4e94-5670-4175-897a-3b7dde45bed5
        name:
          type: string
          description: Name of the Menu.
          example: Tasty BBQ
        categoryIds:
          type: array
          default: []
          description: Identifiers of the categories within this Menu.
          items:
            type: string
        fulfillmentModes:
          type: array
          default: []
          description: The ways in which this menu may be fulfilled. If no values are specified, it is assumed that all fulfillment types are allowed.
          items:
            type: string
            description: How an item from a menu is allowed to be fulfilled when ordered by a user.
            enum:
            - DELIVERY
            - PICK_UP
            - DINE_IN
        description:
          type: string
          description: Description of the Menu.
          example: Cooking up BBQ deliciousness from around the globe!
        hoursData:
          $ref: '#/components/schemas/HoursData'
        additionalCharges:
          type:
          - array
          - 'null'
          description: Additional charges to apply for this menu. All additional charges specified on a menu will only be applied once per order.
          items:
            $ref: '#/components/schemas/AdditionalCharge'
        exposedThirdPartyInfos:
          type: array
          default: []
          description: Additional information about the menu that should be exposed to third party
          items:
            $ref: '#/components/schemas/ExposedThirdPartyInfo'
      description: A Menu for a store.
    ItemTax:
      required:
      - percentageValue
      - isValueAddedTax
      type: object
      properties:
        percentageValue:
          $ref: '#/components/schemas/PercentageValue'
          description: Specify the percentage value of the tax.
        isValueAddedTax:
          type: boolean
          description: Whether this tax is a value-added tax.
      description: The tax configuration.
    ItemUpdateRequest:
      title: All Items for the store, indexed by ID
      required:
      - id
      - name
      - price
      - status
      - description
      type: object
      properties:
        id:
          type: string
          description: Identifier of this Item.
          example: faa4c79f-480d-4de1-bc34-5fb74ef082ef
        name:
          type: string
          description: Name of this Item
          example: Bagel
        price:
          $ref: '#/components/schemas/Money'
        status:
          $ref: '#/components/schemas/ItemStatus'
        description:
          type: string
          description: Description of this Item
          example: Delicious bagel!
        modifierGroupIds:
          type: array
          default: []
          description: Identifiers of each ModifierGroup within this Item.
          items:
            type: string
            example: 7152ee6e-e941-45c1-9008-2e306b479114
        priceOverrides:
          type:
          - array
          - 'null'
          description: Specify price overrides for different service slugs.
          items:
            $ref: '#/components/schemas/ItemPriceOverride'
        photoUrls:
          type:
          - array
          - 'null'
          description: List of photoUrls to associate with the Item. This is used only for POST/PUT requests.
          items:
            type: string
        skuDetails:
          $ref: '#/components/schemas/SkuDetails'
      description: Items are sold on the Menu. Modifiers to items are items themselves and their relationship is defined by ModifierGroup.
    ItemPriceOverride:
      required:
      - amount
      - currencyCode
      - rules
      type: object
      properties:
        rules:
          type: array
          minItems: 1
          description: Override rules for when this price override should be applied.
          items:
            $ref: '#/components/schemas/OverrideRule'
        currencyCode:
          maxLength: 3
          minLength: 3
          type: string
          description: The 3-letter currency code (ISO 4217) to use for all monetary values.
          example: EUR
        amount:
          type: number
          description: Amount the Item costs
          example: 25.21
      description: Price override for an item
    ErrorDetail:
      type: object
      properties:
        attribute:
          type: string
          description: The error attribute.
          example: Order Currency Code
        message:
          type: string
          description: The error detail description.
          example: Order Currency Code must be exactly 3 characters
      description: The error detail response object.
    DefaultModifierSelectionData:
      required:
      - defaultModifierSelections
      type: object
      properties:
        defaultModifierSelections:
          type: array
          description: The default modifier selections for this modifier group.
          items:
            $ref: '#/components/schemas/DefaultModifierSelection'
      description: The default modifiers selections for a modifier group.
    TimeRange:
      required:
      - end
      - start
      type: object
      properties:
        start:
          type: string
          description: Start time of the range in 24 hour format.
          example: 08:00
        end:
          type: string
          description: End time of the range in 24 hour format.
          example: '22:00'
      description: Time range in a given date.
    ModifierGroup:
      title: All ModifierGroups for the Store, indexed by ID
      required:
      - id
      - name
      type: object
      properties:
        id:
          type: string
          description: The identifier that exists in the third party system. During a menu publish event, uuidV4 ids will be generated for new entities that do not yet exist in the internal menu.
          example: da0e4e94-5670-4175-897a-3b7dde45bed5
        name:
          type: string
          description: Name of ModifierGroup.
          example: Choose your type of bagel
        minimumSelections:
          minimum: 0
          type: integer
          description: Minimum number of selections customers can make in this ModifierGroup. 0 means no min limits.
          format: int32
        maximumSelections:
          minimum: 0
          type: integer
          description: Maximum number of selections customers can make in this ModifierGroup. 0 means no max limits.
          format: int32
        maxPerModifierSelectionQuantity:
          minimum: 0
          default: 1
          type: integer
          description: Maximum number of selections customers can make for each modifier item in this ModifierGroup. 0 means there is no limit to how many times they can select a single modifier item. If not specified, a value of 1 will be used as the default value.
          format: int32
        defaultModifierSelectionData:
          $ref: '#/components/schemas/DefaultModifierSelectionData'
        itemIds:
          type: array
          default: []
          description: Identifiers of each Item within this ModifierGroup.
          items:
            type: string
        description:
          type: string
          description: The description for this modifier group.
          example: Choose any of these delicious types of bagels
        type:
          type: string
          description: 'Experimental: The type of this modifier group, for informative purposes

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudkitchens/refs/heads/main/openapi/cloudkitchens-menus-endpoints-api-openapi.yml