# Vantr Developer Docs

> Build v2 integrations with the Vantr Developer API.

## Docs

- [Describe v2 API capabilities](https://docs.vantr.ai/api-reference/capabilities/get-api-capabilities.md): Use this endpoint to discover available product, category, vendor, and location actions with the scopes required for each current v2 resource.
- [List dated API versions](https://docs.vantr.ai/api-reference/capabilities/get-api-versions.md): Public discovery of supported X-API-Version release dates (no authentication required). Send the X-API-Version request header (YYYY-MM-DD) to pin a release, or omit it for the latest. Unknown versions return 400 unsupported_api_version.
- [Archive a category](https://docs.vantr.ai/api-reference/categories/archive-category.md): Archives a leaf category using categories.write.
- [Create a category](https://docs.vantr.ai/api-reference/categories/create-category.md): Create a category
- [Get a category](https://docs.vantr.ai/api-reference/categories/get-category.md): Get a category
- [Get category tree](https://docs.vantr.ai/api-reference/categories/get-category-tree.md): Get category tree
- [List categories](https://docs.vantr.ai/api-reference/categories/list-categories.md): Returns category and subcategory records available through the v2 catalog API.
- [Update a category](https://docs.vantr.ai/api-reference/categories/update-category.md): Updates category name or parent_category_id while enforcing the category and subcategory hierarchy.
- [Get a tenant location](https://docs.vantr.ai/api-reference/locations/get-location.md): Returns one tenant-owned location. Locations owned by another tenant return 404.
- [List tenant locations](https://docs.vantr.ai/api-reference/locations/list-locations.md): Returns tenant-owned locations ordered by name. Use this endpoint to discover valid location_id values before creating order or session activity through public APIs.
- [Exchange OAuth grants for opaque access tokens](https://docs.vantr.ai/api-reference/oauth/exchange-oauth-token.md): Use HTTP Basic client authentication. Supports client_credentials, authorization_code with S256 PKCE, and refresh_token. Password and implicit grants are intentionally unsupported.
- [OAuth authorization server metadata](https://docs.vantr.ai/api-reference/oauth/get-oauth-authorization-server-metadata.md): OAuth authorization server metadata
- [Introspect an opaque access token](https://docs.vantr.ai/api-reference/oauth/introspect-oauth-token.md): Introspect an opaque access token
- [Revoke an access or refresh token](https://docs.vantr.ai/api-reference/oauth/revoke-oauth-token.md): Revoke an access or refresh token
- [Start authorization-code flow with PKCE](https://docs.vantr.ai/api-reference/oauth/start-oauth-authorization-code-flow.md): Start authorization-code flow with PKCE
- [Create an order](https://docs.vantr.ai/api-reference/orders/create-order.md): Creates an order with optional line items. Orders default to DRAFT state; items may reference tenant product variations or carry free-form names and prices. Order totals are computed from line items.
- [Record an order payment or authorization hold](https://docs.vantr.ai/api-reference/orders/create-order-payment.md): Records a payment fact on an OPEN or COMPLETED order. Create with status AUTHORIZED to model a card preauthorization — a not-to-exceed hold that can be adjusted and later captured for a lower final total. Only COMPLETED payments count toward order tender totals; holds never do. Currency and payment_…
- [Get an order](https://docs.vantr.ai/api-reference/orders/get-order.md): Get an order
- [List order payments](https://docs.vantr.ai/api-reference/orders/list-order-payments.md): List order payments
- [List orders](https://docs.vantr.ai/api-reference/orders/list-orders.md): Lists tenant orders with line items and payments, newest first.
- [Update an order](https://docs.vantr.ai/api-reference/orders/update-order.md): Moves order state along DRAFT to OPEN to COMPLETED or CANCELED, updates external references, or replaces line items. Items lock after a payment is recorded or the order reaches a terminal state.
- [Update an order payment, adjust an authorization, or capture it](https://docs.vantr.ai/api-reference/orders/update-order-payment.md): While a payment is an AUTHORIZED hold: PATCH amount_money to raise or lower the authorization (incremental/decremental auth), or PATCH status to COMPLETED — optionally with a lower amount_money — to capture the final total; the unused remainder is recorded as released, and capturing above the hold r…
- [Archive a product](https://docs.vantr.ai/api-reference/products/archive-product.md): Archives the product and its variations using products.write.
- [Archive a product variation](https://docs.vantr.ai/api-reference/products/archive-product-variation.md): Soft-archives one variation. Products must keep at least one active variation.
- [Create a product with variations](https://docs.vantr.ai/api-reference/products/create-product.md): Creates one product plus one or more variations. Products can carry custom tags for organization and filtering; variations can carry flags such as Organic and SNAP/EBT eligibility. Square sync is queued through the normal catalog sync flags when sync is enabled.
- [Create a product variation](https://docs.vantr.ai/api-reference/products/create-product-variation.md): Create a product variation
- [Get a product](https://docs.vantr.ai/api-reference/products/get-product.md): Get a product
- [List products and variations](https://docs.vantr.ai/api-reference/products/list-products.md): Returns product records, variations, category assignments, product tags, and variation metadata available through the v2 catalog API.
- [Update product fields](https://docs.vantr.ai/api-reference/products/update-product.md): Updates name, description, category_id, custom tags, sync enablement, and archive state.
- [Update a product variation](https://docs.vantr.ai/api-reference/products/update-product-variation.md): Update a product variation
- [Read tenant API usage totals](https://docs.vantr.ai/api-reference/usage/get-public-api-usage.md): Read tenant API usage totals
- [Create a vendor](https://docs.vantr.ai/api-reference/vendors/create-vendor.md): Create a vendor
- [Deactivate a vendor](https://docs.vantr.ai/api-reference/vendors/deactivate-vendor.md): Deactivates the vendor using vendors.write.
- [Get a vendor](https://docs.vantr.ai/api-reference/vendors/get-vendor.md): Get a vendor
- [List vendors](https://docs.vantr.ai/api-reference/vendors/list-vendors.md): Returns vendor profile data available through the v2 catalog API.
- [Update a vendor](https://docs.vantr.ai/api-reference/vendors/update-vendor.md): Update a vendor
- [Register a webhook endpoint](https://docs.vantr.ai/api-reference/webhooks/create-webhook.md): Registers a webhook endpoint. The signing secret is returned ONCE in this response and never again — store it to verify the X-Webhook-Signature (sha256) header on delivered events.
- [Delete a webhook endpoint](https://docs.vantr.ai/api-reference/webhooks/delete-webhook.md): Delete a webhook endpoint
- [Get a webhook endpoint](https://docs.vantr.ai/api-reference/webhooks/get-webhook.md): Get a webhook endpoint
- [List webhook endpoints](https://docs.vantr.ai/api-reference/webhooks/list-webhooks.md): List webhook endpoints
- [Update a webhook endpoint](https://docs.vantr.ai/api-reference/webhooks/update-webhook.md): Update a webhook endpoint
- [Authentication](https://docs.vantr.ai/authentication.md): Authenticate v2 requests with client credentials or OAuth bearer tokens.
- [API changelog](https://docs.vantr.ai/changelog.md): API release history generated from Vantr API release tags and published developer release notes.
- [Use the docs with AI](https://docs.vantr.ai/guides/ai-tools.md): Connect Vantr developer documentation to AI tools with Markdown exports, llms.txt, skill.md, and the hosted docs MCP server.
- [API conventions](https://docs.vantr.ai/guides/api-conventions.md): Understand base URLs, auth headers, pagination, response envelopes, and archive behavior.
- [API versioning](https://docs.vantr.ai/guides/api-versioning.md): Pin a dated release with the X-API-Version header so your integration never breaks when the API evolves.
- [Catalog workflows](https://docs.vantr.ai/guides/catalog-workflows.md): Create products, categories, and vendors with realistic v2 API examples.
- [Generate clients](https://docs.vantr.ai/guides/client-generation.md): Generate typed clients from the Vantr OpenAPI spec.
- [Developer Center](https://docs.vantr.ai/guides/developer-center.md): How the Vantr API-host developer experience is organized across docs, portal, OpenAPI, sandbox, and AI discovery surfaces.
- [Errors and recovery](https://docs.vantr.ai/guides/errors.md): Handle OAuth errors, v2 API error envelopes, validation failures, and archive conflicts.
- [Authorize a user (OAuth)](https://docs.vantr.ai/guides/oauth-authorization-code.md): Let an Vantr merchant grant your app delegated v2 access with the OAuth 2.0 authorization code flow and PKCE.
- [Scopes](https://docs.vantr.ai/guides/scopes.md): Pick the v2 API scopes your integration needs.
- [Usage and capabilities](https://docs.vantr.ai/guides/usage-and-capabilities.md): Discover available v2 resources and read API usage totals.
- [Webhooks](https://docs.vantr.ai/guides/webhooks.md): Receive signed, retried event deliveries and verify they came from Vantr.
- [Vantr Developer API](https://docs.vantr.ai/index.md): Build v2 integrations with products, vendors, locations, and usage reporting.
- [Quickstart](https://docs.vantr.ai/quickstart.md): Create credentials, choose scopes, and call the v2 API.

## OpenAPI Specs

- [v2](https://docs.vantr.ai/openapi/v2.json)