¶ No Menus Errors

All catalog’s must have menus to be a valid catalog. This must be done by having one or more menus in the menus field. See the empty menu and simple menu example payloads to see how you can add these.

**If you are trying to temporarily pause your store please use the Set Restaurant Status endpoint.

¶ No Hours Errors

All catalog’s must have hours on some day during the week to be a valid catalog. This must be done by having a service_availability on some day during the week.

**If you are trying to temporarily pause your store please use the Set Restaurant Status endpoint.

¶ Short Hours Errors

We require catalogs to have all service_availability intervals to be greater than 60 minutes to safeguard the customer experience. The start_time and end_time of a catalog is inclusive.

Case 1: Invalid Hours – this catalog is INVALID because it’s only open for 1 minute on Monday. Because the short_hours_threshold is greater than 1 minute, we will deny this catalog.

        "service_availability": [
          {
            "day_of_week": "monday",
            "time_periods": [
              {"start_time": "00:00", "end_time": "00:00"} // this is only open for 1-minute
            ]
          }
        ],

Case 2: Valid Hours – this catalog is open for 24-hour’s on Monday.

        "service_availability": [
          {
            "day_of_week": "monday",
            "time_periods": [
              {"start_time": "00:00", "end_time": "23:59"} // this is open for 24-hours
            ]
          }
        ],

Case 3: Valid Overnight Hours – this catalog is open past midnight on Monday from Monday at 11:30PM to Tuesday at 12:30AM. This is a valid upsert if the short_hours_threshold is set to 60 minutes because the interval here is 60 consecutive minutes exactly.

        "service_availability": [
          {
            "day_of_week": "monday",
            "time_periods": [
              {"start_time": "23:30", "end_time": "23:59"}
            ]
          },
          {
            "day_of_week": "tuesday",
            "time_periods": [
              {"start_time": "00:00", "end_time": "00:30"}
            ]
          }
        ],

¶ OrgUUID Invalid Errors

Error Message: orgUUID must be a valid UUID

The store_id in the request is not linked to a valid org. See the Get Menu endpoint to confirm whether a menu for this store_id exists.

¶ Nil Item Errors

Error Message: nil item

The item_id in the request is malformed or does not exist. See the Get Menu endpoint to confirm whether the item_id exists on this menu.

¶ Invalid UUID Errors

Error Message: invalid uuid

The request path contains a malformed or undefined value for store_id. Double check the request URL and confirm that it matches the format for the respective endpoints. See the Get Menu endpoint to confirm whether a menu for this store_id exists.

¶ Invalid Visibility Errors

Error Message: invalid item {item_id} in menu {store_id}: invalid visibility: time ranges: xx:xx - xx:xx and xx:xx - xx:xx overlap\

The item being updated has an invalid visibility where two or more time ranges overlap. The example below overlaps between the hours of 07:00 and 10:00. See the VisibilityHours section of the Upload Menu endpoint to fix this.

Before

        "hoursList": [
          {
            "daysBitArray": [
              true,
              false,
              false,
              false,
              false,
              false,
              false
            ],
            "startTime": "07:00",
            "endTime": "23:59"
          },
          {
            "daysBitArray": [
              true,
              false,
              false,
              false,
              false,
              false,
              false
            ],
            "startTime": "00:00",
            "endTime": "10:00"
          },
        ],

After

        "hoursList": [
          {
            "daysBitArray": [
              true,
              false,
              false,
              false,
              false,
              false,
              false
            ],
            "startTime": "00:00",
            "endTime": "23:59"
          }
        ],

¶ Invalid Visibility Errors

The price of an item exceeds the maximum allowed value. See the PriceRules field of the Update Item endpoint to fix this.