Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
secretKey: 'sk_xxx',
})
const integration = await client.integrations.create({
type: 'carrier',
preferences: { api_key: 'sk-secret', account_number: '42' },
})spree api post /integrations -d '{"type":"carrier","preferences":{"api_key":"sk-secret","account_number":"42"}}'{
"id": "int_UkLWZg9DAJ",
"name": "Carrier",
"active": false,
"created_at": "2026-01-15T12:00:00.000Z",
"updated_at": "2026-01-15T12:00:00.000Z",
"type": "carrier",
"group": "shipping",
"preferences": {
"api_key": "•••••cret",
"account_number": null
}
}Connects an integration type to the current store. Setting active: true verifies the connection and fails with 422 when it cannot connect. Submitting a masked secret value back keeps the stored secret.
Required scope: write_integrations (for API-key authentication).
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
secretKey: 'sk_xxx',
})
const integration = await client.integrations.create({
type: 'carrier',
preferences: { api_key: 'sk-secret', account_number: '42' },
})spree api post /integrations -d '{"type":"carrier","preferences":{"api_key":"sk-secret","account_number":"42"}}'{
"id": "int_UkLWZg9DAJ",
"name": "Carrier",
"active": false,
"created_at": "2026-01-15T12:00:00.000Z",
"updated_at": "2026-01-15T12:00:00.000Z",
"type": "carrier",
"group": "shipping",
"preferences": {
"api_key": "•••••cret",
"account_number": null
}
}Secret API key for admin access
JWT token for admin user authentication
integration connected
Was this page helpful?