API Docs

Menu Push

vGrubs calls you

POST{your_base_url}/merchants/menu

vGrubs calls this endpoint to push the full menu for a merchant. Your system should replace the existing menu for that merchant with the data provided.

vGrubs pushes the menu automatically after a successful integration connection. Additionally, vGrubs may call this endpoint at any time when a menu correction or update is made on our side.

The menu is structured around four core entities - categories, items, modifier groups, and options - which reference each other via id. Availability schedules are defined separately and linked to categories.

All monetary values throughout the API are in cents (integer).

Request body

merchant_idstringrequired

The partner's store ID.

menuobjectrequired

The full menu for the merchant, structured around the entities below.

Reference

Menu references

categories
  └── items[]          ──────────────────► items
  └── availability     ─────────────────► availabilities

items
  └── modifiers[]      ──────────────────► modifierGroups
                                              └── options[] ──────────► options
                                                                            └── modifiers[] ──► modifierGroups (nested)

Responses

200OK

successboolean

Whether the menu was received and applied successfully.

400Bad Request

Missing or invalid fields in the request body.

401Unauthorized

Invalid or missing API key.

# vGrubs sends this request to your API. Run it against your server to test your implementation.
curl --request POST \
  --url https://api.yourplatform.com/merchants/menu \
  --header 'content-type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
  "merchant_id": "m_001",
  "menu": {
    "categories": [
      {
        "id": "cat_burgers",
        "title": "Burgers",
        "description": "Our burger choice",
        "availability": "avail_lunch",
        "items": [
          "item_classic_burger",
          "item_cheese_burger"
        ]
      }
    ],
    "items": [
      {
        "id": "item_classic_burger",
        "name": "Classic Burger",
        "description": "Beef, lettuce, tomato, onion, pickles, ketchup, mustard",
        "is_deactivated": false,
        "image_url": "https://cdn.example.com/menu/classic-burger.jpg",
        "price": 899,
        "modifiers": [
          "mod_size",
          "mod_addons"
        ]
      },
      {
        "id": "item_cheese_burger",
        "name": "Cheese Burger",
        "description": "Classic + cheddar",
        "is_deactivated": true,
        "image_url": "https://cdn.example.com/menu/cheese-burger.jpg",
        "price": 999,
        "modifiers": [
          "mod_size",
          "mod_addons"
        ]
      }
    ],
    "modifierGroups": [
      {
        "id": "mod_size",
        "name": "Size",
        "description": "Choose size",
        "min_options": 1,
        "max_options": 1,
        "options": [
          "opt_size_regular",
          "opt_size_large"
        ]
      },
      {
        "id": "mod_addons",
        "name": "Addons",
        "description": "Additional ingredients",
        "min_options": 0,
        "max_options": 3,
        "options": [
          "opt_extra_cheese",
          "opt_bacon"
        ]
      },
      {
        "id": "mod_bacon_crispiness",
        "name": "Bacon Crispiness",
        "description": "Select bacon crispiness level",
        "min_options": 1,
        "max_options": 1,
        "options": [
          "opt_bacon_normal",
          "opt_bacon_extra_crispy"
        ]
      }
    ],
    "options": [
      {
        "id": "opt_size_regular",
        "name": "Regular",
        "description": "Standard size",
        "price": 0,
        "modifiers": null,
        "is_deactivated": false
      },
      {
        "id": "opt_size_large",
        "name": "Large",
        "description": "Bigger portion",
        "price": 200,
        "modifiers": null,
        "is_deactivated": false
      },
      {
        "id": "opt_extra_cheese",
        "name": "Extra cheese",
        "description": "Additional cheddar",
        "price": 120,
        "modifiers": null,
        "is_deactivated": false
      },
      {
        "id": "opt_bacon",
        "name": "Bacon",
        "description": "Crispy bacon",
        "price": 180,
        "modifiers": [
          "mod_bacon_crispiness"
        ],
        "is_deactivated": false
      },
      {
        "id": "opt_bacon_normal",
        "name": "Normal crispy",
        "description": "Standard bacon crispiness",
        "price": 0,
        "modifiers": null,
        "is_deactivated": false
      },
      {
        "id": "opt_bacon_extra_crispy",
        "name": "Extra crispy",
        "description": "Well-done bacon crispiness",
        "price": 0,
        "modifiers": null,
        "is_deactivated": false
      }
    ],
    "availabilities": [
      {
        "id": "avail_lunch",
        "rules": [
          {
            "days_of_week": [
              "MONDAY",
              "TUESDAY"
            ],
            "start_time": "10:00:00",
            "end_time": "22:00:00"
          },
          {
            "days_of_week": [
              "FRIDAY"
            ],
            "start_time": "10:00:00",
            "end_time": "21:00:00"
          }
        ]
      }
    ]
  }
}'

