Skip to main content
POST
Connect storefront

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

storefrontId
integer
required

Storefront ID

Required range: 0 < x <= 9007199254740991

Body

application/json

Optional body. Omit entirely for the existing untargeted connect/reconnect flow.

connectionId
string

Existing storefront connection to reconnect. When set, the returned handoff targets that connection instead of starting an untargeted reconnect. A hint only: if the human authorizes a different provider account, that grant is kept as its own connection rather than overwriting the named one.

Pattern: ^[1-9]\d*$

Response

Connect storefront

connectionUrl
string
required

First-party browser URL to share with the human buyer — for OAuth providers it goes straight to the provider's consent screen; bearer-only providers land on the Connections view for token entry.

authModes
enum<string>[]
required
Available options:
oauth,
bearer
preferredAuthMode
enum<string>
required
Available options:
oauth,
bearer
storefront
object
required

Adapter storefront metadata (id, platformId, name, providerType, channels, logoUrl, …).

connection
object | null
required

The existing connection summary, or null when none.

{key}
any