Skip to main content
A sales channel in Synq represents a distinct selling context — your main e-commerce website, a wholesale B2B portal, a regional marketplace, or any other surface where customers place orders. Every channel carries a name and an ISO currency code, and every order in Synq is stamped with the channel_id of the channel it originated from, giving you clean segmentation for reporting, fulfillment, and pricing logic.

​
Authentication

All Sales Channel endpoints require three headers:
HeaderDescription
AuthorizationBearer <your API token>
X-Tenant-IDYour tenant UUID
X-Org-IDYour organization UUID
Creating a sales channel requires an Admin or Editor role. Listing channels is available to all authenticated roles.

​
List your sales channels

Retrieve all channels configured for your organization and tenant. 
GET /api/v1/channels
Example request 
curl https://api.synq.com/api/v1/channels \
  -H "Authorization: Bearer TOKEN" \
  -H "X-Tenant-ID: a1b2c3d4-0000-0000-0000-000000000001" \
  -H "X-Org-ID: a1b2c3d4-0000-0000-0000-000000000002"
Example response 
{
  "channels": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "Main Storefront",
      "currency": "USD",
      "active": true,
      "created_at": "2024-06-01T10:00:00Z",
      "updated_at": "2024-06-01T10:00:00Z"
    },
    {
      "id": "c9bf9e57-1685-4c89-bafb-ff5af830be8a",
      "name": "B2B Portal",
      "currency": "EUR",
      "active": true,
      "created_at": "2024-07-15T08:30:00Z",
      "updated_at": "2024-07-15T08:30:00Z"
    }
  ]
}
​
channels
array
Array of sales channel objects.
​
id
string
UUID of the sales channel.
​
name
string
Display name for the channel.
​
currency
string
Three-letter ISO 4217 currency code (e.g. USD, EUR, GBP).
​
active
boolean
Whether the channel is currently accepting orders.
​
created_at
string
ISO 8601 timestamp when the channel was created.
​
updated_at
string
ISO 8601 timestamp of the last update.

​
Create a sales channel

Create a new sales channel for your organization. The name field is required; currency defaults to USD if omitted, and active defaults to true. 
POST /api/v1/channels
Content-Type: application/json
Request body
​
name
string
required
A human-readable name for the channel (e.g. "North America Storefront"). Must not be empty.
​
currency
string
A three-letter ISO 4217 currency code. Defaults to USD if not provided.
​
active
boolean
Whether the channel should start in an active state. Defaults to true.
Example request 
curl -X POST https://api.synq.com/api/v1/channels \
  -H "Authorization: Bearer TOKEN" \
  -H "X-Tenant-ID: a1b2c3d4-0000-0000-0000-000000000001" \
  -H "X-Org-ID: a1b2c3d4-0000-0000-0000-000000000002" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "APAC Marketplace",
    "currency": "AUD",
    "active": true
  }'
Example response — 201 Created 
{
  "id": "3d721c8e-4a11-4b0e-9f38-abc123def456",
  "name": "APAC Marketplace",
  "currency": "AUD",
  "active": true,
  "created_at": "2024-09-01T12:00:00Z",
  "updated_at": "2024-09-01T12:00:00Z"
}
​
id
string
UUID of the newly created sales channel. Store this — you will need it as the channel_id when creating orders.

​
Associate orders with a channel

When you create an order through the Synq Orders API, pass the channel_id field to link it to the correct sales channel. The value must be the id returned when you created (or listed) the channel. 
{
  "channel_id": "3d721c8e-4a11-4b0e-9f38-abc123def456",
  "currency": "AUD",
  "items": [...]
}
This association enables per-channel reporting, currency-aware pricing, and channel-scoped fulfillment rules across your Synq workspace.
Use descriptive channel names that reflect the selling surface (e.g. "EU Wholesale", "Amazon US", "DTC Website") — these names appear in Synq dashboards and audit logs.