Channels
A Channel is a sales or distribution surface you publish products to - your online store, a marketplace like Amazon, a retail point of sale, or a wholesale catalog. Assigning a Product to a channel makes it available there, and the channel is one of the dimensions used to resolve prices: pass resolveContext[channel] on a read to get the price a buyer would see on that channel.
Each channel has a translatable name and a status, so you can stage a channel as draft before opening it.
The Channel object
Section titled “The Channel object”| Property | Type | Required | Description |
|---|---|---|---|
id | string | - | The resource's unique identifier (UUID). |
status | string | - | The status of the channel. |
name | string | null | - | This property supports translations. The display name of the channel. |
products | string[] | - | A list of Product IRIs published to the channel. |
createdAt | string | - | The date and time when the resource was created (ISO 8601 format). |
updatedAt | string | - | The date and time when the resource was last modified (ISO 8601 format). |
Common workflows
Section titled “Common workflows”- Open a new sales surface. Create a
draftchannel, assign products to it, and flip it toactivewithPATCHwhen it goes live. - Resolve channel-specific prices. Pass
resolveContext[channel](withresolveContext[country]andresolveContext[at]) when reading Variants so each variant’sresolvedPricereflects what a buyer on that channel would pay. - Curate per-channel assortments. Manage which products appear on a channel through its
productslist.
Conventions
Section titled “Conventions”Authentication and headers
Section titled “Authentication and headers”All requests require an OAuth 2.0 bearer token and the organization scope header:
Authorization: Bearer <token>X-Flowkiwi-Organization-Id: <organization-id>For the translatable name, set the active locale (and optionally a fallback):
X-Flowkiwi-Locale: fr-FRX-Flowkiwi-Locale-Fallback: en-USPartial updates
Section titled “Partial updates”PATCH uses JSON Merge Patch with Content-Type: application/merge-patch+json.