Documentation Index
Fetch the complete documentation index at: https://docs.fluveo.com/llms.txt
Use this file to discover all available pages before exploring further.
OAuth scopes control what data and operations an app can access on behalf of a merchant. When a merchant installs your app, they grant a subset of the scopes your app declares. Your app can only access endpoints protected by the granted scopes.
How scopes work
- Developer declares scopes — When registering an app, you list the scopes your app needs in
requested_scopes.
- Merchant grants scopes — During the OAuth flow, the merchant sees the requested scopes and can approve them.
- API enforces scopes — Each API endpoint requires a specific scope. Requests without the required scope receive a
403 error.
Scope naming convention
Scopes follow the pattern {action}_{resource}:
read_ scopes grant read-only access (GET endpoints)write_ scopes grant create, update, and delete access (POST, PATCH, DELETE endpoints)
A write_ scope does not automatically include read_ access. If your app needs to both read and write a resource, request both scopes.
Payments
| Scope | Access |
|---|
read_payments | List and retrieve PaymentIntents |
write_payments | Create, confirm, capture, and cancel PaymentIntents |
Customers
| Scope | Access |
|---|
read_customers | List and retrieve Customers |
write_customers | Create and update Customers |
Refunds
| Scope | Access |
|---|
read_refunds | List and retrieve Refunds |
write_refunds | Create Refunds |
Products
| Scope | Access |
|---|
read_products | List and retrieve Products and Variants |
write_products | Create, update, and delete Products and Variants |
Prices
| Scope | Access |
|---|
read_prices | List and retrieve Prices |
write_prices | Create and update Prices |
Orders
| Scope | Access |
|---|
read_orders | List and retrieve Orders |
write_orders | Create, update, cancel, and complete Orders |
Fulfillments
| Scope | Access |
|---|
read_fulfillments | List and retrieve Fulfillments |
write_fulfillments | Create, ship, deliver, and cancel Fulfillments |
Inventory
| Scope | Access |
|---|
read_inventory | List and retrieve Inventory Levels and adjustments |
write_inventory | Set, adjust, and transfer Inventory Levels |
Collections
| Scope | Access |
|---|
read_collections | List and retrieve Collections |
write_collections | Create, update, delete Collections and manage collection products |
| Scope | Access |
|---|
read_promotions | List and retrieve Promotions |
write_promotions | Create, update, and delete Promotions |
Carts
| Scope | Access |
|---|
read_carts | Retrieve Carts |
write_carts | Create Carts, add/update/remove line items, and complete Carts |
Checkout Sessions
| Scope | Access |
|---|
read_checkout_sessions | List and retrieve Checkout Sessions |
write_checkout_sessions | Create and expire Checkout Sessions |
Checkout Links
| Scope | Access |
|---|
read_checkout_links | List and retrieve Checkout Links |
write_checkout_links | Create and update Checkout Links |
Webhook Endpoints
| Scope | Access |
|---|
read_webhook_endpoints | List and retrieve Webhook Endpoints and deliveries |
write_webhook_endpoints | Create, update, delete, and test Webhook Endpoints; rotate secrets |
Events
| Scope | Access |
|---|
read_events | List and retrieve Events and Event Types |
write_events | Retry Event deliveries |
Balance & Payouts
| Scope | Access |
|---|
read_balance | Retrieve Balance, list Balance Transactions, Transfers, and Settlement batches |
write_payouts | Create and cancel Payouts |
read_payouts | List and retrieve Payouts |
Choosing scopes
Request only the scopes your app actually needs. Apps requesting overly broad scopes are more likely to be rejected during review and less likely to be installed by merchants.
read_products only. Do not request write_products unless you need to modify products.
Next steps
