Skip to main content
POST
Spree Admin SDK

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

Slug — auto-derived from name when blank.

Example:

"pos"

active
boolean
default:true
default
boolean
default:false
preferred_order_routing_strategy
string | null

Routing strategy class name. null inherits the store setting.

preferred_storefront_access
enum<string> | null

Anonymous-visitor access posture. null inherits the store setting.

Available options:
public,
prices_hidden,
login_required
preferred_guest_checkout
boolean | null

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

Response

201 - application/json

channel created