Concepts
This API surface is for integration partners building on top of the Rokt network. Rokt ecommerce partners integrating placements on their own checkout should use the Rokt Ecommerce developer docs instead.
The Partnerships API surface is small, but a handful of concepts shape how every endpoint behaves. Read these once before you wire up your integration — they're the contracts that govern retries, replacement vs patch semantics, async writes, taxonomy translation, and how surfaces map to SDK calls on the merchant's page.
Recommended reading orderRecommended reading order への直接リンク
If you're integrating end-to-end, walk these in order. Earlier concepts are prerequisites for later ones — for example, every write you make in the registration and controls flows expects an idempotency key and may surface an operation id you'll need to poll.
Every write requires Idempotency-Key. Same key, same response — safe to retry. Read first; the rest of the API assumes it.
Writes return X-Operation-Id. Use it to recover the result of a write you lost the response to. Read once you understand idempotency.
Controls endpoints (MCL, status) are PUT-replace, not PATCH. Send the full desired state every time. Read before your first controls update.
Your platform is the manager; the merchants you onboard are managed accounts. Read when you're about to make your first authenticated call.
dry_run=true runs the full validation and returns the would-be response without persisting state. Read when you're about to validate a payload before going live.
Block verticals in your partner taxonomy; Rokt translates server-side. Read when you start building marketplace controls.
How surfaces (confirmation, tracking, returns) map to page_identifiers and how the V1 theme PATCH works. Read before SDK integration.
Network opt-out, network data deletion, and managed-account data deletion. Read when adding privacy request flows.