AvrixDocumentation
API referenceStatusAvrix.ioConsole
Seller API

Welcome

  • Home
  • Getting started
  • Topic index
  • Glossary

Get started

  • Overview
  • How Avrix works
  • Architecture patterns
  • Quickstart
  • Integration tutorial
  • Authentication
  • OAuth tokens
  • Environments
  • Sandbox

Connect a partner

  • Partner onboarding
  • Sellable SKU readiness
  • Territory enforcement
  • AI assistants (MCP)
  • Connect your AI client
  • Sign-in and permissions

Catalog

  • Catalog & allocations
  • Product field matrix
  • Pricing authority
  • Currency and FX
  • Promotions
  • Caching & fairness

Sell an order

  • Store integration profiles
  • Order preview
  • Creating orders
  • Idempotency
  • Order context
  • Checkout holds
  • Hot drop
  • Fulfillment & keys
  • Keyless fulfilment
  • Order lifecycle
  • Refunds & returns

Stay in sync

  • Webhooks
  • Event reference
  • Polling & reconciliation
  • Reconciliation
  • Finance & settlement

Operate

  • Error reference
  • Troubleshooting
  • Key recovery
  • Rate limits
  • Security
  • Secrets & config
  • API key management
  • IP allowlist
  • Monitoring & support
  • Data handling
  • Partner runbook

Go live

  • Testing
  • Certification
  • Integration checklist
  • Sandbox to production
  • Go-live
  • Deployment targets

Reference

  • Integration recipes
  • Scope matrix
  • Commerce platforms
  • API clients
  • Client & helpers
  • Versioning
  • Changelog
  • FAQ
  • API reference

Seller API

Use the Seller API to integrate game stores, marketplaces, and backends with Avrix.

The Seller API is a server-to-server HTTP API for content sellers (game stores and distribution backends). Authenticate with API keys from Settings → Integrations, sync catalog and allocations, preview checkout, create orders, and receive fulfillment via the response and/or signed webhooks. Never expose API keys in browsers or mobile clients.

Start integratingAPI reference

Choose a path

Evaluate the platform

Understand the vendor/seller model, four sellability gates, and what goes live.

Build an integration

End-to-end tutorial from auth through catalog, checkout, webhooks, and reconciliation.

Review security

API keys, optional IP allowlists, webhook signatures, and rotation.

Reconcile finance

Per-sale records, settlement meaning, refunds, and finance API surfaces.

Get started

  • Quickstart (~15 minutes)Run health → partners → catalog → preview → order end to end.
  • SandboxTest with sandbox keys and deterministic magic SKUs.
  • Scope matrixSee which scopes each route requires before going live.
  • Getting started hubProfiles, recipes, and operational guides for launch.
  • Topic indexBrowse every published guide organized by topic.
  • IP allowlistOptional egress IP restrictions for API keys.

Golden path

Health → partners → catalog sync → preview → charge at your PSP → create order → webhook → reconcile. Never charge when preview says you cannot fulfill.

Diagram
noyesGet startedConnect partnerSync catalogPreviewcanFulfill?Do not chargeCharge PSPCreate orderStay in syncReconcile
noyesGet startedConnect partnerSync catalogPreviewcanFulfill?Do not chargeCharge PSPCreate orderStay in syncReconcile

Quickstart

Sandbox path to a fulfilled order with SANDBOX-ALWAYS-001.

Partner onboarding

Get a live BMA, share, allocation, and territory price before catalog sync.

Catalog & allocations

Merge snapshot with allocations — shared SKUs alone are not sellable.

Creating orders

Idempotent POST /orders after a successful preview and PSP charge.

Webhooks

Verify HMAC signatures and treat deliveries as at-least-once.

Next steps

  • WebhooksSubscribe to order.fulfilled and catalog change events.
  • Catalog syncMerge snapshot, allocations, and change deltas fairly.
  • Order preview & commitPreview pricing, optional reserve/commit for hot drops.
  • Error playbookStructured codes, hints, and doc_url deep links.
  • SDK & helpersGenerated TypeScript client and integration helpers.
  • Partner runbookSandbox vs production, strict mode, and operational checks.

Quick links

Error reference

HTTP statuses, canonical codes, and recovery actions.

Event reference

All Seller API webhook events with triggers and payloads.

Changelog

Dated contract and documentation changes.

System status

Public operational status for the Seller API.

OpenAPI reference

Interactive Scalar docs from the machine-readable contract.

OpenAPI JSON

Download the machine-readable Seller API contract for code generators.

Postman collection

Ready-made Seller API collection for Postman. Point baseUrl at https://api.avrix.io and use a sandbox or production key.

Client & helpers

Generate a typed client from OpenAPI; HTTP patterns without npm packages.

Need help with this page?

Contact support

AI tools

  • Ask ChatGPT
  • Ask Claude

On this page

  • Choose a path
  • Get started
  • Golden path
  • Next steps
  • Quick links

Search docs

Search documentation…