Seller API topic index
A curated map of every published Seller API guide — start here when you know the topic but not the page.
Welcome
Get started
- Seller API overviewWhat the Seller API does, who it is for, and the golden-path integration shape.
- How Avrix worksBMA, share, allocation, territory pricing, and how money moves.
- Architecture patternsWhere Seller API fits in your stack — service layer, workers, and server-only keys.
- QuickstartAbout 15 minutes from health check to your first fulfilled order.
- Integration tutorialEnd-to-end walkthrough from authentication to reconciliation, including failure paths.
- AuthenticationAPI keys, scopes, environments, rotation, and IP allowlists.
- Seller API OAuth tokensMint short-lived Bearer tokens with OAuth2 client credentials mapped to your API key when you cannot ship a long-lived secret.
- EnvironmentsSandbox and production share api.avrix.io; key prefixes, fixtures, and behavioral differences.
- SandboxTest environments, magic SKUs, and auth triage.
Connect a partner
- Partner onboardingHow BMA, share, allocation, and territory pricing become live — and how to inspect them from partners, catalog, and allocations APIs.
- Sellable SKU readinessWhich endpoint is authoritative for checkout-ready SKUs, and sellableOnly filtering.
- Territory enforcementSales-country and geo rules that return hard 4xx at preview and commit.
Catalog
- Catalog & allocationsThe four gates that make a SKU sellable, and how to sync them.
- Product field matrixWhich product fields appear on list, detail, allocations, and webhooks.
- Pricing authorityList vs wholesale vs declared retail — which price binds at checkout.
- Seller API promotionsList, accept, and decline platform event shares and custom vendor deals that change what you can sell through the API.
- Caching & fairnessETag, snapshot caching, rate-limit classes, and fair multi-route usage.
Sell an order
- Store integration profilesProfile A/B/C checkout patterns — preview, hold, and hot-drop.
- Order previewRead-only price and fulfillment estimate before checkout.
- Creating ordersPOST /orders fields, safe creation pattern, and unknown-outcome recovery.
- Idempotency & retriesIdempotency-Key contract, orderReference, and safe retry behavior.
- Order contextintegrationOrderContext field matrix, production evidence, and validation layers.
- Checkout holdsPOST and DELETE /orders/hold for soft inventory reservation at checkout.
- Hot-drop reserve & commitHigh-throughput reserve and commit for vendor-declared launches.
- Fulfillment & keysKey custody, deferred reveal, and why GET /orders never returns plaintext.
- Order lifecycleStates, transitions, and recovery from preview to fulfillment.
- Refunds & returnsKey quarantine, refunds API, and why Avrix never refunds your PSP.
Stay in sync
- WebhooksSigned delivery, event types, retries, and verification.
- Event referenceAll Seller API webhook events with triggers and payload shapes.
- Polling & reconciliationRecover from missed webhooks with deliveries replay and order reads.
- ReconciliationTie storefront orders to Avrix aggregates and resolve discrepancies.
- Finance & settlementWhat is recorded, settled, and invoiced after API sales.
Operate
- Error referenceHTTP statuses, canonical error codes, and recovery actions.
- TroubleshootingSymptom-first trees for auth, empty catalog, inventory, idempotency, and webhooks.
- Rate limitsPer-tier request ceilings, headers, and Retry-After guidance.
- SecurityCredential handling, rotation, allowlisting, and webhook safety.
- Secrets & configKey storage, sandbox vs production separation, and zero-downtime rotation.
- API key managementCreate child keys, rotate secrets, update IP allowlists, and revoke keys over the API without signing into the console.
- IP allowlistOptional egress IP restrictions for API keys.
- Monitoring & supportWhat to alert on, requestId correlation, and escalation.
- Data handlingController/processor roles, order context privacy, and key material.
- Partner runbookSandbox vs production, strict mode, and operational checks.
Go live
- TestingSandbox magic SKUs, mocks, contract tests, and webhook verification.
- CertificationRequired sandbox test cases and evidence format before production access.
- Integration checklistPhase-by-phase tracker from evaluation through post-launch.
- Sandbox to productionReadiness checklist and cutover steps before your first live order.
- Go-liveProduction prerequisites, cutover procedure, and rollback.
- Deployment targetsServerless, containers, and workers — cold starts, secrets, and webhook timeouts.
Reference
- Integration recipesScopes, call order, and idempotency for each flow.
- Scope matrixAuthoritative mapping of API key scopes to routes.
- Commerce platformsShopify, WooCommerce, Magento, keyshops, game backends, and platform-store boundaries.
- API clientsProduction HTTP client patterns per language — config, reuse, and retries.
- Client & helpersGenerate a typed client from OpenAPI and implement production HTTP patterns.
- Versioning & compatibilityURL version, X-Avrix-Api-Version date contract, and deprecation policy.
- ChangelogDated documentation and contract changes for Seller API integrators.
- FAQShort answers on sellability, keys vs keyless, idempotency, webhooks, and sandbox.
- API referenceInteractive OpenAPI browser on the API host.