Documentation IndexFetch the complete documentation index at: /docs/llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Required scope: read_settings (for API-key authentication).
read_settings
JavaScript
import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const channel = await client.channels.get('channel_xxx')
spree api get /channels/{id}
{ "id": "ch_gbHJdmfrXB", "name": "Wholesale", "code": "wholesale", "active": true, "default": false, "storefront_access": "public", "guest_checkout": true, "preferred_order_routing_strategy": null, "preferred_storefront_access": null, "preferred_guest_checkout": null, "created_at": "2026-07-26T14:24:17.164Z", "updated_at": "2026-07-26T14:24:17.164Z" }
Secret API key for admin access
JWT token for admin user authentication
channel found
Was this page helpful?
Contact support