Installation guide
This guide explains how to install Auditor on your BigCommerce store, authorize the application, and confirm that the connection is ready.
Before installation
Auditor is installed and connected to a BigCommerce store through the BigCommerce application installation process.
Auditor requires an active BigCommerce store to connect and receive supported store activity.
Use a BigCommerce account that has permission to install and authorize applications for the store.
During installation, BigCommerce displays the access requested by Auditor. Review and approve the requested access to continue.
Note: Auditor begins receiving supported activity after the application is connected. Activity that occurred before the relevant data became available to Auditor may not be available.
Installation
After installing Auditor from BigCommerce, complete the initial setup by creating and saving the required BigCommerce API token.
Open the Auditor app listing in BigCommerce and complete the standard application installation and authorization process.
After installation, Auditor opens the setup page. Follow the provided instructions to create a Store API account in BigCommerce and copy the generated access token.
Paste the generated BigCommerce access token into the Provide API Token field and save it.
Auditor stores and verifies the token so it can connect to the BigCommerce store and process supported store activity.
After the setup is complete, click Open Dashboard. Auditor redirects you to the Dashboard, where you can begin reviewing recorded activity.
Application access
Auditor requests the BigCommerce access required to connect the store, receive supported webhook activity, and retrieve information used by the application.
Important: Always review the BigCommerce authorization screen during installation. The permissions displayed by BigCommerce are the permissions applicable to the version of Auditor you are installing.
After installation
Auditor displays a setup page after installation. Complete the API token setup before opening the Dashboard.
Follow the BigCommerce API account instructions shown on the setup page.
Paste the generated access token into Auditor and save it.
Once setup is complete, click Dashboard to continue into the application.
Staff activity
Staff Log scraping is separate from the initial BigCommerce application installation. When staff activity needs to be retrieved, open the Staff Log page and provide the required BigCommerce account details to start the scraping process.
BigCommerce may require OTP verification while the Staff Action Log is being accessed.
Uninstalling
Auditor can be removed using the BigCommerce application management controls for your store.
When Auditor is uninstalled, the application can no longer receive new activity from the connected store through that installation.
Auditor currently provides up to 90 days of activity retention under the free plan. Refer to the User Manual for the current retention information.
Continue with the User Guide for a quick introduction to the Dashboard, Staff Log, scraping status, and Settings.