Publish Menu

You call vGrubs

POSThttps://sandbox.vgrubs.com/partner/publish-menu/{webhookPath}

{webhookPath} Your webhook path segment - the partner identifier provisioned during onboarding.

Use this endpoint to trigger a menu publish from the vGrubs side. Call it whenever you want to force a fresh menu sync for a specific merchant.

The production URL is provided by vGrubs once the integration is fully tested and ready to go live.

Request body

merchant_idstringrequired

The partner's store ID.

Responses

200OK

successboolean

Whether the menu publish was successfully triggered.

is_virtualboolean

true if the store is a virtual store (a vGrubs brand that is not a physical location). Always comes with supported_order_types: ["delivery"]; supported_order_types is the recommended field.

supported_order_typesstring[]

Order types the store accepts. Never empty. Treat it as a list and check whether it contains a type - do not compare it to a fixed array, as more values may be added later. Hide the order types a store does not accept: a new order with an unsupported order.type is rejected.

pickupThe store accepts pickup orders (physical locations only)

deliveryThe store accepts delivery orders

400Bad Request

Missing or invalid fields in the request body.

401Unauthorized

Invalid or missing x-api-key header.