Flipdish MenuSectionItems API

Operations for Menu Section Items.

OpenAPI Specification

flipdish-menusectionitems-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Flipdish API - Apps Accounts MenuSectionItems API
  version: v1.0
  description: Flipdish Open API v1.0 — Apps operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain.
  contact:
    name: Flipdish Support
    email: help@flipdish.com
    url: https://help.flipdish.com
  x-generated-from: https://api.flipdish.co/swagger/docs/v1.0
  x-last-validated: '2026-06-02'
servers:
- url: https://api.flipdish.co
  description: Flipdish production API
security:
- oauth2:
  - api
tags:
- name: MenuSectionItems
  description: Operations for Menu Section Items.
paths:
  /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems:
    get:
      tags:
      - MenuSectionItems
      summary: Flipdish Get Menu Items
      operationId: GetMenuItems
      parameters:
      - name: menuId
        in: path
        description: Menu identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: menuSectionId
        in: path
        description: Menu section identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiArrayResult_MenuSectionItem_'
              examples:
                GetMenuItems200Example:
                  summary: Default GetMenuItems 200 response
                  x-microcks-default: true
                  value:
                    Data: []
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItems400Example:
                  summary: Default GetMenuItems 400 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItems401Example:
                  summary: Default GetMenuItems 401 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItems403Example:
                  summary: Default GetMenuItems 403 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItems404Example:
                  summary: Default GetMenuItems 404 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItems500Example:
                  summary: Default GetMenuItems 500 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
      security:
      - oauth2:
        - api
      description: Get Menu Items via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems).
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - MenuSectionItems
      summary: Flipdish Create Menu Section Item
      operationId: CreateMenuSectionItem
      parameters:
      - name: menuId
        in: path
        description: Menu identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: menuSectionId
        in: path
        description: Menu section identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MenuSectionItemBase'
            examples:
              CreateMenuSectionItemRequestExample:
                summary: Default CreateMenuSectionItem request
                x-microcks-default: true
                value:
                  Name: Example Name
                  Description: string
                  SpicinessRating: NotRated
                  Price: 12.5
                  DepositReturnFee: 12.5
                  DisplayOrder: 1
                  Alcohol: true
                  IsAvailable: true
                  CellLayoutType: Small
                  DisableVouchers: true
                  ImageName: Example Name
                  ImageUrl: https://api.flipdish.co/example
                  MenuItemId: 500123
                  ExcludeFromVoucherDiscounting: true
                  PublicId: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                CreateMenuSectionItem200Example:
                  summary: Default CreateMenuSectionItem 200 response
                  x-microcks-default: true
                  value: {}
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_MenuSectionItem_'
              examples:
                CreateMenuSectionItem201Example:
                  summary: Default CreateMenuSectionItem 201 response
                  x-microcks-default: true
                  value:
                    Data:
                      ActualPrice: 12.5
                      MenuItemOptionSets: []
                      DailySpecialHours: []
                      PublicId: 00000000-0000-0000-0000-000000000000
                      TaxRateName: Example Name
                      TaxRateId: 500123
                      TaxValue: 1.0
                      ExcludeFromVoucherDiscounting: true
                      Metadata: []
                      CatalogItemId: '500123'
                      Name: Example Name
                      Description: string
                      SpicinessRating: NotRated
                      Price: 12.5
                      DepositReturnFee: 12.5
                      DisplayOrder: 1
                      Alcohol: true
                      IsAvailable: true
                      CellLayoutType: Small
                      DisableVouchers: true
                      ImageName: Example Name
                      ImageUrl: https://api.flipdish.co/example
                      MenuItemId: 500123
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItem400Example:
                  summary: Default CreateMenuSectionItem 400 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItem401Example:
                  summary: Default CreateMenuSectionItem 401 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItem403Example:
                  summary: Default CreateMenuSectionItem 403 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItem404Example:
                  summary: Default CreateMenuSectionItem 404 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItem500Example:
                  summary: Default CreateMenuSectionItem 500 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
      security:
      - oauth2:
        - api
      description: Create Menu Section Item via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems).
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}:
    get:
      tags:
      - MenuSectionItems
      summary: Flipdish Get Menu Item by Id
      operationId: GetMenuItemById
      parameters:
      - name: menuId
        in: path
        description: Menu identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: menuSectionId
        in: path
        description: Menu section identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: menuSectionItemId
        in: path
        description: Menu item identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_MenuSectionItem_'
              examples:
                GetMenuItemById200Example:
                  summary: Default GetMenuItemById 200 response
                  x-microcks-default: true
                  value:
                    Data:
                      ActualPrice: 12.5
                      MenuItemOptionSets: []
                      DailySpecialHours: []
                      PublicId: 00000000-0000-0000-0000-000000000000
                      TaxRateName: Example Name
                      TaxRateId: 500123
                      TaxValue: 1.0
                      ExcludeFromVoucherDiscounting: true
                      Metadata: []
                      CatalogItemId: '500123'
                      Name: Example Name
                      Description: string
                      SpicinessRating: NotRated
                      Price: 12.5
                      DepositReturnFee: 12.5
                      DisplayOrder: 1
                      Alcohol: true
                      IsAvailable: true
                      CellLayoutType: Small
                      DisableVouchers: true
                      ImageName: Example Name
                      ImageUrl: https://api.flipdish.co/example
                      MenuItemId: 500123
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItemById400Example:
                  summary: Default GetMenuItemById 400 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItemById401Example:
                  summary: Default GetMenuItemById 401 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItemById403Example:
                  summary: Default GetMenuItemById 403 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItemById404Example:
                  summary: Default GetMenuItemById 404 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                GetMenuItemById500Example:
                  summary: Default GetMenuItemById 500 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
      security:
      - oauth2:
        - api
      description: Get Menu Item by Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}).
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - MenuSectionItems
      summary: Flipdish Update Menu Section Item
      operationId: UpdateMenuSectionItem
      parameters:
      - name: menuId
        in: path
        description: Menu identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: menuSectionId
        in: path
        description: Menu section identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: menuSectionItemId
        in: path
        description: Menu section item identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: undoAfter
        in: query
        description: An optional time period, in hours, after which the hide-section operation will be undone
        required: false
        schema:
          type: number
          format: double
        example: 1.0
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MenuSectionItemBase'
            examples:
              UpdateMenuSectionItemRequestExample:
                summary: Default UpdateMenuSectionItem request
                x-microcks-default: true
                value:
                  Name: Example Name
                  Description: string
                  SpicinessRating: NotRated
                  Price: 12.5
                  DepositReturnFee: 12.5
                  DisplayOrder: 1
                  Alcohol: true
                  IsAvailable: true
                  CellLayoutType: Small
                  DisableVouchers: true
                  ImageName: Example Name
                  ImageUrl: https://api.flipdish.co/example
                  MenuItemId: 500123
                  ExcludeFromVoucherDiscounting: true
                  PublicId: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: OK
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                UpdateMenuSectionItem400Example:
                  summary: Default UpdateMenuSectionItem 400 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                UpdateMenuSectionItem401Example:
                  summary: Default UpdateMenuSectionItem 401 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                UpdateMenuSectionItem403Example:
                  summary: Default UpdateMenuSectionItem 403 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                UpdateMenuSectionItem404Example:
                  summary: Default UpdateMenuSectionItem 404 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                UpdateMenuSectionItem500Example:
                  summary: Default UpdateMenuSectionItem 500 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
      security:
      - oauth2:
        - api
      description: Update Menu Section Item via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}).
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - MenuSectionItems
      summary: Flipdish Delete Menu Section Item
      operationId: DeleteMenuSectionItem
      parameters:
      - name: menuId
        in: path
        description: Menu identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: menuSectionId
        in: path
        description: Menu section identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: menuSectionItemId
        in: path
        description: Menu section item identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      responses:
        '200':
          description: OK
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                DeleteMenuSectionItem400Example:
                  summary: Default DeleteMenuSectionItem 400 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                DeleteMenuSectionItem401Example:
                  summary: Default DeleteMenuSectionItem 401 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                DeleteMenuSectionItem403Example:
                  summary: Default DeleteMenuSectionItem 403 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                DeleteMenuSectionItem404Example:
                  summary: Default DeleteMenuSectionItem 404 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                DeleteMenuSectionItem500Example:
                  summary: Default DeleteMenuSectionItem 500 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
      security:
      - oauth2:
        - api
      description: Delete Menu Section Item via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}).
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/add-catalogitems:
    post:
      tags:
      - MenuSectionItems
      summary: Flipdish Create Menu Section Item from Catalog Items
      description: Create Menu Section Item from Catalog Items via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/add-catalogitems).
      operationId: CreateMenuSectionItemFromCatalogItems
      parameters:
      - name: menuId
        in: path
        description: Menu identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      - name: menuSectionId
        in: path
        description: Menu section identifier
        required: true
        schema:
          type: integer
          format: int32
        example: 500123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMenuSectionItemFromCatalogItems'
            examples:
              CreateMenuSectionItemFromCatalogItemsRequestExample:
                summary: Default CreateMenuSectionItemFromCatalogItems request
                x-microcks-default: true
                value:
                  MenuCatalogItems: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                CreateMenuSectionItemFromCatalogItems200Example:
                  summary: Default CreateMenuSectionItemFromCatalogItems 200 response
                  x-microcks-default: true
                  value: {}
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResult_CreatedMenuSectionItems_'
              examples:
                CreateMenuSectionItemFromCatalogItems201Example:
                  summary: Default CreateMenuSectionItemFromCatalogItems 201 response
                  x-microcks-default: true
                  value:
                    Data:
                      MenuSectionItems: []
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItemFromCatalogItems400Example:
                  summary: Default CreateMenuSectionItemFromCatalogItems 400 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '401':
          description: Authentication has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItemFromCatalogItems401Example:
                  summary: Default CreateMenuSectionItemFromCatalogItems 401 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '403':
          description: Successful authentication, but authorization has been denied for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItemFromCatalogItems403Example:
                  summary: Default CreateMenuSectionItemFromCatalogItems 403 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItemFromCatalogItems404Example:
                  summary: Default CreateMenuSectionItemFromCatalogItems 404 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlipdishError'
              examples:
                CreateMenuSectionItemFromCatalogItems500Example:
                  summary: Default CreateMenuSectionItemFromCatalogItems 500 response
                  x-microcks-default: true
                  value:
                    error:
                      errorMessage: Invalid or missing parameters.
                      errorCode: BadRequest
                      details: Validation failed for field 'storeId'.
      security:
      - oauth2:
        - api
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1.0/menus/{menuId}/sections/{menuSectionId}/sectionitems/{menuSectionItemId}/clone:
    post:
      tags:
      - MenuSecti

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-menusectionitems-api-openapi.yml