Purpose: Field-by-field map of what the Seller API exposes for store sync and checkout. Use this when building a catalog mirror or asking “is field X on list, detail, or allocations?”
Related: Sellable SKU readiness, Pricing authority.
How to read this document#
| Column | Meaning |
|---|---|
| Seller API | Endpoint(s) that expose it (or — if not exposed) |
| Status | exposed · runtime-only (returned but not in OpenAPI) · console-only · webhook-only · intentionally omitted |
Three surfaces (by design)#
Integrators merge browse, rich metadata, and checkout authority:
| Surface | Endpoints | Role |
|---|---|---|
| Browse / mirror | GET /products, GET /catalog/snapshot, GET /catalog/changes | Fast sync; presentation-oriented (may include non-sellable products) |
| Rich metadata | GET /products/{id}, GET /products/{id}/pricing | Store copy, edition tree, list prices |
| Checkout authority | GET /allocations, GET /availability | sellable, wholesale price, stock headroom |
Merge catalog with allocations (paginated) so sellability comes from GET /allocations
(sellable: true), not from catalog lists alone. Use GET /catalog/changes?cursor= for
tombstones, facet deltas and price changes (which never move a product's updatedAt) and
GET /catalog/checksum for mirror drift detection. Echo
expectedUnitPriceCents from preview on every commercial commit. See
Client & helpers for optional typed-client generation.
Identity & taxonomy#
| Field | Seller API | Status | Notes |
|---|---|---|---|
id | List, detail, allocations | exposed | UUID |
readableId | List, detail | exposed | e.g. prd_… |
name, slug | List, detail, allocations (productName) | exposed | |
productType | List, detail | exposed | Closed set: game, dlc, expansion, bundle, edition, soundtrack, currency, other |
productCategory | — | intentionally omitted | Console / vendor only |
status (legacy rollup) | List, detail | exposed (deprecated) | Derived from the lifecycle dimensions; use launchPhase / tradingState / isArchived |
createdAt | List, detail | exposed | |
updatedAt | List, detail | exposed | Watermark for updatedSince |
developer, creditedPublisher (display strings) | Detail | exposed | The studio and the publisher the store page credits, as the Content Owner entered them; null when not set. creditedPublisher can differ from publisherCompanyName, the company that sells to you. Additive |
| External reference lookup | GET /products/lookup?externalReference= | exposed | Up to 100 Steam app ids, Steam package ids or platform product ids in one call; one row per value with the matching product, SKU and reference. GET /products?externalReference= filters the list by one |
relatedProducts[] (requires / includes / edition_of) | Detail + catalog snapshot | exposed | DLC→base (requires), bundle contents (includes), edition lineage (edition_of); only seller-visible targets listed. Preview adds advisory warnings: ["REQUIRES_BASE_GAME"] |
parentProductId, child products | Via relatedProducts (raw ids not exposed) | exposed | Superseded by relatedProducts[] |
Lifecycle#
| Field | Seller API | Status | Notes |
|---|---|---|---|
launchPhase | List, detail (product + per release), webhooks product.updated, product.announced, release.available | exposed | Product-level rollup; release-level effective (inheritance + date auto-advance) |
tradingState | List, detail (product + per release), webhook product.updated | exposed | |
isArchived | List, detail, webhook product.updated | exposed | Archived products are not listed; field is false on visible rows |
announceDate | — | intentionally omitted | |
allowedBusinessModels | — | intentionally omitted | Grant-level on allocations |
Transact paths reject non-live products (PRODUCT_NOT_SELLABLE). Catalog list may still show announced-only products.
Vendor / connection#
| Field | Seller API | Status | Notes |
|---|---|---|---|
publisherCompanyId, publisherCompanyName | List, detail, allocations, partners | exposed | |
publisherCompanyDescription | Detail, partners | exposed | Not store copy |
publisherWebsite, publisherCountry | List, detail, partners | exposed | |
publisherCompanyImageUrl | List, detail, partners | exposed | |
| BMA / share / contract summary | GET /partners contracts | exposed | Not per-product on list |
amendmentId, releaseId, productId, productName, editionName, platformName, message, proposedAt | GET /partners/{connectionId}/offers | exposed | Pending title offers on an active agreement; accept in the console. releaseId is a platform release id, not PricingRelease.releaseId; correlate by productId + editionName + platformName |
Store copy & media#
| Field | Seller API | Status | Notes |
|---|---|---|---|
shortDescription (preferred locale) | List, detail | exposed | locale / Accept-Language |
longDescription, keyFeatures, legalText | Detail localizedDescriptions, edition fields | exposed / runtime-only | |
localizedDescriptions[] | Detail | exposed | All locales; ?locales=de,fr keeps only those (a language keeps its regional variants); ?descriptionFormat=text returns long as plain text |
settlementWarnings | POST /orders, POST /orders/commit, POST /orders/bulk lines, POST /keys/pull as warnings[]; persisted as warnings on GET /finance/api-sales and GET /activity rows | exposed | Internal name on the pull result; the wire name is warnings, documented in OpenAPI. What the settlement noticed but did not refuse over (D15), so a store hears about a declared rate that disagreed with the reference or its own amounts at the moment of sale rather than from a statement. |
supportedLanguages | Detail | exposed | |
eula[] | Detail | exposed | |
coverUrl | List, detail | exposed | |
assets.screenshots/trailers/capsules | Detail | exposed | Direct URLs of the files. Copy them into your own storage: a URL stops resolving when the Content Owner replaces or removes the file. ?omit=assets leaves the block out. See Media download |
systemRequirements | Detail | exposed | min/recommended text |
| Release-level store copy | — | intentionally omitted | Platform-specific notes |
Taxonomy & age ratings#
| Field | Seller API | Status | Notes |
|---|---|---|---|
genres, tags, features | Detail | exposed | { code, name } |
| Release/platform taxonomy | — | intentionally omitted | Product-level only today |
ageRatings[] | Detail | exposed | authority, code, label, minAge |
| Age rating descriptors | — | intentionally omitted |
Edition / release / SKU tree#
| Field | Seller API | Status | Notes |
|---|---|---|---|
editions[] | Detail | exposed | Full tree default; expand=base strips; an unknown expand value is 422 |
| Edition copy | Detail edition fields | runtime-only | short/long/keyFeatures/differentiator |
inheritsProductDescription | Detail | runtime-only | |
releases[] platform/region | Detail | exposed | |
allowedCountries[] | Detail | exposed | ISO alpha-2 |
Preorder window / preorderUnlocked | Detail, preview preorder block | exposed | launchPhase (list/detail/snapshot) says a SKU is pre-order phase; GET /allocations sellable is the transact signal; the window dates decide acceptance on the enabled path |
skus[] | Detail | exposed | Shared SKUs only when BMA selected |
skuType, bundleItems | Detail, availability | exposed / runtime-only | |
activation | Detail, allocations, preview lines | exposed | Guaranteed activation set — { type: worldwide | region_locked, countries }; distinct from sale territory |
externalReferences (Steam app/package) | Detail SKU | runtime-only | |
externalSkuCode | — | intentionally omitted | ERP mapping |
keyTypeCode, keyTypeName | Detail | exposed | |
List aggregates: platformNames, platforms, regions, editionNamesShared | List, snapshot | exposed | |
List sharedSkus[] per-SKU detail | List, snapshot | exposed | platform, edition, SRP per SKU |
Pricing#
| Field | Seller API | Status | Notes |
|---|---|---|---|
listPriceFromCents / listPriceCurrencyCode | List, snapshot | exposed | Lowest list price on the product in your pricing country (the country of your company's default currency; the United States when none is set). Browse hint, not wholesale |
Per-SKU srpPriceCents / srpCurrencyCode / srpCurrencyExponent | List sharedSkus | exposed | In your pricing country. srpCurrencyExponent gives the minor-unit digits of srpCurrencyCode; null when there is no SRP. Additive |
Detail pricing[] per release, /pricing prices[] | Detail, /pricing | exposed, deprecated | Release-level list price before SKU-level pricing; a sale charges the SKU price. Kept for one API version |
prices[] per SKU (countryCode, currencyCode, basePriceCents) | Detail skus[], /pricing skus[] | exposed | The price a sale of that SKU charges, per country, from the canonical price resolver; equal to snapshot territoryPrices and the sale price |
zone (code, label) on every per-country price | Detail pricing[] and skus[].prices[], /pricing prices[] and skus[].prices[], snapshot territoryPrices[], availability price | exposed | The platform price zone of the country (Steam: 41 zones, for example USD_LATAM, "Latin America (USD)"); the same label the content owner sees. null when the platform has no zones yet. Additive |
price (priceCents, currencyCode, currencyExponent, zone) | GET /availability?countryCode= items | exposed | The price a sale in that country charges, with the minor-unit digits of its currency; null when none is set. Additive |
Release status, launchPhase, tradingState | Detail releases, /pricing releases | exposed | One derivation for both (region release → release → edition overrides plus release dates); status is the deprecated rollup and always matches between the two |
wholesaleFromCents (list expand) | List expand=pricing | exposed | Advisory; lowest priced wholesale / pre_order grant. null when you hold none — api grants never contribute |
wholesaleCurrencyExponent, listPriceCurrencyExponent | List expand=pricing | exposed | Minor-unit digits of wholesaleCurrencyCode / listPriceCurrencyCode (2 for USD, 0 for JPY, 3 for KWD); null whenever that band is null. Additive |
listPriceCurrencyExponent (product row) | List, snapshot | exposed | Minor-unit digits of the row's listPriceCurrencyCode, beside listPriceFromCents; null whenever listPriceFromCents is null. Additive |
pricePerKeyCents, currencyCode | GET /allocations, catalog sharedSkus[] | exposed | Authoritative wholesale for wholesale / pre_order. null = no wholesale price, never 0 — always null under businessModel: api, where the cost is a share of the territory list price |
currencyExponent | Next to every money field: allocations and catalog sharedSkus[] wholesale, Detail pricing[] and skus[].prices[], /pricing prices[] and skus[].prices[], snapshot territoryPrices[], availability price, preview lines, total and settlement, POST /orders/hold, refunds, finance rows and declaredRetail, finance CSV, webhook sku.pricing_updated (top level, previousPricing, newPricing) | exposed | ISO-4217 minor-unit digits of the adjacent currency code (2 for USD, 0 for JPY, 3 for KWD); null whenever the price is null. See Money fields |
currencyExponent (finance and orders) | GET /finance/api-sales and /{transactionId} rows and statement lines[] (for salePriceCents, the shares and settlement), integrationOrderContext echo on those rows (response only), GET /finance/statements totals[], activityTotals[], pendingTotals[], quarantinedTotals[], approvedSettlements[] and their invoices[], outstandingBalances[], GET /finance/ledger entries and meta.balances[], GET /finance/invoices rows, GET /finance/invoices/{invoiceId}/reconciliation sales, GET /finance/summary outstandingByCurrency[], paidThisMonthByCurrency[] and currentPeriod.byCurrency[], GET /orders list rows, webhooks invoice.created, payout.file_ready and the order webhooks' integrationOrderContext | exposed | Same meaning: minor-unit digits of the currencyCode in the same object; null on an order list row whose currencyCode is null and on a reconciliation sale without a currency. Additive. There is no separate currencyMinorUnits: ISO 4217's minor unit is this number |
paymentCurrencyExponent | GET /finance/invoices/{invoiceId}/reconciliation | exposed | Minor-unit digits of paymentCurrency, for totalCents and every movement's amountCents; each sale carries its own currencyExponent. Additive |
initialUnitPriceCents, promo, promoResolution | Preview lines, POST /orders/hold | exposed | List price before a settlement promo, the share/deal that discounted unitPriceCents, and whether promotions were readable at quote time |
listPromo, advertisedUnitPriceCents | Preview lines, POST /orders/hold | exposed | Live list_price / both promo the vendor asks you to advertise and the list price with it applied — the product-page was/now. advertisedUnitPriceCents is null on wholesale / revenue-share lines (the line price is your cost, not the territory list price) |
base_price_cents, currency_code | GET /promotions/shares/{shareId}, GET /promotions/deals/{responseId} products | exposed | Informational own-region display price as authored — never a shelf price for a sale country; use preview advertisedUnitPriceCents |
initialSalePriceCents, promo | GET /finance/api-sales, GET /finance/statements lines, api-sales CSV (promoSourceType, promoSourceId, initialSalePriceCents) | exposed | Billed vs list price and promo attribution (sourceType, sourceId) per sale row. Refund, chargeback and reinstatement rows carry the original sale's promo, with initialSalePriceCents null; a promo sale recorded in a second currency before 2026-10-09, when that path still existed, also has initialSalePriceCents null |
customerRegionCode / salesCountryCode, detectedCountryCode, countryMismatch, warnings | GET /finance/api-sales, statements lines, GET /transactions, api-sales CSV | exposed | Declared vs IP-resolved buyer country with a COUNTRY_MISMATCH flag; raw IP never exposed |
Settlement entry (kind, stockMovement, counterparty, promo, economics, …) | GET /activity (+ format=csv) | exposed | One feed over sale / refund / chargeback / pull / reveal at sale grain |
| Tier IDs | — | intentionally omitted | |
priceCents, currencyCode, currencyExponent, countryCode, pricingMode, updatedAt, effectiveAt, previousPricing / newPricing | webhook sku.pricing_updated | webhook-only | Territory list-price change with the explicit old→new pair, each price with its own currencyExponent; effectiveAt is a future instant for a scheduled change. Typed in the OpenAPI webhooks section |
Stock & sellability#
| Field | Seller API | Status | Notes |
|---|---|---|---|
expand=availability | List, snapshot | exposed | Advisory |
GET /availability | Availability routes | exposed | Commit-time |
sellable, readinessBlockers, recommendedAction | GET /allocations, catalog sharedSkus[] | exposed | Same predicate on list/snapshot SKUs; allocations remain checkout authority |
| Plaintext keys | Order response / pull only | intentionally omitted | Never in webhooks |
errorDetails (pull result) | — | intentionally omitted | Internal carrier for guard details on failed pulls; the route merges it into the error envelope details, it is never a success-body field |
staged (pull result) | — | intentionally omitted | Internal: a strict bulk cart pulls every line with stage: true and finalizes them only once all lines pulled; the route consumes it and never serialises it |
replayed (pull result) | — | intentionally omitted | Internal: the pull RPC answered a repeated orderReference with its original keys (same quantity); routes use it to skip webhooks, durable order writes and sale rows, and never serialise it |
settledUnitPrice (pull result) | — | intentionally omitted | Internal: the unit price and currency the sale was billed at (API catalog price after promo / re-price, or the wholesale grant price (promotions do not change it)); routes write the durable order total from it and never serialise it |
activation (type, countries) | GET /allocations, detail SKUs, preview lines, POST /orders, POST /keys/pull, POST /orders/{id}/fulfill | exposed | Guaranteed activation intersection across batches; "activates in" at delivery without a second lookup |
requestAllocation (pull result) | — | intentionally omitted | Internal flag set when a pull fails with ALLOCATION_EXCEEDED; never serialised. On the wire the failure is the ALLOCATION_EXCEEDED error code with details.recommendedAction: request_allocation_increase |
ceiling (per-grant headroom row) | — | console-only | Per-grant allocated quota behind the console catalog's allocated counts; never serialised as-is. The Seller API carries the same grant ceiling as quantityLimit on GET /allocations |
allocatedKeys | — | console-only | Console API only (GET /api/console/v1/partner-products items, GET /api/console/v1/products/{id} stock): sum of active grant ceilings over the product's shared SKUs, 0 when none. Not on GET /products |
businessModels | — | console-only | Console API only (GET /api/console/v1/partner-products items): active BMA models narrowed to the models the vendor offers that product through. On the Seller API the model is per grant (businessModel on GET /allocations) |
buyerVerification (level, riskAction), consumerGeoAttestRequired | GET /allocations; GET /whoami buyerVerificationByPublisher[] | exposed | The buyer verification level the Content Owner set per connection (declared_ip / checkout_attest / checkout_attest_risk); consumerGeoAttestRequired is derived from it. The Content Owner's risk threshold is not exposed |
accessByPublisher (territories, currencies, pending, proposals, enforced) | GET /whoami | exposed | Partner access per connection: granted countries (or worldwide), locked countries with the owner's reason, granted and removed currencies, dated narrowings still to come and open proposals. enforced says whether orders are checked against it yet; while false the agreement governs and this is the same grant, seeded from it |
| Partner access proposals | GET /access/proposals; POST /access/proposals/{id}/accept, /decline | exposed | A Content Owner's offer of more countries or a currency; nothing changes until accepted. Refusals name details.accessCode (for example ACCESS_FX_NOT_COVERED with details.currencyPair). Accept and decline need seller:account:manage |
Orders#
| Field | Seller API | Status | Notes |
|---|---|---|---|
transactionIds | POST /orders (data), POST /orders/bulk successful lines | exposed | Ids of the API sale rows recorded for the order, one per delivered key; same id as GET /finance/api-sales. Always present; [] for pre-orders and non-api business models. Not on POST /orders/commit |
geoWarning (code, enforcementDate?) | POST /orders, POST /orders/commit, POST /orders/preview, POST /orders/hold, POST /orders/reserve (inside data) | exposed | Additive on 200 — the request succeeded. Monitor mode: would-be CONSUMER_* denial. On POST /orders / commit also an enforced mismatch / high-risk verdict the agreement geo policy let through (warn, settle_at_evidence). Omitted otherwise; not on bulk lines or POST /keys/pull |
riskWarning (code) | POST /orders/preview, POST /orders/hold, POST /orders/reserve, POST /orders, POST /orders/commit | exposed | Additive on a 200 under a Content Owner's riskAction: warn: CONSUMER_RISK_HIGH or CONSUMER_RISK_UNAVAILABLE. Never the score |
Catalog sync helpers#
| Field | Seller API | Status | Notes |
|---|---|---|---|
Tombstones added/updated/removed | GET /catalog/changes | exposed | Prefer over updatedSince alone. removed on archive, full delist, and an unshare that ends your access to the product; updated (availability) on a release or SKU level delist, and per SKU (with skuId) when SKUs are unshared or newly shared under a product that stays visible: refetch GET /products/{productId} and re-read GET /allocations sellable |
changedFields | GET /catalog/changes | exposed | Facets per entry (pricing, availability, metadata, territory, relationships); a price change is updated + ["pricing"] and never moves updatedAt |
changedFields | webhook product.updated | exposed | The same facets, once each, when the change that sent the event names them; absent otherwise, and then refetch the whole product. Additive |
nextCursor, hasMore | GET /catalog/changes meta | exposed | nextCursor = position of the last entry (resume point; null only on an empty page); hasMore = page cut at limit |
changesCursor | Snapshot meta, GET /catalog/checksum | exposed | Change-feed position when the response was built; seeds GET /catalog/changes?cursor=; part of the snapshot ETag |
| Catalog integrity digest | GET /catalog/checksum | exposed | digest covers product rows only; changesCursor moves on pricing too |
emptyReason | List meta, snapshot meta | exposed | noActiveBma, etc. |
Media download#
| Field | Seller API | Status | Notes |
|---|---|---|---|
| Product media binary | GET /products/{productId}/media/download | exposed | ZIP of the product's screenshots, trailers and covers, streamed file by file. Files are named {slug}-{screenshot|trailer|cover}-NN{ext} |
ETag | Media GET and HEAD | exposed | Strong tag computed from the asset list; send it as If-None-Match for 304. HEAD returns it without building the archive. A 304 counts against the catalog rate limit like any other media call |
X-Avrix-Media-Entries | Media GET (200, 304) and HEAD | exposed | How many files the archive is built from, not counting the manifest. Additive |
| Rate-limit headers | Media GET (200, 304) and HEAD | exposed | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, as on every other route. Additive |
avrix-media-manifest.json | Last entry of the archive, contract date 2026-12-01 and later | exposed | { "complete": true | false, "entries": [{ "filename", "included" }] }. A file that cannot be read from storage is left out and the status is already 200, so read complete before trusting the archive. Earlier dates have no manifest |
| Errors | Media GET and HEAD | exposed | On 2026-12-01 and later: the standard error body, 404 PRODUCT_NOT_SHARED for a product that is not shared with you, and the Seller API 401 without a key. Earlier dates: the short { code, message, requestId } body and NOT_FOUND |
Copy media into your own storage and serve it from there; do not link your storefront to the asset
URLs or scrape media URLs from undocumented hosts. Revalidate on a schedule with HEAD and
If-None-Match, and download again only when the ETag changes. A product.updated event does
not say whether media changed. In an isolated sandbox environment generated product media is not
copied (Sandbox), so products there have no media to sync.
Integrator quick reference#
Cold start: GET /catalog/snapshot → persist meta.changesCursor
Deltas: GET /catalog/changes?cursor= (refetch the facets in changedFields; pricing → /products/{id}/pricing)
GET /products?updatedSince=meta.maxUpdatedAt (metadata / lifecycle only — price changes never move updatedAt)
Sellable: GET /allocations → filter sellable:true → syncSellableCatalog()
Store page: GET /products/{id} (rich copy + edition tree)
Checkout: GET /availability + POST /orders/preview (never charge if !canFulfill)
Error mapping#
| Field | Seller API | Status | Guidance |
|---|---|---|---|
errorDetails | — | intentionally omitted | Use the documented error.details object on failed requests. |