Glossary

Canonical terms for sellers, SKUs, allocations, orders, and fulfillment.

TopicsWelcome

Canonical Seller API terms. Prefer these spellings in integration code and runbooks. The render pipeline auto-links these terms in other guides — keep headings stable. Field, id, path and operation names follow one convention, listed with the older names that still work in Naming conventions.

Jump to: A · B · C · D · E · F · G · H · I · K · L · M · O · P · Q · R · S · T · V · W

Parties#

Seller#

The storefront / content seller company integrating the Seller API.

See Overview.

Vendor#

The content owner (studio / publisher) that owns products and inventory. Use vendor in technical prose — not “publisher” as an API role name.

See How Avrix works.

Partner#

A vendor company connected to you via an active agreement. Listed by GET /partners.

See Authentication.

Catalog and sellability#

SKU#

Stock-keeping unit — the sellable product variant (platform, edition, region). Identified by skuId or skuCode (e.g. SANDBOX-ALWAYS-001).

See Catalog and allocations.

BMA#

Business Model Agreement — the commercial terms for one business model (api, revenue_share, wholesale, pre_order) between a vendor and a seller, signed under the master agreement (MCA, Master Collaboration Agreement). First of the four sellability gates. GET /partners/{connectionId}/agreements lists the agreed terms.

See How Avrix works and Pricing view and BMA authority.

Share#

Vendor permission for a seller to see / order a SKU in catalog scope. Share without allocation is not enough to sell.

Not to be confused with a platform event share (share_id, /promotions/shares): a promotion a vendor offers you as part of a platform-wide sale. See Promotions.

See Catalog and allocations and Sellable SKU readiness.

Allocation#

Capacity granted by a vendor to a seller for a SKU. GET /allocations with sellable: true is authoritative for checkout.

See Catalog and allocations.

Allocation grant#

The capacity record behind GET /allocations (grant id, remaining units, wholesale price). Hot paths read grants, not legacy allocation tables.

See Catalog and allocations.

Sellable#

A SKU you may commit right now — all four gates open and GET /allocations reports sellable: true. Catalog presence alone is not sellable.

See Sellable SKU readiness.

Catalog#

Products and SKUs visible to you via shares. Browse via /products, /catalog/snapshot, /catalog/changes.

See Catalog and allocations and Product field matrix.

Launch phase#

Product lifecycle dimension that gates catalog visibility (for example available). Non-live phases are excluded from sellable browse.

See Sellable SKU readiness.

Trading state#

Commercial open/closed dimension on releases. Checkout rejects products that are not open for trade.

See Sellable SKU readiness.

Territory#

Geographic rules for where a SKU may be sold; driven by buyer salesCountryCode / countryCode (e.g. US).

See Territory enforcement and Where a sale is allowed.

Granted territory#

Countries the live API Agreement gives this Content Seller, frozen as a list when the invite was sent and printed in the Commercial Schedule. The Content Owner widens it by extending the territory from partner settings, or by an amendment; only an amendment can change the mode or narrow it.

See Where a sale is allowed.

Selling footprint#

Countries and currencies the Content Seller declared they sell in. An undeclared country is refused even when it was granted.

See Where a sale is allowed.

Title region#

The catalog region on the SKU. Every SKU on the same region shares that country set.

See Where a sale is allowed.

Partner lock#

A Content Owner removes a granted country for one Content Seller, for every title under that Agreement. A lock can only remove a country.

See Where a sale is allowed.

Title lock#

A Content Owner removes a covered country for one title, for every partner. Leave it empty unless that title must be stricter than the deal.

See Where a sale is allowed.

Snapshot#

Full catalog export from GET /catalog/snapshot for bootstrap sync. Pair with allocations for sellability.

See Catalog and allocations.

Tombstone#

A delete/remove marker in GET /catalog/changes?since= so clients can drop SKUs that left the share.

See Catalog and allocations.

Checkout and orders#

Availability#

Commit-time stock / sellability check (GET /availability). List expand fields are advisory.

See Order preview.

Preview#

