Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sellfern.com/llms.txt

Use this file to discover all available pages before exploring further.

Each Sellfern API token is granted specific scopes that control which endpoints it can call. Scoping tokens narrowly limits the blast radius if a token is ever leaked — a read-only analytics token cannot modify orders even if compromised.

Scope reference

ScopeDescription
orders:readRead orders, order details, notes, and tracking information.
orders:writeCreate or update orders and append order notes.
orders:status:writeUpdate order status (single or bulk).
analytics:readRead analytics summaries and per-store reports.
fulfillment:readRead the fulfillment queue and fulfillment status.
fulfillment:writeAssign suppliers and update fulfillment records.
webhooks:manageCreate, list, update, test, and delete webhook endpoints.

Choosing scopes for common use cases

Read-only analytics bot Grant analytics:read only. The token can call /api/v2/analytics/summary and /api/v2/analytics/by-store but cannot touch orders or fulfillment. Order status updater Grant orders:read and orders:status:write. The token can list orders and update their status, but cannot create orders, add notes, or access fulfillment. Full automation agent Grant orders:read, orders:write, orders:status:write, analytics:read, fulfillment:read, and fulfillment:write. Use this scope set only for trusted agents that need complete operational access. Webhook setup script Grant webhooks:manage only. The token can register and manage webhook endpoints without any access to order or analytics data.

Checking available scopes via the API

You can retrieve the current list of valid scopes at any time:
GET https://api.sellfern.com/api/v2/scopes
Follow the least-privilege principle: start with the narrowest set of scopes that makes your integration work, and add more only if a specific endpoint returns 403 missing_scope. You can always create a new token with broader scopes when your requirements grow.