Google Business · Google Business Food Menus

Get food menus

Fetches a food menus.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/gmb-food-menus
getGoogleBusinessFoodMenus

Guide: Services and food menus

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
accountIdrequiredstring

Query parameters

NameTypeNotes
locationIdstring

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/gmb-food-menus" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • successboolean
  • accountIdstring
  • locationIdstring
  • namestring
  • menusarray of object
    • labelsarray of objectrequired

      At least 1 item.

      3 child fields
      • displayNamestringrequired
      • descriptionstring
      • languageCodestring
    • sectionsarray of object
      2 child fields
      • labelsarray of objectrequired

        At least 1 item.

        3 child fields
        • displayNamestringrequired
        • descriptionstring
        • languageCodestring
      • itemsarray of object
        3 child fields
        • labelsarray of objectrequired

          At least 1 item.

          3 child fields
          • displayNamestringrequired
          • descriptionstring
          • languageCodestring
        • attributesobject
          7 child fields
          • priceobject
            3 child fields
            • currencyCodestringrequired
            • unitsstringrequired
            • nanosinteger
          • spicinessstring

            One of SPICINESS_UNSPECIFIED, MILD, MEDIUM, HOT.

          • allergenarray of string
          • dietaryRestrictionarray of string
          • servesNumPeopleinteger

            At least 1.

          • preparationMethodsarray of string
          • mediaKeysarray of string
        • optionsarray of object
          2 child fields
          • labelsarray of objectrequired

            At least 1 item.

            3 child fields
            • displayNamestringrequired
            • descriptionstring
            • languageCodestring
          • attributesobjectrequired
            7 child fields
            • priceobject
              3 child fields
              • currencyCodestringrequired
              • unitsstringrequired
              • nanosinteger
            • spicinessstring

              One of SPICINESS_UNSPECIFIED, MILD, MEDIUM, HOT.

            • allergenarray of string
            • dietaryRestrictionarray of string
            • servesNumPeopleinteger

              At least 1.

            • preparationMethodsarray of string
            • mediaKeysarray of string
    • cuisinesarray of string
    • sourceUrlstring (URL)
200 response
{
  "success": true,
  "accountId": "696e0b682d0a31188e7a2ba9",
  "locationId": "6e99c3dd69982b334a43b0b2",
  "name": "Acme",
  "menus": [
    {
      "labels": [
        {
          "displayName": "Acme",
          "description": "A short description",
          "languageCode": "string"
        }
      ],
      "sections": [
        {
          "labels": [
            {
              "displayName": "Acme",
              "description": "A short description",
              "languageCode": "string"
            }
          ],
          "items": [
            {
              "labels": [
                {}
              ],
              "attributes": {
                "price": {},
                "spiciness": "SPICINESS_UNSPECIFIED",
                "allergen": [],
                "dietaryRestriction": [],
                "servesNumPeople": 1,
                "preparationMethods": [],
                "mediaKeys": []
              },
              "options": [
                {}
              ]
            }
          ]
        }
      ],
      "cuisines": [
        "string"
      ],
      "sourceUrl": "https://pozy.ai/media/example-1.jpg"
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is scoped to other profiles or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Google Business Food Menus