Set or update a Menu

POST 
/api/v2/businesses/:business_id/google/menus

This endpoint allows you to set or update Google My Business Food Menus for your business.

Request

Path Parameters

business_id stringrequired

application/json

Body

required

menus

object[]

Array [

name string

Name of the food menu section.

order integer

A food menu item section.

items

object[]

Array [

name string

Possible values: <= 140 characters

Name of the food menu item.

order integer

Display order of the food menu item in the food menu section.

description string

Possible values: <= 1000 characters

Description of the food menu item.

price number

Price of the food menu item.

media

object

id string

source_url string

User source url of the food menu item, mandatory to set/update media with food menu item

public_url string

Public url the food menu item provided by partoo, can be empty in set/update.

]

]

Responses

201

application/json

Schema

Schema

menus

object[]

Array [

name string

Name of the food menu section.

order integer

A food menu item section.

items

object[]

Array [

name string

Possible values: <= 140 characters

Name of the food menu item.

order integer

Display order of the food menu item in the food menu section.

description string

Possible values: <= 1000 characters

Description of the food menu item.

price number

Price of the food menu item.

media

object

id string

source_url string

User source url of the food menu item, mandatory to set/update media with food menu item

public_url string

Public url the food menu item provided by partoo, can be empty in set/update.

]

]

Example (from schema)

{
  "menus": [
    {
      "name": "Starters",
      "order": 3,
      "items": [
        {
          "name": "Item name",
          "order": 3,
          "description": "string",
          "price": 12.5,
          "media": {
            "id": "string",
            "source_url": "string",
            "public_url": "string"
          }
        }
      ]
    }
  ]
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...