Skip to main content

API conventions

The v2 API uses scoped credentials, JSON request bodies, predictable response envelopes, and offset pagination where list endpoints support it.

Base URLs

Vantr uses separate hosts for the public site, the signed-in web app, and API traffic.
The Vantr app calls the business/application API under /v1. Third-party integrations use the developer API under /v2. API-only users can manage apps, credentials, OAuth consent, docs, and v2 traffic from api.vantr.ai.

Authentication headers

Most server-to-server integrations use Basic auth. OAuth integrations use bearer tokens.

Request bodies

Write endpoints accept JSON. Use snake_case field names exactly as they appear in the OpenAPI reference.
string
required
Human-readable product or category name.
string | null
UUID of the category to assign to a product. Use null to leave the product uncategorized.
object[]
required
One or more product variations when creating a product.

List pagination

List endpoints that support pagination use limit and offset.
integer
default:"50"
Number of records to return. Endpoints that define maximum currently cap this at 100.
integer
default:"0"
Number of records to skip before returning the next page.
cURL
object
Pagination metadata returned by paginated list endpoints.

Response envelopes

Read endpoints return a success boolean with resource-specific fields.

List locations

success, locations, pagination

List products

success, products, pagination

Capabilities

success, capabilities

Archive and deactivate behavior

Delete-style endpoints use domain-safe status changes:

Products and categories

Archive records so catalog history can stay connected.

Vendors

Deactivate vendor profiles instead of removing vendor history.
Prefer explicit update calls when you need to change fields. Use archive or deactivate calls when the record should no longer appear in normal active lists.