Menu query for Square Sandbox API

Questions
1

  1. Is there a single API to retrieve the entire menu with all catalog objects?

  2. Will we always get item variants and for injecting the order, do we need to reference to the variation.id instead of item id?

  3. Can we have a channel wise catalog: eg: One for a particular online food aggregator and another one for kiosk and another one for the mobile app delivery?

  4. How can other macros be added such as protein, sugar, etc.

  5. What are item_options and how are they different from variations? https://developer.squareup.com/reference/square/objects/CatalogObject

  6. Can the same modifierlist have different min/ max as per the catalogue item it is mapped to?

  7. Difference between top level categories and other categories- Can we consider them as Top category to be pizza and a nested category under it as Premium Pizzas, Regular Pizzas?

2

:waving_hand: I’m Square Dev AI, here to help answer your question!
Based on the information you’ve provided, the following documentation will help answer your question:

Additional Documentation

Define Item Variations Using Options
Add a Catalog Item
Manage Menus

If this documentation helped you find a solution, please check the box indicating that this reply solves the problem.
Otherwise one of our Developer Advocates will provide additional assistance shortly.

3

Hi @Limetray,

  1. You can do this in two steps. First use search catalog objects (https://developer.squareup.com/reference/square/catalog-api/search-catalog-objects) to get all of your menu category IDs. Second, use search catalog items (https://developer.squareup.com/reference/square/catalog-api/search-catalog-items) with the array of IDs from step 1 to get all the items within those menu categories.

  2. Are you talking about the catalog API here? If so, when you get an item ID it will return all of its variations. And yes, you should use ITEM_VARIATION when adding items to orders (see Create a line item for a catalog object)

  3. Square maintains one catalog but you can assign categories to different channels. You can also create additional locations if it makes sense for your use case.

  4. Do you mean displaying protein and sugar macros? This could be added via CatalogItem.product_type = FOOD_AND_BEV and populating food_and_beverage_details (calories, ingredients, dietary preferences, etc.). You can also add these via custom attributes.

  5. Item options allow you to apply common attributes to multiple item variants. Here is more information on how they are structured: https://developer.squareup.com/docs/catalog-api/item-options

  6. Yes, you can set this through min_selected_modifiers and max_selected_modifiers