Permissions

Permissions are managed through tokens. There are two authentication methods, client_credentials and implicit. See Client credentials vs Implicit for the difference.

Account management authentication token combined with an implicit access token is used to manage user interfaces that involve restricted account related data. This data may include orders, addresses, and account details.

Customer token combined with an implicit access token is used to manage user interfaces that involve restricted customer related data. This data may 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	⛔️	⛔️
/permissions	⛔️	⛔️
/promotions	⛔️	⛔️
/settings	⛔️	⛔️
/settings/account-authentication	⛔️	⛔️
/settings/customer-authentication	⛔️	⛔️
/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	⛔️	⛔️
/permissions	⛔️	⛔️
/promotions	⛔️	⛔️
/settings	⛔️	⛔️
/settings/account-authentication	⛔️	⛔️
/settings/customer-authentication	⛔️	⛔️
/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	⛔️	⛔️
/permissions	⛔️	⛔️
/promotions	⛔️	⛔️
/settings	⛔️	⛔️
/settings/account-authentication	⛔️	⛔️
/settings/customer-authentication	⛔️	⛔️
/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	✅	✅
/permissions	✅	✅
/promotions	✅	✅
/settings	✅	✅
/settings/account-authentication	✅ ️	⛔
/settings/customer-authentication	✅	⛔
/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	⛔️	⛔️
/orders	⛔️	⛔️
/orders/:id	⛔️	⛔️
/v2/products	⛔️	⛔️
/catalog/products	⛔️	⛔️
/catalog/hierarchies	⛔️	⛔️
/catalog/nodes	⛔️	⛔️
/pcm/products	⛔️	⛔️
/pcm/hierarchies	⛔️	⛔️
/pcm/pricebooks	⛔️	⛔️
/pcm/catalogs	⛔️	⛔️
/permissions	⛔️	⛔️
/promotions	⛔️	⛔️
/settings	⛔️	⛔️
/settings/account-authentication	⛔️	⛔️
/settings/customer-authentication	⛔️	⛔️
/settings/extensions	⛔️	⛔️
/subscriptions	⛔️	⛔️
/user-roles	✅	⛔️
/variations	⛔️	⛔️

Marketing/Sales

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	✅	✅
/permissions	⛔️	⛔️
/promotions	✅	✅
/settings	⛔	⛔
/settings/account-authentication	⛔️	⛔️
/settings/customer-authentication	⛔️	⛔️
/settings/extensions	⛔️	⛔️
/subscriptions	⛔️	⛔️
/user-roles	✅	⛔
/variations	✅	✅

Support

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	⛔️	⛔️
/permissions	⛔️	⛔️
/promotions	⛔️	⛔️
/settings	⛔️	⛔️
/settings/account-authentication	✅️	⛔️
/settings/customer-authentication	✅️	⛔️
/settings/extensions	⛔️	⛔️
/subscriptions	⛔️	⛔️
/user-roles	✅	⛔️
/variations	⛔️	⛔️

IT/Developer

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	⛔️	⛔️
/permissions	✅	✅️
/promotions	⛔️	⛔️
/settings	⛔️	⛔️
/settings/account-authentication	✅️	⛔
/settings/customer-authentication	✅️	⛔
/settings/extensions	✅	✅️
/subscriptions	✅	✅️
/user-roles	✅	✅️
/variations	⛔️	⛔️

Promotions Manager

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	✅	⛔
/permissions	⛔️	⛔️
/promotions	✅	✅
/settings	⛔	⛔
/settings/account-authentication	⛔️	⛔️
/settings/customer-authentication	⛔️	⛔️
/settings/extensions	⛔️	⛔️
/subscriptions	⛔️	⛔️
/user-roles	✅	⛔
/variations	⛔	⛔

eCommerce 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	✅	✅
/permissions	⛔️	⛔️
/promotions	✅	✅
/settings	⛔	⛔
/settings/account-authentication	✅	⛔️
/settings/customer-authentication	✅	⛔️
/settings/extensions	⛔️	⛔️
/subscriptions	⛔️	⛔️
/user-roles	✅	⛔
/variations	✅	✅

Related Resources

• Team Management