Connect a sales channel

PUT /channels/{channelId}

Connect a sales channel, or say what a connected one is now — the call the app providing the channel makes when a store is connected and whenever its name, its catalogs, its order link, its settings page (settingsPath, a path in the admin) or the currency it sells in (currency, ISO 4217) change.

The app mints channelId (chn_…) and sends the whole description: type and externalId say which place it is and are fixed once connected; catalogs lists the catalogs it publishes, each at one of the channel's own targets. Appends inventory.channel-connected for a new or disconnected channel and inventory.channel-updated naming only what changed for a connected one. 409 ChannelConflict when another connected channel already is this type and externalId, or when the body would change what an existing channel is; 404 CatalogNotFound for a catalog the organization does not have. Only an app's own token connects a channel, and the channel records that app as its appId (from the token, never the body; fixed once connected): 403 ChannelNotYours for a person's token, for a channel another app provides, or for a type that is not the app's — one of Manifold's apps connects only the type its catalogue entry declares, and no other app connects that type. Idempotent by content: a retry that changes nothing is acknowledged and appends nothing.

Access

Requires integrations:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: a retry that changes nothing is acknowledged and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

inventory.channel-connected
inventory.channel-updated

What a fact is: Facts and the journal.

AI agent tool

No agent tool. Called by the app that provides the channel whenever the channel connects or what it publishes changes; an agent connects a store by installing the app and maps its catalogs with the app's own connection tool.

Connecting an agent: AI agents.

Example

The web store's app connects its store, publishing the Default catalog.

curl

curl -X PUT 'https://inventory.getmanifold.io/channels/chn_019ce0d8-5d50-7597-8115-9ea4c1b646da' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "webstore",
  "externalId": "tidewater-supply.example",
  "name": "Tidewater online store",
  "catalogs": [
    {
      "catalogId": "cat_019cadd3-8524-7934-9ee3-29b896f71f80",
      "externalId": "online-store",
      "externalName": "Online Store"
    }
  ],
  "orderUrl": "https://tidewater-supply.example/admin/orders/{externalId}",
  "settingsPath": "/settings/channels/webstore",
  "currency": "AUD"
}'

JavaScript (fetch)

const response = await fetch("https://inventory.getmanifold.io/channels/chn_019ce0d8-5d50-7597-8115-9ea4c1b646da", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "type": "webstore",
    "externalId": "tidewater-supply.example",
    "name": "Tidewater online store",
    "catalogs": [
      {
        "catalogId": "cat_019cadd3-8524-7934-9ee3-29b896f71f80",
        "externalId": "online-store",
        "externalName": "Online Store"
      }
    ],
    "orderUrl": "https://tidewater-supply.example/admin/orders/{externalId}",
    "settingsPath": "/settings/channels/webstore",
    "currency": "AUD"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "type": "webstore",
  "externalId": "tidewater-supply.example",
  "name": "Tidewater online store",
  "catalogs": [
    {
      "catalogId": "cat_019cadd3-8524-7934-9ee3-29b896f71f80",
      "externalId": "online-store",
      "externalName": "Online Store"
    }
  ],
  "orderUrl": "https://tidewater-supply.example/admin/orders/{externalId}",
  "settingsPath": "/settings/channels/webstore",
  "currency": "AUD"
}

Response · 200 · application/json

{
  "id": "chn_019ce0d8-5d50-7597-8115-9ea4c1b646da",
  "appId": "app_019b8b74-1800-79fd-be5b-3df405745c4d",
  "type": "webstore",
  "externalId": "tidewater-supply.example",
  "name": "Tidewater online store",
  "status": "connected",
  "catalogs": [
    {
      "catalogId": "cat_019cadd3-8524-7934-9ee3-29b896f71f80",
      "externalId": "online-store",
      "externalName": "Online Store"
    }
  ],
  "orderUrl": "https://tidewater-supply.example/admin/orders/{externalId}",
  "settingsPath": "/settings/channels/webstore",
  "currency": "AUD",
  "connectedAt": "2026-03-12T07:00:02.000Z",
  "createdAt": "2026-03-12T07:00:02.000Z",
  "updatedAt": "2026-03-12T07:00:02.000Z"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: inventory-manager.openapi.json. Base URL https://inventory.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`ChannelNotYours` channelId, reason	This channel belongs to another app.	Call it with the app that provides the channel.
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`404`

Refusal	What it means	What to do
`CatalogNotFound` catalogId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`ChannelConflict` channelId, reason	Another channel is already this store, or the change would make the channel another one.	Update the existing channel instead.
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.