Developer Documentation & API Access

Programmatic access to the rScan platform.

rScan is built on its own versioned REST API — the same interface the first-party web and mobile clients use, covering catalog, listing lifecycle, pricing, orders, fulfillment and warehouse operations. Partner and enterprise integrations get the same contract.

Interface Conventions

Stable, versioned, and the same one we ship against.

Property Value Notes
Base URL https://rscan.com TLS only. Plain HTTP is not served.
Versioning Date-pinned A new version is additive; an existing pin is never broken in place.
Authentication Bearer tokens, per account Every call is validated against live account and store membership, not the token alone.
Payloads application/json Standard REST verbs with CORS and preflight support for cross-origin clients.
Long operations Streaming progress Multi-step operations stream progress events rather than blocking.
Real-time events Authenticated event channel Live catalog, listing and order state pushed to connected clients.
Inbound webhooks Marketplace & compliance eBay and Shopify notification and compliance endpoints, verified against each provider's challenge protocol.

API Domains

What the surface covers.

Endpoints are grouped by the object they act on. Each domain enforces the same store-scoped authorization and the same mutation guards the first-party application is subject to.

CatalogProducts & templates

Identifier lookup, catalog record creation and revision, attribute and taxonomy assignment, image registration and template reuse across the 88,775-product library.

CommerceListings & pricing

Marketplace post creation, revision and end across five channels, scheduled listings, price records, promotions and quantity reconciliation.

OperationsOrders & warehouse

Order retrieval and fulfillment, shipping label purchase and tracking, returns processing, shelf assignment, pick routing and the structured operator event stream.

Access

How to get credentials.

API access is provisioned per store account rather than self-service, because every credential carries the authority to change live marketplace listings and move real inventory. Tell us the integration you have in mind and we will scope the grant to it.