Shopfront Developers
Scopes
This reference lists the scopes that are available to use with Shopfront and map 1:1 to permissions within Shopfront (scopes and permissions share the same name).
You specify what scopes your application requires when authenticating and requesting tokens during the initial authorisation flow, you can request multiple scopes.
Scopes are used to ask for permission to access specific Shopfront resources and will ensure your application can access them even if the Shopfront user who authenticated your application changes permission level or is deleted.
Administration
- manage_push_devices
- manage_takings_adjust_movement
- modify_settings
- modify_sale_keys
- modify_receipts
- modify_statements
- modify_payment_methods
- modify_tax_rates
- modify_transfer_list
- modify_customer_displays
- modify_loyalty
- modify_hardware
- modify_ticket_templates
- modify_integrations
- create_users
- modify_users
- modify_roles_permissions
- modify_page_rules
- see_trashed_items
- see_mail_log
- see_media_centre
- upload_media_content
- delete_media_content
- rename_media_content
- create_media_folder
- delete_media_folder
- rename_media_folder
- manage_vendor_connections
- view_enterprise_connections
- manage_enterprise_connections
- modify_surcharges
- integrate_applications
Classifications
- create_classifications
- edit_classifications
- delete_classifications
Customer Groups
- create_customer_groups
- edit_customer_groups
- delete_customer_groups
- adjust_customer_group_pricing
- adjust_customer_group_loyalty
Customers
- create_customers
- edit_customers
- delete_customers
- adjust_customer_pricing
- adjust_customer_group
- adjust_customer_loyalty
- make_customer_payments
General
- see_manage_takings
- see_history
- see_products
- see_classifications
- see_promotions
- see_shelf_tickets
- see_stock_management
- see_customers
- see_customer_groups
- see_pricelists
- see_balances
- view_revision_history
- see_stocktake
- see_webhooks
- create_webhooks
- edit_webhooks
- delete_webhooks
- manage_gift_cards
- manage_billing
- see_user_menu_graphs
- change_register
- modify_registers_outlets
- modify_barcode_templates
- clear_local_data
Host
- see_host_connections
- modify_host_connections
- see_host_changes
- manage_host_changes
Kitchen
- use_bump_screen
- configure_kitchen_screens
Pricelists
- create_pricelists
- edit_pricelists
- delete_pricelists
Products
- see_cost
- product_modify_inventory
- create_products
- edit_barcodes
- edit_products
- delete_products
- view_product
Promotions
- edit_express_promotions
- edit_advance_promotions
- create_express_promotions
- create_advance_promotions
- delete_promotions
- modify_promotion_categories
Register
- associate_barcode
- discount
- hold_sale
- cancel_held_sale
- refund
- cashout
- open_drawer
- history_cancel_sale
- history_modify_sale
- perform_safe_drop
- sell
- modify_held_sale_note
Reporting
- manage_takings_see_totals
- run_sales_reports
- run_inventory_reports
- view_reporting_dashboard
- view_register_closures
- run_purchase_reports
- run_actions_reports
- edit_user_dashboard
- run_advanced_reports
- run_misc_reports
- see_recent_register_closures
- see_security_events
- modify_report_email_settings
Stock Management
- stock_create_order
- stock_create_transfer
- stock_create_return
- stock_edit_order
- stock_edit_transfer
- stock_edit_return
- stock_delete
- stock_receive
- stock_send
- perform_stocktake
- stock_create_credit
- stock_edit_credit
- stocktake_apply_zero
- stocktake_apply_ignore
- express_stocktake
- see_product_backorders
- add_product_backorder
- update_product_backorder
- review_order
- modify_order_reviewers
- delete_order_attachment
- modify_default_prices
- product_modify_case_quantity
Suppliers
- see_suppliers
- edit_suppliers
- create_suppliers
- delete_suppliers