For partners with Shopify order management systems, Beam has built a transaction verification system that leverages a Shopify Custom App to ensure that all transactions captured by the Beam system are accurate and complete. This is a necessary component to ensure that our partners on the Shopify platform have the most precise reports and invoices possible.

This custom app requires the read_orders and write_orders API permission in Shopify.

In most cases, the Beam team will create and set up this Shopify Custom App on behalf of our brands.

Installing the Beam Shopify Custom App

Follow the steps below to create the Shopify Custom App that the Beam system will use to verify Shopify orders and nonprofit selections.

  1. Log in to your Shopify store’s admin panel

  2. Click into Settings → App and Sales Channels → Develop Apps

    Screenshot 2023-06-12 at 5.20.21 PM.png

    <aside> 💡 Click “Allow Custom App Development” if it hasn’t been enabled yet

    </aside>

  3. Click “Create an app”

    Screenshot 2023-06-12 at 5.20.34 PM.png

  4. In the dialog box that pops up, name the app Beam Backend Integration and click “Create app”

    Screenshot 2023-06-12 at 5.24.17 PM.png

  5. Click “Configure Admin API Scopes” and check all permissions listed here, and then click “Save”

    1. read_orders

    2. write_orders

      Screenshot 2023-06-12 at 5.26.28 PM.png

      Screenshot 2023-08-15 at 2.59.05 PM.png

  6. Under “API Credentials”, click “Install App”

    Screenshot 2023-06-12 at 5.27.09 PM.png

  7. Under “Admin API Token”, click “Reveal token once” and get the Admin Access API token. As this will only be shown once, make sure to copy this value somewhere on your computer so it can be accessed later and be sent to the Beam team. Under “API key and secret key”, copy the API Token and API Secret Key values as well.

    Screenshot 2023-06-12 at 5.27.49 PM.png

  8. Please send the Admin API Access Token, API key and Secret key to the Beam team to finish the setup process for your Shopify Custom App.

Adding the write_orders permission for existing apps

If your site already has a Beam Shopify Custom App installed, you may simply need to add the write_orders permission.

  1. To add this permission, start by opening the “Develop Custom Apps” settings in the Shopify administration dashboard.

    Screenshot 2023-08-01 at 9.36.18 AM.png