POST /orders/preview — read-only fulfilability and price confirmation (canFulfill, unitPriceCents).

See Order preview.

Order#

A committed sale / reservation created via POST /orders (or reserve/commit). Consumes capacity when fulfilled.

See Creating orders and Order lifecycle.

orderReference#

Your immutable business identifier for the sale (e.g. store-order-10432). Required on create order; used for lookup and finance. Distinct from Idempotency-Key.

See Creating orders and Idempotency.

Idempotency-Key#

HTTP header that makes a write retry-safe for 24 hours when the body matches. Does not replace orderReference as business identity.

See Idempotency.

Checkout hold#

Soft stock hold (POST /orders/hold) while the buyer pays; pass checkoutHoldId into POST /orders when enabled. Not the same as hot-drop reservation.

See Checkout holds.

Reservation#

Hot-drop slot lock (POST /orders/reserve → POST /orders/commit) with a short TTL. Used only when the allocation is in hot-drop mode.

See Hot drop.

Hot drop#

High-contention allocation mode that requires reserve → commit (or extend) instead of a plain POST /orders.

See Hot drop.

Price commitment token#

Optional signed token from preview that binds the wholesale unit price through payment and commit.

See Order preview.

Replay#

Returning the original fulfilment for a repeated orderReference instead of selling again. Partial prior fulfilment cannot be topped up.

See Idempotency and Order lifecycle.

integrationOrderContext#

Partner-declared checkout evidence (country, currency, retail gross, payment-processor reference, consumer IP, …) attached to commercial mutations.

See Order context.

Wholesale unit price#

Catalog/wholesale price Avrix validates on commit — echo preview’s unitPriceCents as expectedUnitPriceCents.

See Order preview and Pricing view and BMA authority.

Fulfilment and keys#

Fulfilment#

Delivery of entitlements (plaintext keys) after a successful order.

See Fulfilment and keys.

Key#

Digital game code plaintext. Returned only on mutation responses as a string in keys[]; never on GET /orders or webhooks.

See Fulfilment and keys.

keyIds#

Parallel UUID array on order success (keyIds[i] matches keys[i]). Required for refunds and returns — persist with the plaintext.

See Key return policy.

Delivery mode#

deliveryMode on order responses. The public Seller API delivers keys with "key" (plaintext codes; the default).

See Fulfilment and keys.

Quarantine#

Refund / return path that takes fulfilled keys out of circulation via POST /refunds or POST /keys/return using keyIds.

See Key return policy.

Environments and operations#

Sandbox#

Shared test environment with magic SKUs and test keys. Keys prefixed like avrix_sk_sbx_… on production hosts.

See Sandbox and Environments.

Production#

Live agreements, real keys, full commercial evidence enforcement.

See Sandbox to production and Go-live.

Magic SKU#

Deterministic sandbox SKU codes (for example SANDBOX-ALWAYS-001) for golden-path and negative-path tests.

See Sandbox.

Webhook#

Signed HTTPS push of lifecycle events. At-least-once; dedupe on eventId.

See Webhooks and Event reference.

Event ID#

Stable id on every webhook delivery (eventId). Deduplicate before applying side effects.

See Webhooks.

Scope#

Permission string on an API key (for example seller:orders:write). Empty scopes are denied.

See Scope matrix.

OAuth access token#

Short-lived opaque Bearer (avrix_oat_*) minted via OAuth2 client credentials and mapped to an API key. Same scopes, environment, and IP rules as the underlying key.

See OAuth tokens.

Child key#

API key created by POST /api-keys (older path POST /keys) from a parent key. Scopes are the server default set intersected with the parent’s scopes; environment and expiry inherit from the parent.

See API key management.

Promotion share#

Platform-event promotion a vendor shared with your seller company. Accept or decline via the promotions API; discount tables are available after accept.

See Promotions.

Custom deal#

Vendor-specific promotion (not a platform event) that your seller company can approve or reject.

See Promotions.

Next steps#

What links here

Published guides that link to this page.

Search docs

Search documentation…