Communication Model

The full endpoint map: what you implement, what you call, and what each endpoint is for.

vGrubs defines the full contract. As a partner, you implement the endpoints listed below - vGrubs calls them when events occur on our side.

Endpoint map

YOUR SYSTEM                            vGrubs
───────────────────────────────────────────────────────────

ORDER MANAGEMENT
  POST /partner/orders      ──────────►  vGrubs receives new orders from you
  /{partner-name}                        You call this endpoint when a new
                                         order is placed on your platform

  POST /orders/status       ◄────────  vGrubs notifies you of order status
                                       changes: accepted, completed, cancelled

  POST /partner/            ──────────►  You notify vGrubs when an order
  cancel-order/{partner-name}            is cancelled on your platform

DELIVERY
  POST /orders/delivery     ◄────────  vGrubs pushes vDrive delivery status
                                       updates in real time

MERCHANT MANAGEMENT
  POST /merchants/validate        ◄──  vGrubs validates a merchant once
                                       during integration setup

  POST /merchants/set-store-status◄──  vGrubs sets store availability
                                       (online / offline)

  POST /merchants/get-store-status◄──  vGrubs queries current store status

  POST /merchants/working-hours   ◄──  vGrubs updates merchant working hours

  POST /merchants/closing-days    ◄──  vGrubs adds or removes closing days

MENU MANAGEMENT
  POST /merchants/menu      ◄────────  vGrubs pushes the full menu
                                       for a merchant

BILLING
  POST /partner/get-fees    ──────────►  You call this to retrieve delivery,
  /{partner-name}                        service fee and tax for an order

Endpoint	Direction	Purpose
Send New Order	You call vGrubs	Push a new order when a customer places it on your platform
Order Status Update	vGrubs calls you	Notifies you when an order is accepted, completed or cancelled
Cancel Order	You call vGrubs	Notify vGrubs when an order is cancelled on your platform
vDrive Delivery Status	vGrubs calls you	Pushes real-time vDrive delivery status updates
Merchant Validation	vGrubs calls you	Validates a merchant once during integration setup
Connect Store	You call vGrubs	Connect using the vGrubs store ID when you have no internal store IDs
Set Store Status	vGrubs calls you	Brings a store online or offline
Get Store Status	vGrubs calls you	Queries the current store status
Working Hours	vGrubs calls you	Updates merchant working hours
Closing Days	vGrubs calls you	Adds or removes closing days
Get Merchant Timezone	You call vGrubs	Retrieve the IANA timezone of a merchant's store
Menu Push	vGrubs calls you	Pushes the full menu for a merchant
Publish Menu	You call vGrubs	Trigger a fresh menu sync for a merchant
Get Fees	You call vGrubs	Retrieve delivery fee, service charge and tax for an order