Reference overview

The reference describes the RUO Pro API as you call it: the routes reachable with a tenant credential, the scopes that gate them, the errors they return, and the per-resource behavior you build against.

Core reference

• Tenant-facing API — the routes reachable with an fdk_-prefixed tenant credential: self-serve store management, the merchant API, checkout, and the public storefront catalog. Described from the live route handlers.
• Scopes — the closed allowlist of tenant-credential scopes: what each grants and which routes require it.
• Error codes — the catalog of error codes the API emits, grouped by resource, each with its HTTP status and how to resolve it.
• Rate limits and quotas — what is throttled, the 429 / 503 behavior, and what is deliberately unthrottled.
• Webhooks — subscribing to platform events and the outbound delivery model.
• Site builder — the store manifest publishing model: draft, publish, rollback, and signed preview.

API resources

Per-resource reference for the capabilities exposed on the API:

• Subscriptions — recurring billing: schedule, renewal, and dunning against a vaulted credential.
• Fraud — velocity signals, blocklist, and the AVS/CVV decisioning checkout runs before money moves.
• Marketing — drip/campaign runner, audience enrollment, abandoned-cart detection, and bounce ingestion.
• Media — the media upload pipeline: presigned upload, pending asset, finalize-to-ready.
• Gift cards — purchasable and redeemable bearer codes.
• Collections & faceted search — the public catalog discovery surfaces (facets and merchandised collections).
• Fulfillment depth — POs/receiving, physical locations, fulfillment nodes/modes, dropship vendor costs, COGS.

API explorer

The machine-generated, always-current contract for the public storefront and merchant fdk_ surface is served directly by the API: browse the interactive reference at https://api.ruo.pro/docs and fetch the raw spec at https://api.ruo.pro/openapi.json.