Skip to main content
GET
/
storefront-connections
List storefront connections
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/storefront-connections \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "storefront": {
        "id": "<string>",
        "platformId": "<string>",
        "name": "<string>",
        "providerType": "<string>",
        "providerDisplayName": "<string>",
        "credentialMode": "<string>",
        "routingMode": "<string>",
        "publisherDomain": "<string>",
        "brandName": "<string>",
        "logoUrl": "<string>",
        "logoBackground": "<string>",
        "description": "<string>",
        "channels": [
          "<string>"
        ],
        "regions": [
          "<string>"
        ],
        "website": "<string>"
      },
      "authModes": [],
      "accountCount": 4503599627370495,
      "featurePolicy": {
        "buyEnabled": true,
        "eventsEnabled": true,
        "feedsEnabled": true,
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "connection": {
        "id": "<string>",
        "storefrontId": "<string>",
        "customerId": 0,
        "kind": "<string>",
        "providerType": "<string>",
        "sourceKind": "<string>",
        "status": "<string>",
        "metadata": {},
        "createdBy": "<string>",
        "connectedBy": "<string>",
        "archivedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "credential": {
        "id": "<string>",
        "connectionId": "<string>",
        "scopes": [
          "<string>"
        ],
        "expiresAt": "2023-11-07T05:31:56Z",
        "lastRefreshedAt": "2023-11-07T05:31:56Z",
        "metadata": {},
        "connectedBy": "<string>",
        "archivedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "selectedAccount": {
        "id": "<string>",
        "connectionId": "<string>",
        "credentialId": "<string>",
        "externalAccountId": "<string>",
        "name": "<string>",
        "isDefault": true,
        "isSelected": true,
        "archivedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

API key or access token

Query Parameters

storefrontId
integer

Optional storefront ID filter

Required range: x <= 9007199254740991

Response

List storefront connections

Storefront connection rows and feature policies visible to a buyer.

items
object[]
required