Skip to main content
POST
/
storefronts
/
{storefrontId}
/
connection
Connect storefront
curl --request POST \
  --url https://api.interchange.io/api/v2/buyer/storefronts/{storefrontId}/connection \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.interchange.io/api/v2/buyer/storefronts/{storefrontId}/connection"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.interchange.io/api/v2/buyer/storefronts/{storefrontId}/connection', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "connectionUrl": "<string>",
  "authModes": [],
  "storefront": {},
  "connection": {}
}
{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}
{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}
{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
storefrontId
integer
required

Storefront ID

Required range: 1 <= x <= 9007199254740991

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