API Docs

Set Store Status

vGrubs calls you

POST{your_base_url}/merchants/set-store-status

vGrubs calls this endpoint to bring a store online or offline. vGrubs controls when this is triggered. If minutes is omitted when going offline, the store will remain paused until end of day.

Request body

merchant_idstringrequired

The partner's store ID to update.

statusstringrequired

online or offline.

minutesnumber

Duration in minutes. Applies only when setting offline. If omitted, store is paused until end of day.

Responses

200OK

successboolean

Whether the action was applied.

statusstring

The resulting store status: online or offline.

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/set-store-status \
  --header 'content-type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
  "merchant_id": "m_001",
  "status": "offline",
  "minutes": 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,
  "status": "offline"
}