Permissions
Permissions are managed through tokens. There are two main token types available for use within your project.
Account management authentication token with an Implicit Bearer token is used to manage user interfaces with sensitive data that users may need to access or modify associated with an Account. Sensitive data might include orders, addresses, and account details.
Customer token can be used with an Implicit Bearer token to manage user interfaces that involve sensitive data a user may need to access or modify. Sensitive data might include orders, addresses, and customer details.
Breakdown of Access (for shoppers)
The following tables show a breakdown of the API endpoint actions that are available to the implicit token.
Implicit
Endpoint | Read access | Write access |
---|---|---|
/accounts | ⛔️ | ⛔️ |
/account-members | ⛔️ | ⛔️ |
/account-membership | ⛔️ | ⛔️ |
/application-keys | ⛔️ | ⛔️ |
/authentication-realms | ✅ | ⛔️ |
/brands | ✅ | ⛔️ |
/carts | ✅ | ✅ |
/categories | ✅ | ⛔️ |
/checkout | ✅ | ✅ |
/collections | ✅ | ⛔️ |
/currencies | ✅ | ⛔️ |
/customers | ⛔️ | ⛔️ |
/files | ✅ | ⛔️ |
/flows | ✅ | ⛔️ |
/gateways | ⛔️ | ⛔️ |
/integrations | ⛔️ | ⛔️ |
/inventories | ✅ | ⛔️ |
/jobs | ⛔️ | ⛔️ |
/pcm/jobs | ⛔️ | ⛔️ |
/merchant-realm-mappings | ⛔️ | ⛔️ |
/orders | ⛔️ | ⛔️ |
/orders/:id | ⛔️ | ⛔️ |
/v2/products | ✅ | ⛔️ |
/catalog/products | ✅ | ⛔️ |
/catalog/hierarchies | ✅ | ⛔️ |
/catalog/nodes | ✅ | ⛔️ |
/pcm/products | ⛔️ | ⛔️ |
/pcm/hierarchies | ⛔️ | ⛔️ |
/pcm/pricebooks | ⛔️ | ⛔️ |
/pcm/catalogs | ⛔️ | ⛔️ |
/promotions | ⛔️ | ⛔️ |
/settings | ⛔️ | ⛔️ |
/settings/account-authentication-settings | ⛔️ | ⛔️ |
/settings/customer-authentication-settings | ⛔️ | ⛔️ |
/settings/extensions | ⛔️ | ⛔️ |
/variations | ⛔️ | ⛔️ |
Implicit + Account Management Authentication Token
Endpoint | Read access | Write access |
---|---|---|
/accounts | ✅️ | ⛔️ |
/account-members | ✅️ | ⛔️ |
/account-membership | ✅ | ⛔️ |
/application-keys | ⛔️ | ⛔️ |
/authentication-realms | ✅ | ⛔️ |
/brands | ✅ | ⛔️ |
/carts | ✅ | ✅ |
/categories | ✅ | ⛔️ |
/checkout | ✅ | ✅ |
/collections | ✅ | ⛔️ |
/currencies | ✅ | ⛔️ |
/customers | ⛔ | ⛔ |
/files | ✅ | ⛔️ |
/flows | ✅ | ⛔️ |
/gateways | ⛔️ | ⛔️ |
/integrations | ⛔️ | ⛔️ |
/inventories | ✅ | ⛔️ |
/jobs | ⛔️ | ⛔️ |
/pcm/jobs | ⛔️ | ⛔️ |
/merchant-realm-mappings | ⛔️ | ⛔️ |
/orders | ✅ | ⛔️ |
/orders/:id | ✅ | ⛔️ |
/v2/products | ✅ | ⛔️ |
/catalog/products | ✅ | ⛔️ |
/catalog/hierarchies | ✅ | ⛔️ |
/catalog/nodes | ✅ | ⛔️ |
/pcm/products | ⛔️ | ⛔️ |
/pcm/hierarchies | ⛔️ | ⛔️ |
/pcm/pricebooks | ⛔️ | ⛔️ |
/pcm/catalogs | ⛔️ | ⛔️ |
/promotions | ⛔️ | ⛔️ |
/settings | ⛔️ | ⛔️ |
/settings/account-authentication-settings | ⛔️ | ⛔️ |
/settings/customer-authentication-settings | ⛔️ | ⛔️ |
/settings/extensions | ⛔️ | ⛔️ |
/variations | ⛔️ | ⛔️ |
Note that you can only fetch data with live status.
Implicit + Customer Token
Endpoint | Read access | Write access |
---|---|---|
/accounts | ⛔️ | ⛔️ |
/account-members | ⛔️ | ⛔️ |
/account-membership | ⛔️ | ⛔️ |
/application-keys | ⛔️ | ⛔️ |
/authentication-realms | ✅ | ⛔️ |
/brands | ✅ | ⛔️ |
/carts | ✅ | ✅ |
/categories | ✅ | ⛔️ |
/checkout | ✅ | ✅ |
/collections | ✅ | ⛔️ |
/currencies | ✅ | ⛔️ |
/customers | ✅ | ✅ |
/files | ✅ | ⛔️ |
/flows | ✅ | ⛔️ |
/gateways | ⛔️ | ⛔️ |
/integrations | ⛔️ | ⛔️ |
/inventories | ✅ | ⛔️ |
/jobs | ⛔️ | ⛔️ |
/pcm/jobs | ⛔️ | ⛔️ |
/merchant-realm-mappings | ⛔️ | ⛔️ |
/orders | ✅ | ⛔️ |
/orders/:id | ✅ | ⛔️ |
/v2/products | ✅ | ⛔️ |
/catalog/products | ✅ | ⛔️ |
/catalog/hierarchies | ✅ | ⛔️ |
/catalog/nodes | ✅ | ⛔️ |
/pcm/products | ⛔️ | ⛔️ |
/pcm/hierarchies | ⛔️ | ⛔️ |
/pcm/pricebooks | ⛔️ | ⛔️ |
/pcm/catalogs | ⛔️ | ⛔️ |
/promotions | ⛔️ | ⛔️ |
/settings | ⛔️ | ⛔️ |
/settings/account-authentication-settings | ⛔️ | ⛔️ |
/settings/customer-authentication-settings | ⛔️ | ⛔️ |
/settings/extensions | ⛔️ | ⛔️ |
/variations | ⛔️ | ⛔️ |
Breakdown of Access (for sellers)
The following tables show a breakdown of the API endpoint actions that are available to the client credentials token for each role. Refer to the Team Management page for a comparison of different roles.
Seller admin
Endpoint | Read access | Write access |
---|---|---|
/accounts | ✅ | ✅ |
/account-members | ✅ | ✅ |
/account-membership | ✅ | ✅ |
/application-keys | ✅ | ✅ |
/authentication-realms | ✅ | ✅ |
/brands | ✅ | ✅ |
/carts | ✅ | ✅ |
/categories | ✅ | ✅ |
/checkout | ✅ | ✅ |
/collections | ✅ | ✅ |
/currencies | ✅ | ✅ |
/customers | ✅ | ✅ |
/files | ✅ | ✅ |
/flows | ✅ | ✅ |
/gateways | ✅ | ✅ |
/integrations | ✅ | ✅ |
/inventories | ✅ | ✅ |
/jobs | ✅ | ✅ |
/pcm/jobs | ✅ | ✅ |
/personal-data/logs | ✅ | ✅ |
/personal-data/personal-data-entries | ✅ | ✅ |
/merchant-realm-mappings | ✅ | ✅ |
/orders | ✅ | ✅ |
/orders/:id | ✅ | ✅ |
/v2/products | ✅ | ✅ |
/catalog/products | ✅ | ✅ |
/catalog/hierarchies | ✅ | ✅ |
/catalog/nodes | ✅ | ✅ |
/pcm/products | ✅ | ✅ |
/pcm/hierarchies | ✅ | ✅ |
/pcm/pricebooks | ✅ | ✅ |
/pcm/catalogs | ✅ | ✅ |
/promotions | ✅ | ✅ |
/settings | ✅ | ✅ |
/settings/account-authentication-settings | ✅ ️ | ⛔ |
/settings/customer-authentication-settings | ✅ | ⛔ |
/settings/extensions | ✅ | ✅ |
/subscriptions | ✅ | ✅ |
/user-roles | ✅ | ✅ |
/variations | ✅ | ✅ |
Basic user
Endpoint | Read access | Write access |
---|---|---|
/accounts | ✅️ | ✅️ |
/account-members | ⛔️ | ⛔️ |
/account-membership | ⛔️ | ⛔️ |
/application-keys | ⛔️ | ⛔️ |
/authentication-realms | ⛔️ | ⛔️ |
/brands | ⛔️ | ⛔️ |
/carts | ⛔️ | ⛔️ |
/categories | ⛔️ | ⛔️ |
/checkout | ⛔️ | ⛔️ |
/collections | ⛔️ | ⛔️ |
/currencies | ✅️ | ⛔️ |
/customers | ✅️ | ✅️ |
/files | ⛔️ | ⛔️ |
/flows | ✅️ | ⛔️ |
/gateways | ⛔️ | ⛔️ |
/integrations | ⛔️ | ⛔️ |
/inventories | ✅ | ⛔️ |
/jobs | ⛔️ | ⛔️ |
/pcm/jobs | ⛔️ | ⛔️ |
/personal-data/logs | ⛔️ | ⛔️ |
/personal-data/personal-data-entries | ⛔️ | ⛔️ |
/merchant-realm-mappings | ⛔️ |