API reference / Start a SHOPLINE oauth connect

Start a SHOPLINE oauth connect

POST/connections/shopline/oauth/authorize

Return the per-store SHOPLINE consent URL for the resolved organization. Returns 400 if handle is not a valid SHOPLINE store handle. A multi-org credential must send an Organization-Id, Connection-Id or Entity-Id selector, or gets a 400. Call this from a browser with credentials (cookies) included: the callback that finishes the connect is bound to the session cookie this response sets, so it only completes for the same browser.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Body

handlestringRequired

SHOPLINE store handle.

historicalSyncStartDatestring

Import floor chosen before consent, as YYYY-MM-DD. Persisted on a brand-new connection only; ignored on re-auth. null imports all available history.

Response

authUrlstringRequired

SHOPLINE consent URL.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

The request failed validation.