API Docs

Working Hours

vGrubs calls you

POST{your_base_url}/merchants/working-hours

vGrubs calls this endpoint when working hours change on our side, to ensure no orders are placed outside of the merchant's operating hours.

vGrubs also sends the hours about 2 seconds after a store is connected. To receive them again at any time, call Sync Schedule (POST /partner/sync-schedule/{webhookPath}).

Request body

merchant_idstringrequired

The partner's store ID.

business_hoursarrayrequired

Weekly business hours schedule.

delivery_hoursarrayrequired

Weekly delivery hours schedule. Same structure as business_hours.

Responses

200OK

successboolean

Whether the working hours were successfully updated.

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/working-hours \
  --header 'content-type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
  "merchant_id": "12345",
  "business_hours": [
    {
      "days": [
        "MONDAY"
      ],
      "time_slots": [
        {
          "start_time": "09:00",
          "end_time": "22:00"
        }
      ]
    },
    {
      "days": [
        "TUESDAY"
      ],
      "time_slots": [
        {
          "start_time": "09:00",
          "end_time": "22:00"
        }
      ]
    }
  ],
  "delivery_hours": [
    {
      "days": [
        "MONDAY"
      ],
      "time_slots": [
        {
          "start_time": "10:00",
          "end_time": "21:30"
        }
      ]
    }
  ]
}'

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

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

Response

200 OK

{
  "success": true
}