Overview

The VenueRun API lives at https://apiv2.venuerun.com. Every page in this section is generated from the API's own test suite, so each example is a real request and response.

Authentication

Send your API key as a bearer token. Create keys in the dashboard under Settings → Developer → API keys.

javascript

const response = await fetch(`https://apiv2.venuerun.com/merchants/${merchantId}/products`, {
  headers: { Authorization: `Bearer ${process.env.VENUERUN_API_KEY}` },
});

An sk_test_ key reads and writes sandbox data and an sk_live_ key live data. A key is locked to its mode: using it on the other mode's records is a 400.

Conventions

Money is in integer minor units — 1250 is $12.50. Tax rates are integer micro-units (88750 is 8.875%).
Updates are PATCH and take only the fields you are changing.
Lists answer { testMode, length, data }.
Deletes answer { id, object, message, deleted: true }.
Errors answer { message } with a 4xx or 5xx status.
Webhooks are signed with VenueRun-Signature — see the Webhooks page.