Credentials

API key

Partner name

Your API base URL

Credentials are stored only in this browser.

vGrubs sends this request to your API as events occur. Enter your public API base URL above and Try It delivers this exact payload to your server, so you can test your implementation live.

Request body

{
  "merchant_id": "m_001",
  "menu": {
    "categories": [
      {
        "id": "cat_burgers",
        "title": "Burgers",
        "description": "Our burger choice",
        "availability": "avail_lunch",
        "items": [
          "item_classic_burger",
          "item_cheese_burger"
        ]
      }
    ],
    "items": [
      {
        "id": "item_classic_burger",
        "name": "Classic Burger",
        "description": "Beef, lettuce, tomato, onion, pickles, ketchup, mustard",
        "is_deactivated": false,
        "image_url": "https://cdn.example.com/menu/classic-burger.jpg",
        "price": 899,
        "modifiers": [
          "mod_size",
          "mod_addons"
        ]
      },
      {
        "id": "item_cheese_burger",
        "name": "Cheese Burger",
        "description": "Classic + cheddar",
        "is_deactivated": true,
        "image_url": "https://cdn.example.com/menu/cheese-burger.jpg",
        "price": 999,
        "modifiers": [
          "mod_size",
          "mod_addons"
        ]
      }
    ],
    "modifierGroups": [
      {
        "id": "mod_size",
        "name": "Size",
        "description": "Choose size",
        "min_options": 1,
        "max_options": 1,
        "options": [
          "opt_size_regular",
          "opt_size_large"
        ]
      },
      {
        "id": "mod_addons",
        "name": "Addons",
        "description": "Additional ingredients",
        "min_options": 0,
        "max_options": 3,
        "options": [
          "opt_extra_cheese",
          "opt_bacon"
        ]
      },
      {
        "id": "mod_bacon_crispiness",
        "name": "Bacon Crispiness",
        "description": "Select bacon crispiness level",
        "min_options": 1,
        "max_options": 1,
        "options": [
          "opt_bacon_normal",
          "opt_bacon_extra_crispy"
        ]
      }
    ],
    "options": [
      {
        "id": "opt_size_regular",
        "name": "Regular",
        "description": "Standard size",
        "price": 0,
        "modifiers": null,
        "is_deactivated": false
      },
      {
        "id": "opt_size_large",
        "name": "Large",
        "description": "Bigger portion",
        "price": 200,
        "modifiers": null,
        "is_deactivated": false
      },
      {
        "id": "opt_extra_cheese",
        "name": "Extra cheese",
        "description": "Additional cheddar",
        "price": 120,
        "modifiers": null,
        "is_deactivated": false
      },
      {
        "id": "opt_bacon",
        "name": "Bacon",
        "description": "Crispy bacon",
        "price": 180,
        "modifiers": [
          "mod_bacon_crispiness"
        ],
        "is_deactivated": false
      },
      {
        "id": "opt_bacon_normal",
        "name": "Normal crispy",
        "description": "Standard bacon crispiness",
        "price": 0,
        "modifiers": null,
        "is_deactivated": false
      },
      {
        "id": "opt_bacon_extra_crispy",
        "name": "Extra crispy",
        "description": "Well-done bacon crispiness",
        "price": 0,
        "modifiers": null,
        "is_deactivated": false
      }
    ],
    "availabilities": [
      {
        "id": "avail_lunch",
        "rules": [
          {
            "days_of_week": [
              "MONDAY",
              "TUESDAY"
            ],
            "start_time": "10:00:00",
            "end_time": "22:00:00"
          },
          {
            "days_of_week": [
              "FRIDAY"
            ],
            "start_time": "10:00:00",
            "end_time": "21:00:00"
          }
        ]
      }
    ]
  }
}

Enter your API base URL above to send the test request.

Response

200 OK

{
  "success": true
}