Permissions
OAuth app scopes that control read and write access to Admin API resources such as orders, carts, subscriptions, and webhooks
Admin API access is controlled granularly by Scopes that are associated with each OAuth App and associated Access Tokens.
| Scope | Detail |
|---|---|
admin:read | Access to list and view all data |
admin:write | Access to create and update all data |
campaigns:read | Access to list and view campaigns |
campaigns:write | Access to create and update campaigns |
carts:read | Access to list and view carts |
carts:write | Access to create and update carts |
catalogue:read | Access to list and view catalogue objects such as products and categories |
catalogue:write | Access to create and update catalogue related objects |
content:read | Access to list and view storefront content related objects |
content:write | Access to create and update storefront content related objects |
disputes:read | Access to list and view disputes |
disputes:write | Access to create and update disputes |
exports:read | Access to list and view all exports |
exports:write | Access to create and update exports |
fulfillment_service:read | Access to list assigned fulfillment orders and own locations |
fulfillment_service:write | Access to create fulfillment locations and fulfillments |
fulfillment_orders:read | Access to list fulfillment order fulfillment requests |
fulfillment_orders:write | Access to update fulfillment order fulfillment requests |
gateways:read | Access to list and view all gateways and gateway groups |
gift_cards:read | Access to list and view all gift cards |
gift_cards:write | Access to create and update gift cards |
locations:read | Access to list and view all locations |
locations:write | Access to create and update locations |
metadata:read | Access to list and view all metadata definitions |
metadata:write | Access to create and update metadata definitions |
orders:read | Access to list and view all orders |
orders:write | Access to create and update orders |
store:read | Access to list and view store |
subscriptions:read | Access to list and view all subscriptions |
subscriptions:write | Access to create and update subscriptions |
themes:read | Access to list and view all themes |
themes:write | Access to create and update themes |
transactions:read | Access to list and view all transactions |
transactions:write | Access to create and update transactions |
tickets:read | Access to list and view all tickets |
tickets:write | Access to create and update tickets |
users:read | Access to list and view all users |
users:write | Access to create and update users |
webhooks:read | Access to list and view all webhooks |
webhooks:write | Access to create and update webhooks |