Skip to main content

​
Overview

Create and update menus using the endpoints of the V3 Lists API. Each store can have its own individually configurable menu.
ProductDisplayed as any item a user can select from a store’s menu, including desserts, drinks, and condiments.
CategoryGroups one or more products, such as Add-ons, Main Dishes, and Drinks.
Modifier GroupsGroups modifiers that can be selected as customizations under a main item. For example, the modifier group “Drink Flavor” contains eligible items like strawberry, lemon, and orange as options.
Catalogue (Channel)Groups one or more categories from a store. It allows referencing two types of fulfillment: Pickup and Delivery.
Menu API Diagram

​
Components

  • Get Synchronization Report (GET) This endpoint provides a detailed report of the data synchronization, allowing you to monitor and verify the status of the synchronizations performed.
  • Register or Edit a List (PUT) This endpoint is used to add new stores and sales channels to the system. It facilitates the efficient expansion and updating of the store network.

​
FAQ

¿What specifications must menu item images meet for successful processing? Images must be sized 744px x 744px. ¿Can I set specific availability schedules for categories, items, or modifiers? Yes, it is possible to set availability schedules for both categories and items. You must use the attribute “schedules”:[ ] for both cases. In the case of modifiers, it is not possible to assign a schedule. 
{
"categories": [
  {
    "name": "DINNER",
    "images": [
      {
        "fileUrl": "https://samercadito.blob.core.windows.net/imagenesv3/C761AD4F-FDA8-EF11-9C36-E18191D08780_744x744.png",
        "imageCategoryId": "category"
      }
    ],
    "position": 480,
    "schedules": [
      {
        "day": "FRIDAY",
        "endTime": "16:00",
        "startTime": "12:00"
      },
      {
        "day": "MONDAY",
        "endTime": "16:00",
        "startTime": "12:00"
      }
    ],
    "displayInList": true,
    "productListing": [
      {
        "position": 0,
        "productId": 63897
      }
    ],
    "productCategoryId": "C761AD4F-FDA8-EF11-9C36-E18191D08780"
  }
]
}

​
Next Steps

See the Order Integration Guide for steps to construct your menu.