Skip to main content
GET
Spree SDK

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Headers

x-spree-api-key
string
required
X-Spree-Channel
string

Channel code or prefixed ID to resolve. When the API key is channel-bound, a value naming a different channel is rejected with 422 channel_mismatch; a value matching the bound channel is accepted.

Response

channel found

id
string
required
name
string
required
code
string
required
active
boolean
required
default
boolean
required
storefront_access
string
required
guest_checkout
boolean
required