Quickstart
Integrate in four server-side steps: provision a merchant, mint a connect session, redirect them to your co-branded hosted page, then read connection state when they return.
Create a merchant
When a customer signs up or links a store, call Create merchant with their domain. Store the returned customer_id. The endpoint is idempotent on domain.
Create a connect session
When they click Connect, call Create connect session with a required redirect_uri (must prefix-match a URI on your registered allowlist). You get a single-use hosted page URL that expires after 30 minutes — mint a fresh session for every connect attempt. Pass an optional platform to deep-link into one platform, or omit it to show a platform picker.
Redirect the merchant
Send them to the co-branded hosted page (your logo, colors, and name). Channel3 handles OAuth, credentials, app installs, and multi-step flows. For ERP systems (Oracle NetSuite, SAP S/4HANA, Dynamics 365, Infor CloudSuite, Sage X3), the hosted page explains that a custom connection is required and links merchants to support.
Handle the callback
After the merchant finishes, they return to your redirect_uri. Call List connections from your server to read connection and sync state — do not rely on callback query parameters alone.
Newly provisioned merchants already have an active web_crawl connection: Channel3 starts crawling the storefront with no merchant action.
See API Overview for authentication, base URL, schemas, and the API Explorer.