Connect your storefront checkout to Avrix so it can confirm sellability and fulfil an entitlement when a customer buys.
Who needs this#
Content Sellers with or building their own storefront software who need checkout, entitlement delivery, and reconciliation connected to Avrix.
TL;DR#
- The Seller API is the standard fulfilment path for storefront checkout. Your store's backend checks readiness, previews the order, and requests fulfilment after your payment provider confirms the customer payment.
- API Revenue Share checkout requires an active API Revenue Share BMA, the SKU in that BMA's Share, API Revenue Share allocation capacity, and valid territory pricing. The Seller API does not turn another model's Agreement or allocation into API Revenue Share sellability.
- API Revenue Share key-based fulfilment uses allocation at checkout; keys do not move into Inventory → Stock first.
- Keyless fulfilment is a variation that returns a hosted redemption experience instead of a plaintext key. It is available only when enabled for your company and supported by the product's provider path.
- Technical setup belongs in the public Seller API overview and Quickstart.
What this changes#
The API connects your storefront backend to the same commercial relationship you manage in the console. It lets your storefront:
- keep its sellable catalog aligned with partner scope and allocation;
- confirm that an order can be fulfilled before the customer is charged;
- request the key or hosted redemption link after payment; and
- reconcile fulfilment and adjustments with Avrix records.
It does not replace your checkout, payment provider, retail pricing, tax handling, customer support, or partner Agreements.
Prepare the commercial side first#
Before production checkout, confirm:
- the partner MCA and applicable API Revenue Share BMA are active;
- the SKU is in the BMA catalog scope;
- API Revenue Share allocation capacity is available;
- territory catalog pricing is valid for the buyer context; and
- product lifecycle and key inventory or keyless provider readiness are live.
Your technical team should still make a live readiness check during checkout. A catalog item being visible in the console is not enough.
Hand off to your technical team#
- Start with the public Seller API overview for the commercial model and supported integration journey.
- Follow the public Quickstart to complete a sandbox order safely.
- When Settings → Integrations → API Keys is enabled for your company, create and manage credentials there. API keys are sensitive backend credentials; your technical team must never place them in browser or mobile-app code.
- Agree who owns catalog sync, checkout fulfilment, customer refunds, monitoring, and reconciliation before go-live.
This console guide deliberately stops at the business handoff. The linked developer pages contain the current request formats, code examples, security guidance, and go-live checks.
Key-based and keyless fulfilment#
- Key-based: a successful checkout fulfils a key from Content Owner inventory against your API Revenue Share allocation.
- Keyless: a successful checkout provides a hosted redemption experience instead of plaintext. Inventory → Keyless orders appears only when keyless is enabled for your company; provider readiness replaces key-inventory readiness.
Both variations require the active API Revenue Share BMA, its Share, API Revenue Share allocation, territory Price, and lifecycle checks. Keyless is not a way around missing commercial readiness.
You are ready for checkout when…#
The API Revenue Share BMA is active, the SKU is in its Share, API Revenue Share allocation and territory Price are available, the product and fulfilment path are live, your storefront can preview and create an order from its backend, and your operations team can reconcile fulfilments and report customer adjustments.
Example: A buyer selects a German PC SKU. Your storefront confirms that the SKU is sellable for Germany, previews fulfilment, takes payment through your payment provider, then creates the Avrix order and delivers the returned key or redemption link.
Common problems#
"Can I use a wholesale or Traditional Revenue Share BMA for API Revenue Share checkout?" No. API Revenue Share checkout requires the active API Revenue Share BMA and API Revenue Share allocation for that partner and SKU.
"I cannot see API Keys or Keyless orders." Those screens are shown only when the relevant feature is enabled for your company and you have suitable permissions. Confirm access with your Avrix contact rather than assuming the integration is ready.
"My developer has questions the console docs don't answer." Send them to the Seller API overview and Quickstart. Those pages are the maintained technical source.
Next steps#
- Inventory & selling — compare API Revenue Share checkout with held Stock
- Money & reports — reconcile API-generated reporting