openapi: 3.1.0
info:
  title: Deliverect Channel Accounts Menus API
  description: Integrate ordering channels and marketplaces with Deliverect to create and cancel orders, sync menus, snooze products, update store and courier status, and exchange payment events. Authenticates with OAuth 2.0 machine-to-machine access tokens scoped via genericChannel.
  version: '1.0'
  x-generated-from: documentation
  x-source-url: https://developers.deliverect.com/reference
  x-last-validated: '2026-06-02'
  contact:
    name: Kin Lane
    email: kin@apievangelist.com
  license:
    name: All Rights Reserved
servers:
- url: https://api.deliverect.com
  description: Production
- url: https://api.staging.deliverect.com
  description: Staging
security:
- oauth2: []
tags:
- name: Menus
  description: Menus operations for the Deliverect Channel API.
paths:
  /channel/menu_update/:
    post:
      summary: Deliverect Menu Update
      description: Customers will publish their menu to a provided webhook URL. This delivers JSON containing all the necessary attributes to display their menu as intended
      operationId: channel_menu_update
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
            examples:
              Menu Example:
                summary: Menu Example
                value:
                  availabilities:
                  - dayOfWeek: 1
                    endTime: '17:00'
                    startTime: 09:00
                  - dayOfWeek: 2
                    endTime: '17:00'
                    startTime: 09:00
                  - dayOfWeek: 3
                    endTime: '17:00'
                    startTime: 09:00
                  - dayOfWeek: 4
                    endTime: '17:00'
                    startTime: 09:00
                  - dayOfWeek: 5
                    endTime: '17:00'
                    startTime: 09:00
                  - dayOfWeek: 6
                    endTime: '17:00'
                    startTime: 09:00
                  - dayOfWeek: 6
                    endTime: '22:00'
                    startTime: '19:00'
                  - dayOfWeek: 7
                    endTime: '17:00'
                    startTime: 09:00
                  bundles: {}
                  categories:
                  - _id: 65********************87
                    name: Steaks
                    description: ''
                    descriptionTranslations: {}
                    nameTranslations: {}
                    account: 62********************f1
                    posLocationId: ''
                    posCategoryType: ''
                    posCategoryId: ''
                    imageUrl: ''
                    subCategories: []
                    products: []
                    availabilities: []
                    level: 1
                    menu: 65********************79
                    sortedChannelProductIds: []
                    subProducts:
                    - 65********************30
                    subProductSortOrder: []
                  channelLinkId: 65********************7f
                  currency: 3
                  description: ''
                  descriptionTranslations:
                    fr: Un exemple de menu de diffu00e9rentes configurations de produits, profitez-enu00a0!
                  menu: Example Menu
                  menuId: 65********************79
                  menuImageURL: ''
                  menuType: 0
                  modifierGroups:
                    65********************31:
                      _id: 65********************31
                      name: Cooking instructions
                      description: ''
                      descriptionTranslations: {}
                      nameTranslations:
                        es: Cocinado
                        fr: Cuisson
                      account: 62********************f1
                      capacityUsages: []
                      deliveryTax: 9000
                      eatInTax: 9000
                      takeawayTax: 9000
                      location: 65********************32
                      max: 1
                      min: 1
                      multiply: 1
                      plu: MOD-01
                      posCategoryIds: []
                      posProductCategoryId: ''
                      posProductId: ''
                      productTags: []
                      productType: 3
                      subProducts:
                      - 65********************32
                      - 65********************33
                      parentId: 65********************30
                      snoozed: false
                      subProductSortOrder: []
                  modifiers:
                    65********************32:
                      _id: 65********************32
                      name: Rare
                      description: ''
                      descriptionTranslations: {}
                      nameTranslations:
                        es: Poco hecho
                        fr: Saignant
                      account: 62********************f1
                      capacityUsages: []
                      deliveryTax: 9000
                      eatInTax: 9000
                      takeawayTax: 9000
                      location: 65********************32
                      max: 0
                      min: 0
                      multiply: 1
                      plu: COOK-01
                      posCategoryIds: []
                      posProductCategoryId: ''
                      posProductId: ''
                      price: 0
                      productTags: []
                      productType: 2
                      subProducts: []
                      parentId: 65********************31
                      snoozed: false
                      subProductSortOrder: []
                    65********************34:
                      _id: 65********************34
                      name: Well Done
                      description: ''
                      descriptionTranslations: {}
                      nameTranslations:
                        es: Muy hecho
                        fr: Bien cuit
                      account: 62********************f1
                      capacityUsages: []
                      deliveryTax: 9000
                      eatInTax: 9000
                      takeawayTax: 9000
                      location: 65********************32
                      max: 0
                      min: 0
                      multiply: 1
                      plu: COOK-03
                      posCategoryIds: []
                      posProductCategoryId: ''
                      posProductId: ''
                      price: 0
                      productTags: []
                      productType: 2
                      subProducts: []
                      parentId: 65********************31
                      snoozed: false
                      subProductSortOrder: []
                  menuTranslations:
                    fr: Exemple de Menu
                  nestedModifiers: true
                  products:
                    65********************30:
                      _id: 65********************30
                      name: Delicious Steak and Frites ud83dude0b
                      description: ''
                      descriptionTranslations:
                        fr: Exemple de produit de base avec - groupes de modificateurs - variables min/max - su00e9lection par du00e9faut - traductions
                      nameTranslations:
                        es: Deliciosos Bistecs Fritos
                        fr: Steak Frites Du00e9licieux
                      account: 62********************f1
                      capacityUsages: []
                      deliveryTax: 9000
                      eatInTax: 9000
                      takeawayTax: 9000
                      imageUrl: ''
                      location: 65********************32
                      max: 0
                      min: 0
                      multiply: 1
                      plu: STK-01
                      posCategoryIds: []
                      posProductCategoryId: ''
                      posProductId: ''
                      price: 1500
                      productTags: []
                      productType: 1
                      subProducts:
                      - 65********************31
                      - 65********************35
                      parentId: 65********************87
                      snoozed: false
                      subProductSortOrder: []
                      referenceId: STK-01
                  productTags:
                  - 104
                  - 108
                  snoozedProducts: {}
                  validations: []
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Menus
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /{channelName}/menuStatus/{_id}:
    post:
      summary: Deliverect Menu Update (Async)
      description: Receive menu update callback status.
      operationId: post_channelname_menustatus_id
      parameters:
      - name: channelName
        in: path
        required: true
        schema:
          type: string
          default: my-channel
        description: The channelName value.
        example: my-channel
      - name: _id
        in: path
        required: true
        schema:
          type: string
          default: menu-update-id
        description: The _id value.
        example: menu-update-id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  example: confirmed
                comment:
                  type: string
                  example: string
              required:
              - status
            examples:
              Menu Update:
                summary: Menu Update
                value:
                  status: ONLINE
                  comment: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              examples:
                OK:
                  summary: OK
                  value: '{}'
        '400':
          content:
            application/json:
              schema:
                type: object
                properties: {}
              examples:
                Bad Request:
                  summary: Bad Request
                  value: '{}'
          description: Bad Request
      tags:
      - Menus
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /commerce/{accountId}/menus:
    get:
      tags:
      - Menus
      summary: Deliverect Get Root Menu(s)
      description: This endpoint returns a list of menus associated with the account's master location. These menus are store agnostic and typically hold enough data to display as first entry experience.
      operationId: commerce_channel_api_menus_get_root_menus
      parameters:
      - name: accountId
        in: path
        schema:
          type: string
        required: true
        description: The accountId value.
        example: 5b71c6489f00290d4
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                  - menu: Burger Menu
                    menuId: 64c27a89c6352cd55814580c
                    menuType: 0
                    nestedModifiers: false
                    description: Description
                    menuImageUrl: null
                    currency: 1
                    menuTranslations:
                      en: ''
                    productTags:
                    - 116
                    - 16
                    - 6
                    - 115
                    - 1
                    - 35
                    - 101
                    - 104
                    descriptionTranslations:
                      en: ''
                    categories:
                    - id: 64c27a9513128b833aaec96e
                      name: Pizza
                      description: ''
                      imageUrl: null
                      menu: 64c27a89c6352cd55814580c
                      account: 64872839172e0e6d2cedaa48
                      nameTranslations: {}
                      descriptionTranslations: {}
                      subProducts:
                      - 648acd52c5bf7503468da6c7
                      - 648acc5c2d5016b2ecce3188
                      - 649abe754ea4f0e242ddb755
                    - id: 65c130c6ec28c6821bcf80ab
                      name: Drinks
                      description: ''
                      imageUrl: null
                      menu: 64c27a89c6352cd55814580c
                      account: 64872839172e0e6d2cedaa48
                      nameTranslations: {}
                      descriptionTranslations: {}
                      subProducts:
                      - 64d4c407554b010187f74830
                    - id: 65c130daec28c6821bcf80e0
                      name: Burgers
                      description: ''
                      imageUrl: null
                      menu: 64c27a89c6352cd55814580c
                      account: 64872839172e0e6d2cedaa48
                      nameTranslations: {}
                      descriptionTranslations: {}
                      subProducts:
                      - 65c1304eec28c6821bcf73e7
                    - id: 65c131b0dc12e93ea9081a9a
                      name: Extra
                      description: ''
                      imageUrl: null
                      menu: 64c27a89c6352cd55814580c
                      account: 64872839172e0e6d2cedaa48
                      nameTranslations: {}
                      descriptionTranslations: {}
                      subProducts:
                      - 65c1308edc12e93ea907f49a
                    products:
                      648acd52c5bf7503468da6c7:
                        id: 648acd52c5bf7503468da6c7
                        plu: P-MA-sViS-2
                        name: Margherita
                        productType: 1
                        max: 0
                        min: 0
                        multiply: 1
                        description: Margherita Pizza
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: P-MA-sViS-2
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags:
                        - 116
                        subProducts:
                        - 648c251ebb2163a8cebc1137
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                      648acc5c2d5016b2ecce3188:
                        id: 648acc5c2d5016b2ecce3188
                        plu: P-PE-xmku-2
                        name: Pepperoni
                        productType: 1
                        max: 0
                        min: 0
                        multiply: 1
                        description: Pepperoni Pizza
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: P-PE-xmku-2
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags:
                        - 16
                        - 6
                        - 115
                        subProducts: []
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                      649abe754ea4f0e242ddb755:
                        id: 649abe754ea4f0e242ddb755
                        plu: P-ME-72C1-2
                        name: Pizza Meal Option 1
                        productType: 1
                        max: 0
                        min: 0
                        multiply: 1
                        description: ''
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: P-ME-72C1-2
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags: []
                        subProducts:
                        - 649abede949cfa36470e3326
                        - 649abefeb99c55cfcbf181c6
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                      64d4c407554b010187f74830:
                        id: 64d4c407554b010187f74830
                        plu: VAR-3
                        name: Coke
                        productType: 1
                        max: 0
                        min: 0
                        multiply: 1
                        description: ''
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: VAR-3
                        calories: 2
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags: []
                        subProducts: []
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                      65c1304eec28c6821bcf73e7:
                        id: 65c1304eec28c6821bcf73e7
                        plu: P-TA-FYlu-2
                        name: Burger
                        productType: 1
                        max: 0
                        min: 0
                        multiply: 1
                        description: ''
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: P-TA-FYlu-2
                        calories: 500
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags:
                        - 1
                        - 35
                        - 101
                        - 104
                        subProducts: []
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                      65c1308edc12e93ea907f49a:
                        id: 65c1308edc12e93ea907f49a
                        plu: P-FR-WZDd-2
                        name: Fries
                        productType: 1
                        max: 0
                        min: 0
                        multiply: 1
                        description: ''
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: P-FR-WZDd-2
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags: []
                        subProducts: []
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                      663c976df7d1fb0d85dc96c5:
                        id: 663c976df7d1fb0d85dc96c5
                        plu: P-MA-sViS-2###
                        name: Margherita
                        productType: 1
                        max: 0
                        min: 0
                        multiply: 1
                        description: Margherita Pizza
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: P-MA-sViS-2
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags:
                        - 116
                        subProducts:
                        - 648c251ebb2163a8cebc1137
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                      663c976df7d1fb0d85dc96c6:
                        id: 663c976df7d1fb0d85dc96c6
                        plu: P-PE-xmku-2###
                        name: Pepperoni
                        productType: 1
                        max: 0
                        min: 0
                        multiply: 1
                        description: Pepperoni Pizza
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: P-PE-xmku-2
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags:
                        - 16
                        - 6
                        - 115
                        subProducts: []
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                    modifiers:
                      648c24f842c8fee99960fc05:
                        id: 648c24f842c8fee99960fc05
                        plu: M-BA-nNU1-2
                        name: Bacon
                        productType: 2
                        max: 0
                        min: 0
                        multiply: 1
                        description: ''
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: null
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags: []
                        subProducts: []
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                    modifierGroups:
                      648c251ebb2163a8cebc1137:
                        id: 648c251ebb2163a8cebc1137
                        plu: MG-TO-QeOs-2
                        name: Toppings
                        productType: 3
                        max: 5
                        min: 0
                        multiply: 1
                        description: ''
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: null
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags: []
                        subProducts:
                        - 648c24f842c8fee99960fc05
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                    bundles:
                      649abede949cfa36470e3326:
                        id: 649abede949cfa36470e3326
                        plu: P-meal-deal-1
                        name: Pizza 1
                        productType: 4
                        max: 1
                        min: 1
                        multiply: 1
                        description: ''
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: null
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags: []
                        subProducts:
                        - 663c976df7d1fb0d85dc96c5
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
                      649abefeb99c55cfcbf181c6:
                        id: 649abefeb99c55cfcbf181c6
                        plu: B-PI-qEtO-2
                        name: Pizza 2
                        productType: 4
                        max: 1
                        min: 1
                        multiply: 1
                        description: ''
                        defaultQuantity: null
                        isVariant: null
                        account: 64872839172e0e6d2cedaa48
                        referenceId: null
                        calories: null
                        caloriesRangeHigh: null
                        nameTranslations: {}
                        descriptionTranslations: {}
                        productTags: []
                        subProducts:
                        - 663c976df7d1fb0d85dc96c6
                        beverageInfo: null
                        nutritionalInfo: null
                        packaging: null
                        supplementalInfo: null
                        subProductSortOrder: []
              schema:
                type: array
                items:
                  type: object
                  properties:
                    menu:
                      type: string
                      example: Burger Menu
                    menuId:
                      type: string
                      example: 64c27a89c6352cd55814580c
                    menuType:
                      type: integer
                      example: 0
                      default: 0
                    nestedModifiers:
                      type: boolean
                      example: false
                      default: true
                    description:
                      type: string
                      example: Description
                    menuImageUrl: {}
                    currency:
                      type: integer
                      example: 1
                      default: 0
                    menuTranslations:
                      type: object
                      properties:
                        en:
                          type: string
                          example: ''
                    productTags:
                      type: array
                      items:
                        type: integer
                        example: 116
                        default: 0
                    descriptionTranslations:
                      type: object
                      properties:
                        en:
                          type: string
                          example: ''
                    categories:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 64c27a9513128b833aaec96e
                          name:
                            type: string
                            example: Pizza
                          description:
                            type: string
                            example: ''
                          imageUrl: {}
                          menu:
                            type: string
                            example: 64c27a89c6352cd55814580c
                          account:
                            type: string
                            example: 64872839172e0e6d2cedaa48
                          nameTranslations:
                            type: object
                            properties: {}
                          descriptionTranslations:
                            type: object
                            properties: {}
                          subProducts:
                            type: array
                            items:
                              type: string
                              example: 648acd52c5bf7503468da6c7
                    products:
                      type: object
                      properties:
                        648acd52c5bf7503468da6c7:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 648acd52c5bf7503468da6c7
                            plu:
                              type: string
                              example: P-MA-sViS-2
                            name:
                              type: string
                              example: Margherita
                            productType:
                              type: integer
                              example: 1
                              default: 0
                            max:
                              type: integer
                              example: 0
                              default: 0
                            min:
                              type: integer
                              example: 0
                              default: 0
                            multiply:
                              type: integer
                              example: 1
                              default: 0
                            description:
                              type: string
                              example: Margherita Pizza
                            defaultQuantity: {}
                            isVariant: {}
                            account:
                              type: string
                              example: 64872839172e0e6d2cedaa48
                            referenceId:
                              type: string
                              example: P-MA-sViS-2
                            calories: {}
                            caloriesRangeH

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