KCC Shopify Integration Guide

KCC Shopify Integration Guide

Before You Begin

This document is intended to be used as a resource alongside the How To Set Up a Shopify Channel and How To Control Stock Levels On Your Channel videos on our Support Portal which we recommend you watch beforehand.

By default, any channels created in your live system will be activated. If you wish to test your channel integration in your demo system, please contact support@khaoscloud.com asking for your channels to be activated in your demo system.

NOTE: Any Shopify stores created after January 2024 on the basic plan, will not have access to customer information via private apps and therefore we cannot import orders. To use this please use the premium plan.

KCC Channel Setup

Before getting the information from Shopify to link to your KCC Shopify channel, if you haven't already created your Shopify channel on KCC, now is a good time to do it as you will be copying information across when you link KCC to Shopify.
  1. Select New Channel from the blue command button at the top of the KCC screen.
  2. Choose Shopify from the dropdown option and click OK.
  3. Set the General box as required.
    1. Name – This is the name of the channel as it will appear in Khaos Control Cloud. It does not need to match up to any official channel name so long as you can identify it.
    2. Type – This is the type of channel which was selected when creating the new channel, it is displayed here purely for confirmation purposes.
    3. Channel Enabled – Determines whether the channel is enabled or disabled. We would recommend that it remains enabled once you have authenticated the channel.

Once you have created your channel in KCC, leave the screen open, alternatively if you've already set one up, please open it in edit mode.
You're now ready to continue.

Linking to your Channels

Generate an API Key

The following steps enable you to identify and enter the credentials that will allow you to link your Shopify seller accounts (channels) with KCC, and how to configure those values in KCC.
  1. Login into your Shopify Account.
  2. Click the Apps button on the main menu.
  3. Click on the Develop apps on the top right.
  4. Select Allow custom app development.
  5. Select Allow custom app development again on the next page.
  6. Select Create an app.
  7. Type in the App name (Khaos Control Cloud) and the App developer. This needs to be the admin person who looks after your Shopify account.
  8. Select Create app.
  9. Select Configure Admin API scopes.
  10. You will now need to set the permissions for the API, you will need to give read/write access for the following by ticking the checkboxes:
    1. Assigned fulfillment orders
    2. Customers
    3. Draft orders
    4. Files
    5. Fulfillment services
    6. Inventory
    7. Legal policies
    8. Locations
    9. Order editing
    10. Orders
    11. Payment terms
    12. Product listings
    13. Products
    14. Reports
    15. Resource feedback
    16. Shipping
    17. Shop locales
    18. Shopify payment accounts
    19. Shopify payment bank accounts
    20. Shopify payment disputes
    21. Shopify payment payouts
    22. Store content
    23. Third-party fulfilment orders
  11. Click save at the bottom of the screen.
  12. Go back to the overview tab at the top of the page.
  13. Select Install.
  14. Select Install again on the popup, this will move you to the API credentials tab.
  15. In the API Access Token section:
    1. Click on the Reveal Token Once. This is in blue text in the top Admin API access token panel.  You will only have one chance to do this.
    2. Copy the Admin API access token and paste this into a document and keep it safe, you'll need this in a minute. 
  16. At the bottom of the page:
    1. Copy the API key and paste this into a document to save it. It is not required for the integration.
    2. Copy the secret key and paste this into a document to save it. It is not required for the integration.
  17. Copy the store URL from the URL in the browser at the top of the screen, e.g. mystore.myshopify.com and paste this into a document and keep it safe, you'll need this in a minute. 
  18. Click on Home to exit the screen.

    KCC Channel Setup

    Setting the Credentials Against Your Channel

    The following process links your Shopify Channel in KCC to your Shopify Account.
    1. Enter the Shopify Admin URL for your Shopify Store (this MUST be the configuration address). You will need to add https:// at the beginning of this.
      1. i.e. if you have copied mystore.myshopify.com you enter https://mystore.myshopify.com
    2. Enter the Shop Access Token for your Shopify Store that you saved earlier, it was called the API Access Token.
    3. Set the Download POS Orders dropdown as required.
      1. Do not download – Shopify POS sales orders will not be downloaded into KCC.
      2. Download to generic customer account – POS orders will be downloaded to a generic customer record within KCC, so each order will be created against the generic customer with the customer’s details for each individual order being added as the contact and delivery address information.
      3. Download using customer details if present – If the customer can be matched to an existing KCC customer, the order will be linked to that customer's account. If no match is found, a new customer will be created when the order is downloaded.
    4. Channel Location
      1. This a mandatory field and the available options will be provided by Shopify on the first sync. It possible to have more than 1 stock location within Shopify and guidance for this feature should be sought from Shopify; although having multiple stock locations may, depending on setup, require a separate channel for each.
        2. Please Note: Stock levels will not sync unless this is specified.
    5. Location Import Site - **EPOS only**
      1. The site mapping in the (Global) options Order Types grid will override this value, if different. The intention is to send each Shopify location’s orders to a specific site, if required, by defining channels for each specific Shopify location (as mentioned above).
    6. Only Import Orders For Chosen Location - **EPOS only**
      1. Enabled - KCC will import orders from the Channel Location above.
      2. Disabled - KCC will import orders from ALL Shopify stock locations.
    7. Ignore Financial Status
      1. Enabled -  Unpaid orders will be imported and the user can manually enter payment details for ‘Unpaid’ orders as required.
      2. Disabled - Only ‘Paid’ orders will be imported. 
    8. Send Shipping Notification
      1. Enabled - KCC will send tracking data to Shopify and enables Shopify to email customer with this info.
    9. Click Save Channel.

    Channel Configuration

    To configure your channel(s) please see the guide here, Channel Configuration Guide.