Skip to main content

Developer API

v2 API Connect Vantr to your catalog, vendor, location, and reporting workflows with scoped credentials managed from the developer portal.

Open Developer Center

Manage apps, credentials, scopes, usage activity, webhooks, and API-host developer workflows.

Run the quickstart

Create an application, choose scopes, and make a verified read request from your server.

Explore the reference

Browse generated endpoint pages from the same OpenAPI spec that ships with this docs site.
Manage applications, secrets, and request activity in the API-host developer portal. Use these docs for implementation details, endpoint behavior, and generated clients.

First-class API host

api.vantr.ai is the API endpoint and the developer experience home. API-only users can use the Developer Center for docs, OAuth applications, OpenAPI, SDK starters, request activity, webhooks, and sandbox workflows without moving through the business app.

Developer Center blueprint

See how Vantr separates marketing, app, docs, portal, OpenAPI, sandbox, and AI discovery surfaces.

What you can build

Catalog automation

Create and update products, variations, categories, and vendor profiles from your system of record.

Location-aware workflows

Read tenant locations and attach valid location_id values to downstream workflows.

Usage visibility

Read API usage totals and discover the resources available to a given application.

First useful call

Use locations as the first smoke test. The request proves authentication, tenant binding, pagination, and JSON parsing without changing data.
A successful locations request returns success, locations, and pagination fields.

Developer workflow

Create an application

Create an Vantr developer application and save the client secret in your server-side secret manager.

Pick narrow scopes

Start with read scopes while developing. Add write scopes only for endpoints your integration calls.

Call v2 endpoints

Use confidential client auth for server-to-server calls or exchange OAuth grants for bearer tokens.

Generate a client

Use the committed OpenAPI file at /openapi/v2.json to generate typed clients for your stack.

Guide shortcuts

API conventions

Learn the base URL, auth headers, pagination parameters, and response envelope patterns.

Catalog workflows

Follow product, category, and vendor examples with realistic request bodies.

Errors and recovery

Handle OAuth errors, permission failures, validation responses, and archive conflicts.

Use with AI tools

Connect the docs MCP server, install the API skill, and give agents the OpenAPI contract.

Reference shortcuts

Products

Product and variation catalog endpoints.

Categories

Category list, tree, create, update, and archive endpoints.

Vendors

Vendor profile read and write endpoints.