Shopify Setup - Quick Setup Wizard

Once you have set up a trial subscription and obtained your credentials, you are ready to set up your CSM for Shopify solution. To assist you in the creation of your primary sale channel, CSM for Shopify includes a setup wizard that streamlines the setup process.

• Search for CSM Setup and select the related link
  • From the New section, select Shopify Quick Setup. Start by selecting how you want to create your Sales Channel integration -- there are two options to choose from:
    • Quick Setup - if you have your Shopify store name, you can quickly connect to that store while we do all of the initial setup in the background.
      • "Connect to Shopify" step
        • Store Name or Admin URL - this can be obtained from URL of your Shopify account. For example, if your Shopify administrative URL is “https://admin.shopify.com/store/mystore”, the value to input here is mystore
        • Once the feature is fully functional, you can click Connect to Shopify to login to your Shopify account and link the two systems - for now, click Next
      • "Confirm Shopify Setup Configuration" step
        • You will see a confirmation of your configuration options and can click Next again to apply this setup
      • That's it! The Quick Setup, when fully implemented, takes just seconds. ⚠️However, since this is not fully functional just yet, follow the instructions in the Manually Enter the Access Token step below
    • Custom Setup - this is ideal if you are setting up multiple/additional stores and want to configure each step individually. You will be able to custom define codes/descriptions and toggle which operations are enabled.
      • "Shopify Sales Channel" step
        • Create Sales Channel - Create a new Sales Channel linked to this Shopify API connection.
        • Sales Channel Code - A unique code to identify the Sales Channel.
        • Sales Channel Description - A description of the Sales Channel.
        • Load Automation Data - Enable to load the default Shopify automation records for this Sales Channel. Automations handle order retrieval, listing sync, and other scheduled operations. 
        • Sync Start Date - Automations will only sync data modified after this date. Defaults to today. Set to an earlier date to pull historical data from Shopify.
      • "Shopify API Connection"  step
        • Create API Connection - Configure the Shopify API Set and credentials for this Sales Channel.
        • Use Existing API Set - Select this option to utilize an existing Shopify API Set. You will be presented with an option to select an API Set from a list.
        • API Set Code - The Code that you would like to assign to the Shopify API set.
        • API Set Description - A Description of this Shopify API Set.
      • "Connect to Shopify" step
        • Store Name or Admin URL - this can be obtained from URL of your Shopify account. For example, if your Shopify administrative URL is “https://admin.shopify.com/store/mystore”, the value to input here is mystore
        • Once the feature is fully functional, you can click Connect to Shopify to login to your Shopify account and link the two systems - for now, click Next
      • "API Operation Execution" step
        • Load API Engine Executions - Generates the default application executions for the CSM Application for API Engine.
      • "Confirm Shopify Setup Configuration" step
        • You will see a confirmation of your configuration options and can click Next again to apply this setup
      • That's it! ⚠️Since this is not fully functional just yet, follow the instructions in the Manually Enter the Access Token step below

 

Manually Enter the Access Token

Step 1: Generate the Token

Until this browser-based sign-in process is finished, there are a few steps to complete to acquire and input the Access Token, which will link Shopify and Business Central. Let's start by generating the access token manually.

• First, download the Shopify API Configuration JSON file (right-click and save this file to your local computer/environment)

• Inside of Business Central, search for API Sets and select the related link
  • Under Setup, select Import, then toggle JSON file, click OK and browse to the file you just saved
    • This step will have created a new API Set Code called SHOPFIYACCESSTOKEN which we will use to obtain your Access Token. link to your new Shopify App

• • • Click on the SHOPFIYACCESSTOKEN API Set to select it
      • Select Related > API Credentials and then click on the SHOPFIYACCESSTOKEN API Set Code.
        • Under the OAuth2.0 section:
          • Update Authorization and Token Endpoints
            • Replace the placeholder YourShopName with the store name we just identified in the earlier step
          • Update Scope
            • Paste the following text inside of the Scope field:
              • read_orders,write_orders,read_products,write_products,read_inventory,write_inventory,read_customers,write_customers,read_locations,read_gift_cards,write_gift_cards,write_files,read_merchant_managed_fulfillment_orders,write_merchant_managed_fulfillment_orders
            • Add these for Shopify Plus Stores (B2B):
              • read_companies,write_companies
            • Add this for historical order sync (60+ day access):
              • read_all_orders
          • Update Client ID and Secret
            • Paste in the Client ID and Secret values from the previous step into the fields of the same name

• • • • Click the Authorize button on the ribbon bar

• • • • • This will prompt a browser window to log in to your Shopify store - Note: you must login as the shop owner
        • Click Install to finish the app link between Shopify and BC. This steps generates and saves an encrypted Access Token
        • 

Step 2: Save the Token

We generated the Access Token, but for security reasons, it is encrypted. We need to simulate an API call to access this token so we can copy and paste it into our new API Set.

• Inside of Business Central, search for API Sets and select the related link
  • Click on the SHOPIFYACCESSTOKEN link and then click the button to the right of it with the three horizontal dots to open up the API Functions card
  • Select the Execute option from the ribbon bar; this will simulate an API call and give us the Access Token in the response data.
    • You will see a popup with an error (this is expected); click OK
    • You will then see a prompt that says, "Do you want to open the API Message?" - Click Yes
    • This will load the API Message; scroll down to the Request FastTab and copy in the Access Token value, which should start with "shpua_"
    • 
• Search for API Sets and select the related link
  • Click on the SHOPIFY link
    • Select Related > API Credentials and then click on the SHOPIFY API Set Code.
    • Paste the Access Token you retrieved in the previous step in the API Key Value field
      • 

Test your Connection

• Search for CSM Sales Channels and select the related link
  • Click on the associated Sales Channel you just created
    • From the APIs ribbon, choose the API Engine Test Channel Communication

 

Let's begin our configuration:

➡️ Next Step: Configure your Sales Channel