TABLE OF CONTENTS

  1. Admin API Access Token Setup
  2. Webhook Setup



To Complete your integration with Shopify we'll need 2 values generated in your store. The API Key as well as a key to sign Webhooks.



Step 1: Admin API Access Token Setup


To Complete the API Key setup go to your stores dashboard. At the bottom of the menu go to 'Apps >' shown here:

Click directly on apps in this menu:

 


After clicking on 'Apps >' this menu will appear:

Click on 'App and sales channel settings' at the bottom, this screen should appear:


Click on 'Develop apps for your store' Button and this screen will appear. If you haven't used an external app like ours before you may need to 'Allow custom app development':

Then click 'Allow custom app development'

Now you can 'Create app'

Name your app "Shopcaddie TWMS" or something similar to help you remember what it's for:


We now need to configure the permissions for the App so ShipCaddie can access the appropriate data, click on 'Configure Admin API scopes':


We need read and write access to the following scopes:

  • Orders
  • Products
  • Inventory
  • Fulfillment Service


Setup Fulfilment Services Permissions:

Setup Inventory Permissions:

Setup Product Permissions:

Setup Order Permissions:


Once you are done setting the permissions click 'Save' at the top or bottom of the screen, you may need to scroll up or down:


Once you save move to the 'API Credentials Tab' and click the 'Install app' button:

Confirm Installation by pressing 'Install':

Click reveal Admin API access token, note the image below to select the correct token copy it and store it in a secure place:


You have completed the first step, make sure to store your API admin access token securely, we will need it to complete your setup.



Step 2: Webhook Setup


From the admin portal of your Shopify store click 'Apps >' on the side menu:


Its located at the buttom of this menu:


Click 'App and sales channel settings' at the bottom of the dialog that appears:

Click on 'Notifications' on the side menu that pops up:

Scroll to the bottom to find 'Webhooks':

Click 'Create Webhook' and add one with these settings:

  • Event: Order Creation
  • Format: JSON
  • URL: you will need to get the www.{yourtwmsportal}.com portion of the URL from the warehouse if you have not logged in yet.
  • Use the 'Latest' setting for the Webhook API version
  • Click Save

After you created the first create another with these settings:

  • Event: Order cancellation
  • Format: JSON
  • URL: you will need to get the www.{yourtwmsportal}.com portion of the URL from the warehouse if you have not logged in yet.
  • Use the 'Latest' setting for the Webhook API version
  • Click Save

After completing this the Webhooks section should look like this except using the unique website address you have been provided, we also need the signature value for the Webhooks:


You've now completed setting up the second step of your Shopify integration. Please provide both keys to your support specialist / warehouse to complete your setup.