Skip to main content
Sales channels in Synq represent the distinct storefronts, marketplaces, or point-of-sale locations through which you sell your products. Associating orders and products with channels lets you report on performance per sales surface and apply channel-specific pricing or catalog rules. You can list your existing channels or create new ones through this API.
All requests require three headers: Authorization: Bearer YOUR_TOKEN, X-Tenant-ID: YOUR_TENANT_ID, and X-Org-ID: YOUR_ORG_ID. Creating a channel requires the Admin or Editor role.

​
List sales channels

Retrieve all sales channels for your tenant and organization. GET /api/v1/channels

​
Headers

​
Authorization
string
required
Bearer token from your authentication provider.
​
X-Tenant-ID
string
required
UUID of your tenant.
​
X-Org-ID
string
required
UUID of your organization.

​
Response

​
channels
array
Array of sales channel objects.
curl https://api.synq.app/api/v1/channels \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "X-Org-ID: YOUR_ORG_ID"

​
Create a sales channel

Create a new sales channel. You must have the Admin or Editor role to call this endpoint. POST /api/v1/channels

​
Headers

​
Authorization
string
required
Bearer token from your authentication provider.
​
X-Tenant-ID
string
required
UUID of your tenant.
​
X-Org-ID
string
required
UUID of your organization.

​
Body

​
name
string
required
Display name of the channel, e.g. European Storefront.
​
currency
string
required
ISO 4217 three-letter currency code, e.g. USD, EUR, or GBP. Defaults to USD if omitted. Must be exactly 3 characters.
​
active
boolean
Whether the channel should be active at creation. Defaults to true.

​
Response

Returns 201 Created with the new channel object.
​
id
string
UUID of the created channel.
​
name
string
Display name.
​
currency
string
ISO 4217 currency code.
​
active
boolean
Active state.
​
created_at
string
ISO 8601 creation timestamp.
​
updated_at
string
ISO 8601 last-updated timestamp.
curl -X POST https://api.synq.app/api/v1/channels \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "X-Org-ID: YOUR_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "European Storefront",
    "currency": "EUR",
    "active": true
  }'
Only users with the Admin or Editor role can create channels. A 403 Forbidden response is returned for all other roles.