This is a demo tax provider built with the BigCommerce node sample app. It is intended to be used for demonstration purposes only. This application applies a 10% tax rate to all tax requests.
It currently only implements the Estimate Taxes endpoint. That endpoint is /api/tax/estimate. The Void, Commit, and Adjust endpoints may or may not be added in the future.
This application sets the same username and password, stored as environment variables, when establishing connections with BigCommerce stores. You may supply any value that you like for these environment variables as long as they do not contain colons. If you intend to use this application for more than one merchant, consider implementing a UI to allow the merchant to configure the username/password.
Recommended reading: https://developer.bigcommerce.com/api-docs/providers/tax
To get the app running locally, clone the repo with git clone https://github.com/hatertron3000/demo-tax-provider then follow these instructions:
-
Install npm packages
npm install
- Add and start ngrok. Note: use port 3000 to match Next's server.
-
npm install ngrok -
ngrok http 3000
-
For steps 5-7, enter callbacks as
'https://{ngrok_id}.ngrok.io/api/{auth||load||uninstall}'. -
Get
ngrok_idfrom the terminal that's runningngrok http 3000. -
e.g. auth callback:
https://12345.ngrok.io/api/auth
- Copy .env-sample to
.env.
-
TAX_PROVIDER_ID must be provided by BigCommerce.
-
You may leave this value blank until BigCommerce has registered your tax provider app, but the application will recieve a 404 response from the Update Connection request until a valid value is supplied.
-
See the BigCommerce documentation for more information.
-
If deploying on Heroku, skip
.envsetup. Instead, enterenvvariables in the Heroku App Dashboard underSettings -> Config Vars.
-
Replace client_id and client_secret in .env (from
View Client IDin the dev portal). -
Update AUTH_CALLBACK in
.envwith thengrok_idfrom step 5. -
Enter a jwt secret in
.env.
- JWT key should be at least 32 random characters (256 bits) for HS256
- Specify DB_TYPE in
.env
-
If using Firebase, enter your firebase config keys. See Firebase quickstart
-
If using MySQL, enter your mysql database config keys (host, database, user/pass and optionally port). Note: if using Heroku with ClearDB, the DB should create the necessary
Config Var, i.e.CLEARDB_DATABASE_URL.
- Start your dev environment in a separate terminal from
ngrok. Ifngrokrestarts, update callbacks in steps 4 and 7 with the new ngrok_id.
npm run dev
Once your app is running locally or on heroku, you may use this Postman collection to test responses from the /api/tax/estimate endpoint.
To simulate a delay in response, pass a string in the format DELAY:TIME_IN_MS where TIME_IN_MS is a number in the customer.taxability_code in the estimate request. See BigCommerce documentation for more information on adding the taxability_code to customer accounts.
As an attempt to debug an issue, the app may query BigCommerce for the checkout corresponding to a tax rate request before responding to the request by passing a string in the format GET_CHECKOUT_BEFORE:HASH where HASH is the unique store hash for the store that generated the estimate request. The app may make the same query after responding to the rate request by passing a string in the format GET_CHECKOUT_AFTER:HASH
As an attempt to debug an issue, the app may query BigCommerce for the cart corresponding to a tax rate request before responding to the request by passing a string in the format GET_CART_BEFORE:HASH where HASH is the unique store hash for the store that generated the estimate request. The app may make the same query after responding to the rate request by passing a string in the format GET_CART_AFTER:HASH
Once BigCommerce has registered your application as a tax provider and you have configured the TAX_PROVIDER_ID environment variable, when you install the app onto a BigCommerce then you will be able to enable it from the Settings > Tax page in the store's control panel.