List connections

GET

https://partners.trychannel3.com/v0/partner/merchants/:customer_id/connections

GET

/v0/partner/merchants/:customer_id/connections

$ curl https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "connections": [
3     {
4       "platform": "channel3",
5       "category": "distribution",
6       "status": "not_connected",
7       "display_name": "Channel3 Main Account",
8       "id": null,
9       "connected_at": null,
10       "accounts": null,
11       "sync": null
12     },
13     {
14       "platform": "google",
15       "category": "distribution",
16       "status": "active",
17       "display_name": "Acme Corp Google Store",
18       "id": "conn-1234-google",
19       "connected_at": "2024-01-15T09:30:00Z",
20       "accounts": [
21         {
22           "id": "acct-5678",
23           "name": "Acme Corp Main Account",
24           "store_url": "https://store.google.com/acmecorp"
25         }
26       ],
27       "sync": {
28         "state": "live",
29         "last_synced_at": "2024-04-20T14:45:00Z",
30         "total_products": 150,
31         "synced_products": 150
32       }
33     },
34     {
35       "platform": "shopify",
36       "category": "ingestion",
37       "status": "action_required",
38       "display_name": "Acme Shopify Store",
39       "id": "conn-7890-shopify",
40       "connected_at": "2024-02-10T11:00:00Z",
41       "accounts": null,
42       "sync": null
43     }
44   ]
45 }

This merchant's state across every available platform.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

customer_idstringRequired

Response

Successful Response

connectionslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error