Permissions
Your store’s plan determines which API features you can use and how many requests you can send. Some features are available in plans with higher limits because using them may require more requests. Below you’ll find the permissions available in each plan.
Permissions by plan
BASIC
Available permissions (12)
orders.digital_delivery:deleteorders.digital_delivery:readorders.digital_delivery:revealorders.order:change_statusorders.order:readorders.order_file:read_customer_documentorders.order_file:read_digitalorders.order_file:read_internalpayments.payment:adjust_statuspayments.request_refund:adjust_amountreturns.request:readreturns.request:update
STANDARD
- Orders
- Returns, complaints and exchanges
- Products
- Categories
- CMS pages
- Variants and options
- Features and values
- Brands
- Search analytics and rules
- Inventory
- Deliveries
- Warehouses and locations
- Discounts / Promotions
Available permissions (70)
catalog.brand:createcatalog.brand:deletecatalog.brand:readcatalog.brand:updatecatalog.category:createcatalog.category:deletecatalog.category:readcatalog.category:updatecatalog.feature:createcatalog.feature:deletecatalog.feature:readcatalog.feature:updatecatalog.product:createcatalog.product:deletecatalog.product:readcatalog.product:updatecatalog.product_file:read_customer_documentcatalog.product_file:read_digitalcatalog.product_file:read_internalcatalog.product_file:write_customer_documentcatalog.product_file:write_digitalcatalog.product_file:write_internalcatalog.product_variant:createcatalog.product_variant:deletecatalog.product_variant:updatecatalog.variant_option:createcatalog.variant_option:deletecatalog.variant_option:readcatalog.variant_option:updatecontent.page:createcontent.page:deletecontent.page:readcontent.page:updatediscounts.coupons:change_statusdiscounts.coupons:creatediscounts.coupons:readdiscounts.coupons:updatediscounts.promotions:change_statusdiscounts.promotions:creatediscounts.promotions:readdiscounts.promotions:updateinventory.digital_pool:manageinventory.digital_unit:deleteinventory.digital_unit:readinventory.digital_unit:revealinventory.digital_unit:writeinventory.stock:readinventory.stock:updateinventory.stock:update_manual_reservationinventory.stock:update_sales_limitinventory.stock_delivery:createinventory.stock_delivery:readorders.digital_delivery:deleteorders.digital_delivery:readorders.digital_delivery:revealorders.digital_delivery:writeorders.order:change_statusorders.order:readorders.order_file:read_customer_documentorders.order_file:read_digitalorders.order_file:read_internalpayments.payment:adjust_statuspayments.request_refund:adjust_amountreturns.request:readreturns.request:updatesearch.analytics:readsearch.rule:createsearch.rule:deletesearch.rule:readsearch.rule:update
PROFESSIONAL
- Orders
- Returns, complaints and exchanges
- Products
- Categories
- CMS pages
- Variants and options
- Features and values
- Brands
- Search analytics and rules
- Inventory
- Deliveries
- Warehouses and locations
- Discounts / Promotions
Available permissions (70)
catalog.brand:createcatalog.brand:deletecatalog.brand:readcatalog.brand:updatecatalog.category:createcatalog.category:deletecatalog.category:readcatalog.category:updatecatalog.feature:createcatalog.feature:deletecatalog.feature:readcatalog.feature:updatecatalog.product:createcatalog.product:deletecatalog.product:readcatalog.product:updatecatalog.product_file:read_customer_documentcatalog.product_file:read_digitalcatalog.product_file:read_internalcatalog.product_file:write_customer_documentcatalog.product_file:write_digitalcatalog.product_file:write_internalcatalog.product_variant:createcatalog.product_variant:deletecatalog.product_variant:updatecatalog.variant_option:createcatalog.variant_option:deletecatalog.variant_option:readcatalog.variant_option:updatecontent.page:createcontent.page:deletecontent.page:readcontent.page:updatediscounts.coupons:change_statusdiscounts.coupons:creatediscounts.coupons:readdiscounts.coupons:updatediscounts.promotions:change_statusdiscounts.promotions:creatediscounts.promotions:readdiscounts.promotions:updateinventory.digital_pool:manageinventory.digital_unit:deleteinventory.digital_unit:readinventory.digital_unit:revealinventory.digital_unit:writeinventory.stock:readinventory.stock:updateinventory.stock:update_manual_reservationinventory.stock:update_sales_limitinventory.stock_delivery:createinventory.stock_delivery:readorders.digital_delivery:deleteorders.digital_delivery:readorders.digital_delivery:revealorders.digital_delivery:writeorders.order:change_statusorders.order:readorders.order_file:read_customer_documentorders.order_file:read_digitalorders.order_file:read_internalpayments.payment:adjust_statuspayments.request_refund:adjust_amountreturns.request:readreturns.request:updatesearch.analytics:readsearch.rule:createsearch.rule:deletesearch.rule:readsearch.rule:update
ADVANCED
- Orders
- Returns, complaints and exchanges
- Products
- Categories
- CMS pages
- Variants and options
- Features and values
- Brands
- Search analytics and rules
- Inventory
- Deliveries
- Warehouses and locations
- Discounts / Promotions
Available permissions (70)
catalog.brand:createcatalog.brand:deletecatalog.brand:readcatalog.brand:updatecatalog.category:createcatalog.category:deletecatalog.category:readcatalog.category:updatecatalog.feature:createcatalog.feature:deletecatalog.feature:readcatalog.feature:updatecatalog.product:createcatalog.product:deletecatalog.product:readcatalog.product:updatecatalog.product_file:read_customer_documentcatalog.product_file:read_digitalcatalog.product_file:read_internalcatalog.product_file:write_customer_documentcatalog.product_file:write_digitalcatalog.product_file:write_internalcatalog.product_variant:createcatalog.product_variant:deletecatalog.product_variant:updatecatalog.variant_option:createcatalog.variant_option:deletecatalog.variant_option:readcatalog.variant_option:updatecontent.page:createcontent.page:deletecontent.page:readcontent.page:updatediscounts.coupons:change_statusdiscounts.coupons:creatediscounts.coupons:readdiscounts.coupons:updatediscounts.promotions:change_statusdiscounts.promotions:creatediscounts.promotions:readdiscounts.promotions:updateinventory.digital_pool:manageinventory.digital_unit:deleteinventory.digital_unit:readinventory.digital_unit:revealinventory.digital_unit:writeinventory.stock:readinventory.stock:updateinventory.stock:update_manual_reservationinventory.stock:update_sales_limitinventory.stock_delivery:createinventory.stock_delivery:readorders.digital_delivery:deleteorders.digital_delivery:readorders.digital_delivery:revealorders.digital_delivery:writeorders.order:change_statusorders.order:readorders.order_file:read_customer_documentorders.order_file:read_digitalorders.order_file:read_internalpayments.payment:adjust_statuspayments.request_refund:adjust_amountreturns.request:readreturns.request:updatesearch.analytics:readsearch.rule:createsearch.rule:deletesearch.rule:readsearch.rule:update