Every access token issued to a third-party app is limited to the scopes it requested and the user approved during installation. Scopes follow the pattern module.resource.action — for example, catalogue.items.read grants read access to items.
| Scope | Description |
|---|
catalogue.items.create | Create items |
catalogue.items.read | View items |
catalogue.items.modify | Modify items |
catalogue.items.delete | Delete items |
catalogue.items.export | Export items |
| Scope | Description |
|---|
catalogue.item_attributes.create | Create item attributes |
catalogue.item_attributes.read | View item attributes |
catalogue.item_attributes.modify | Modify item attributes |
catalogue.item_attributes.delete | Delete item attributes |
| Scope | Description |
|---|
catalogue.item_types.create | Create item types |
catalogue.item_types.read | View item types |
catalogue.item_types.modify | Modify item types |
catalogue.item_types.delete | Delete item types |
| Scope | Description |
|---|
catalogue.suppliers.create | Create suppliers |
catalogue.suppliers.read | View suppliers |
catalogue.suppliers.modify | Modify suppliers |
catalogue.suppliers.delete | Delete suppliers |
| Scope | Description |
|---|
customers.customers.create | Create customers |
customers.customers.read | View customers |
customers.customers.modify | Modify customers |
customers.customers.delete | Delete customers |
customers.customers.export | Export customers |
| Scope | Description |
|---|
customers.customer_groups.create | Create customer groups |
customers.customer_groups.read | View customer groups |
customers.customer_groups.modify | Modify customer groups |
customers.customer_groups.delete | Delete customer groups |
| Scope | Description |
|---|
dispatch.packaging.create | Create packaging |
dispatch.packaging.read | View packaging |
dispatch.packaging.modify | Modify packaging |
dispatch.packaging.delete | Delete packaging |
| Scope | Description |
|---|
dispatch.providers.create | Create shipping providers |
dispatch.providers.read | View shipping providers |
dispatch.providers.modify | Modify shipping providers |
dispatch.providers.delete | Delete shipping providers |
| Scope | Description |
|---|
ecommerce.store_scans.modify | Modify store scans |
ecommerce.store_scans.cancel | Cancel store scans |
| Scope | Description |
|---|
ecommerce.mappings.read | View mappings |
ecommerce.mappings.modify | Modify mappings |
| Scope | Description |
|---|
epos.delivery_options.read | View delivery options |
| Scope | Description |
|---|
inventory.locations.create | Create locations |
inventory.locations.read | View locations |
inventory.locations.modify | Modify locations |
inventory.locations.delete | Delete locations |
inventory.locations.export | Export locations |
| Scope | Description |
|---|
inventory.goods_receipts.create | Create goods receipts |
inventory.goods_receipts.read | View goods receipts |
inventory.goods_receipts.modify | Modify goods receipts |
inventory.goods_receipts.mark_paid | Mark goods receipts as paid |
inventory.goods_receipts.cancel | Cancel goods receipts |
inventory.goods_receipts.complete | Complete goods receipts |
| Scope | Description |
|---|
inventory.stock_adjustments.increase | Increase inventory |
inventory.stock_adjustments.move | Move inventory |
inventory.stock_adjustments.decrease | Decrease inventory |
inventory.stock_adjustments.read | View stock adjustments |
| Scope | Description |
|---|
inventory.stock_adjustment_reasons.create | Create stock adjustment reasons |
inventory.stock_adjustment_reasons.modify | Modify stock adjustment reasons |
inventory.stock_adjustment_reasons.read | View stock adjustment reasons |
| Scope | Description |
|---|
inventory.stock_takes.create | Create stock takes |
inventory.stock_takes.read | View stock takes |
inventory.stock_takes.modify | Modify stock takes |
inventory.stock_takes.cancel | Cancel stock takes |
inventory.stock_takes.complete | Complete stock takes |
inventory.stock_takes.complete_force_inventory | Complete stock takes with force inventory enabled |
| Scope | Description |
|---|
inventory.stock_transfers.create | Create stock transfers |
inventory.stock_transfers.read | View stock transfers |
inventory.stock_transfers.modify | Modify stock transfers |
inventory.stock_transfers.cancel | Cancel stock transfers |
inventory.stock_transfers.submit | Submit stock transfers |
| Scope | Description |
|---|
inventory.variances.read | View variances |
inventory.variances.resolve | Resolve variances |
inventory.variances.export | Export variances |
| Scope | Description |
|---|
inventory.picks.create | Create picks |
inventory.picks.read | View picks |
inventory.picks.modify | Modify picks |
inventory.picks.complete | Complete picks |
inventory.picks.cancel | Cancel picks |
| Scope | Description |
|---|
inventory.goods_out_notes.read | View goods out notes |
inventory.goods_out_notes.modify | Modify goods out notes |
inventory.goods_out_notes.print | Print goods out note labels |
inventory.goods_out_notes.dispatch | Dispatch goods out notes |
inventory.goods_out_notes.cancel | Cancel goods out notes |
inventory.goods_out_notes.export | Export goods out notes |
| Scope | Description |
|---|
inventory.warnings.read | View inventory warnings |
| Scope | Description |
|---|
inventory.stock_movements.read | View stock movements |
inventory.stock_movements.create | Create stock movements |
| Scope | Description |
|---|
inventory.records.read | View item inventory |
| Scope | Description |
|---|
inventory.pickable_warnings.read | View Pickable Inventory Warnings |
| Scope | Description |
|---|
inventory.replenishment_orders.create | Create Replenishment Orders |
inventory.replenishment_orders.modify | Modify Replenishment Orders |
inventory.replenishment_orders.complete | Complete Replenishment Orders |
inventory.replenishment_orders.read | View Replenishment Orders |
| Scope | Description |
|---|
manufacturing.manufacturers.create | Create manufacturers |
manufacturing.manufacturers.read | View manufacturers |
manufacturing.manufacturers.modify | Modify manufacturers |
manufacturing.manufacturers.delete | Delete manufacturers |
| Scope | Description |
|---|
manufacturing.manufacturing_runs.create | Create manufacturing runs |
manufacturing.manufacturing_runs.read | View manufacturing runs |
manufacturing.manufacturing_runs.modify | Modify manufacturing runs |
manufacturing.manufacturing_runs.submit | Submit manufacturing runs |
manufacturing.manufacturing_runs.start | Start manufacturing runs |
manufacturing.manufacturing_runs.cancel | Cancel manufacturing runs |
manufacturing.manufacturing_runs.close | Close manufacturing runs |
manufacturing.manufacturing_runs.receive | Receive manufacturing runs |
manufacturing.manufacturing_runs.pick | Pick manufacturing runs |
manufacturing.manufacturing_runs.export | Export manufacturing runs |
| Scope | Description |
|---|
money.tax_classes.create | Create tax classes |
money.tax_classes.read | View tax classes |
money.tax_classes.modify | Modify tax classes |
money.tax_classes.delete | Delete tax classes |
| Scope | Description |
|---|
passport.users.create | Create users |
passport.users.read | View users |
passport.users.modify | Modify users |
passport.users.delete | Delete users |
| Scope | Description |
|---|
passport.roles.create | Create roles |
passport.roles.read | View roles |
passport.roles.modify | Modify roles |
passport.roles.delete | Delete roles |
| Scope | Description |
|---|
passport.apps.read | View apps |
passport.apps.modify | Modify apps |
passport.apps.delete | Delete apps |
| Scope | Description |
|---|
preallocations.preallocations.create | Create preallocations |
preallocations.preallocations.modify | Modify preallocations |
preallocations.preallocations.delete | Delete preallocations |
preallocations.preallocations.read | View preallocations |
| Scope | Description |
|---|
promotions.promotions.create | Create promotions |
promotions.promotions.modify | Modify promotions |
promotions.promotions.delete | Delete promotions |
promotions.promotions.read | View promotions |
| Scope | Description |
|---|
purchasing.orders.create | Create purchase orders |
purchasing.orders.read | View purchase orders |
purchasing.orders.modify | Modify purchase orders |
purchasing.orders.invoice | Invoice purchase orders |
purchasing.orders.close | Close/Cancel purchase orders |
purchasing.orders.approve | Approve purchase orders |
purchasing.orders.export | Export purchase orders |
purchasing.orders.submit | Submit purchase orders |
| Scope | Description |
|---|
purchasing.invoices.create | Create purchase order invoices |
purchasing.invoices.read | View purchase order invoices |
purchasing.invoices.modify | Modify purchase order invoices |
| Scope | Description |
|---|
returns.returns.create | Create stock returns |
returns.returns.read | View stock returns |
returns.returns.modify | Modify stock returns |
returns.returns.complete | Complete/Credit stock returns |
returns.returns.cancel | Cancel stock returns |
returns.returns.notify_email | Send stock return emails |
| Scope | Description |
|---|
returns.credit_notes.create | Create credit notes |
returns.credit_notes.read | View credit notes |
returns.credit_notes.modify | Modify credit notes |
returns.credit_notes.settle | Settle credit notes |
returns.credit_notes.void | Void credit notes |
| Scope | Description |
|---|
sales.orders.create | Create sale orders |
sales.orders.read | View sale orders |
sales.orders.modify | Modify sale orders |
sales.orders.process | Process sale orders |
sales.orders.export | Export sale orders |
sales.orders.representative | Sale order representative |
| Scope | Description |
|---|
sales.channels.create | Create channels |
sales.channels.read | View channels |
sales.channels.modify | Modify channels |
sales.channels.delete | Delete channels |
| Scope | Description |
|---|
sales.listings.create | Create listings |
sales.listings.read | View listings |
sales.listings.modify | Modify listings |
sales.listings.delete | Delete listings |
| Scope | Description |
|---|
sales.invoices.create | Create sale order invoices |
sales.invoices.read | View sale order invoices |
sales.invoices.modify | Modify sale order invoices |
| Scope | Description |
|---|
subscriptions.account.read | View/Modify account info |
