Create a channel

import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) // `code` is optional — when omitted it's derived from `name` // ("Point of Sale" → "point-of-sale"). const channel = await client.channels.create({ name: 'Point of Sale', code: 'pos', active: true, })

{ "id": "ch_EfhxLZ9ck8", "name": "Marketplace", "code": "marketplace", "active": true, "default": false, "storefront_access": null, "guest_checkout": null, "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z", "order_routing_strategy": null, "stock_location_ids": [], "default_catalog_id": null }

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Body

application/json

name

string

required

Example:

"Point of Sale"

code

string

URL-safe slug, derived from name when blank (Point of Sale becomes point-of-sale).

Example:

"pos"

active

boolean

default

boolean

order_routing_strategy

string | null

Order routing strategy shorthand (built-in: rules). Null inherits the store setting.

storefront_access

enum<string> | null

What anonymous visitors can see. Null inherits the store setting.

Available options:

public,

prices_hidden,

login_required

guest_checkout

boolean | null

Whether guests can check out without an account. Null inherits the store setting.

default_catalog_id

string | null

Catalog (cat_...) shown to shoppers no company or customer group catalog covers. Null means every product published on the channel.

stock_location_ids

string[]

Stock locations (sloc_...) that fulfill this channel. Replaces the whole set; an empty list means every location of the store.

Response

201 - application/json

channel created

API basics

Endpoints

Authorizations

Headers

Body

Response