Shopify integration guide
--- Shopify integration features
|Product data||External fulfillment orders|
--- Set up Shopify
In order to connect your Shopify Store with ChannelEngine, you first must ad ChannelEngine as a 'Private App' in the back-end of your Shopify account.
1. First, open 'Manage private apps' in the Shopify backend.
2. In the top right corner select the option 'Create a new private app'.
3. Enter the name and the emergency developer email for the private app. While it's your choice on what to enter, we strongly recommend using the following information:
- Private app name: ChannelEngine
- Emergency developer email: email@example.com
4. Update the permissions for the private app so our systems can get the required access:
- Store Content like Articles, blogs comments, pages and redirects -- Read access
- Customer details and customer groups -- Read and write
- Orders, transactions and fulfillments -- Read and write
- Products, variants and collections -- Read and write
5. Leave the Webhook API version on the latest version. Access to the storefront data is not required for ChannelEngine.
6. You will be prompted if you are sure to create a new private app. Select 'I understand, create the app' to proceed (but take heed of the warning that the API credentials should be kept safe).
7. New API credentials should now be generated and be visible. You will need to enter these credentials (the API key and shop URL) in ChannelEngine in order to make the connection.
--- Set up ChannelEngine
Now it's time to add the integration to your ChannelEngine account and fill in the previously acquired credentials.
1. Navigate to 'Settings' > 'Merchant plugins'.
2. Find the Shopify plugin in the overview and press '+ Add' to add it as a merchant plugin to your account.
3. Press the blue 'OK' button in the popup that will appear to confirm adding this plugin.
4. Now fill in the credentials and settings needed for Shopify to properly work:
- API accesstoken - this is the Password token from the Shopify private app page (so not the API key token).
- API shop URL - this is the base URL of your Shopify store. An example would be 'channelengine.myshopify.com'.
- Shop URL - this is the base domain of your shop if you use a custom domain (for example: shop.channelengine.com instead of channelengine.myshopify.com).
- Color alias in Shopify - this is the name of your color attribute in Shopify. By default this would be 'Color', however, it is possible to change this to a different (localized) value. In order to correctly set the color for products on our end, we need the correct attribute name.
- Size alias in Shopify - this is the name of your size attribute in Shopify. By default this would be 'Size', however, it is possible to change this to a different (localized) value. In order to correctly set the size for products on our end, we need the correct attribute name.
- Material alias in Shopify - this is the name of your material attribute in Shopify. By default this would be 'Material', however, it is possible to change this to a different (localized) value. In order to correctly set the material for products on our end, we need the correct attribute name.
- Pagesize - the maximum number of products that are returned per page. Shopify has a default of 50 items per page, we use a default of 250. It's best to leave this setting alone or at least don't increase it too much.
- Name for shipment costs on order - this is the name of your shipment cost attribute in Shopify. By default this would be 'Shipment costs', however, it is possible to change this to a different (localized) value. In order to correctly set the shipment costs on orders on our end, we need the correct attribute name.
5. If all settings have a checkmark, you can toggle the 'Activate synchronisation for Shopify' slide on the right-hand side. This will attempt to do a test API-call to your Shopify environment, so if this results in an error (and not a green toggle) the API accesstoken or API shop URL will most likely be invalid. Please double-check these settings and try again. If the problem continues, please contact us at firstname.lastname@example.org for assistance.
6. If the plugin is successfully activated, tasks will automatically be scheduled to import products and shipments from Shopify and export orders to Shopify. You can the latest executed tasks and their next schedule in the 'Dashboard' section of the plugin settings.