Channel API

Documentation on how to use Channel API.

• Channel Setup Guides
• How to Set Up Wix
• How to Set Up Zoho
• How to Set Up EKM
• DC Amazon Vendor Integration User's Guide
• How To Setup QuickBooks (TradeGecko)
• How to Set Up Fruugo
• How to Set Up OnBuy
• How to Set Up Wish
• How to Set Up Magento 1
• How To Set Up Magento 2
• How To Set Up WooCommerce
• How To Set Up PrestaShop
• How to Set Up SquareSpace
• How to Set Up BigCommerce
• How to Set Up Shopify

Channel Setup Guides

In this chapter, we explain how to get the required credentials to be able to add your channels to Channel API.

How to Set Up Wix

WIX CHANNEL API INTEGRATION GUIDE 

1. Please go to this URL: https://dev.wix.com/dc3/my-apps

And sign in with your Wix account. 

2. Then you will be presented with the below page:

3. Click on the Create Your First App Button.

Or, if you have already created an app before, click on the Create New App button.

4. Then click on the Permissions menu, and then click on the Add Permissions button.

5. Then choose Permission Category -> Wix Developers and save.

6. And click on the Add Permission button again and select 

Permission Category -> Wix Stores, 

And check: 

Manage Products, 

Read Orders, 

Read Products, 

Manage Orders scopes and save. 

7. Click on the OAuth menu in the next step. 
8. Click on the OAuth menu in the next step. Then the Redirect URL and App URL fields 

https://production.channelapi.co.uk/authorization/wix  

fill in and save. 

9. Then copy the App ID and App Secret Key.

 

 

How to Set Up Zoho

1. Log in to your Zoho Account -> https://accounts.zoho.com/developerconsole
2. Add New Client
3. Choose a Client Type -> Server-based Applications
4. Fill in the fields:
   Client Name: Any name can be given
   Homepage URL: https://production.channelapi.co.uk
   Authorized Redirect URIs: https://production.channelapi.co.uk/authorization/zohocommerce
5. Then Copy Client ID and Client Secret
6. Login https://production.channelapi.co.uk
7. Create New Channel (Zoho Commerce)
8. Fill in the required fields:
   Channel Name
   Client ID (KEY) (The Zoho Application Client ID)
   Client Secret (The Zoho Application Client Secret)
9. Save Channel
10. Then click on the "Connect" button.
11. The authorisation is confirmed.
12. Completed.

How to Set Up EKM

1. Go to the URL: https://partners.ekm.net/Account/Login

And sign in with your EKM Partner Account.

2. Please click the Create Application button. 

3. Then, fill in the Display Name, Description, Contact Email Address fields.

 

 

 

 

 

 

 

4. Fill in the Return URL field as:

https://production.channelapi.co.uk/authorization/ekm 

 

5. Tick the checkboxes next to the permissions below.

Read Orders, 

Write Orders,

Read Products,

Write Products,

Read Order Statuses

 

6. Then click the Create Application button.

7. After creating the application, you will see your application as "Unverified" in the "Your Applications" section.

 

8. Click on your application and click on the “Request Verification” button on the page. And click on the "Yes, publish" button.

9. Your application has been marked as "Pending Verification" to be approved by EKM. Click on your application when it is marked as "Verified" as in the image below.

 

 10. Click on the application that is marked as "Verified" and

Copy the Client Key and Client Secret

 

 

 

 

DC Amazon Vendor Integration User's Guide

Despatch Cloud Amazon Vendor User's Guide

1. Create Amazon Vendor Channel

• Log in to https://production.channelapi.co.uk/login or if you do not already have an account, create one on here https://production.channelapi.co.uk/register 
• Click "Stores" in the left menu.
• Add a new store or click the () edit icon next to the store you have added before.
• Here you will see the list of channels belonging to the store. Click the + Add button in the upper right. And click on the Amazon Vendor logo.

• Enter your Amazon Vendor Credentials. And check “Is Active”, then click the “Save” button.

How to Get Amazon Vendor Credentials?

Please review the file "Registering Your Selling Partner API Application" to be provided by your account manager and complete the steps in accordance with the file.

2. List of Confirmation Orders

• Click the Purchase Orders menu to see your purchase orders.

Note: If the list is empty, it means that new confirmation orders have not been sent to the system yet.

3. Acknowledgement Management of Confirmation Orders

• Click on the edit icon next to any Confirmation Order.
• Then, in the confirmation order detail, under the Confirmation Order Items section, the acknowledgement information for each item is available. The default status of each item is Pending.

You should mark each item as Accept or Reject.

Note: You can also backorder the item marked as Accept.

Marking as "Accept"

If you are going to accept the entire item as in the example below, please enter the "Accepted Item Quantity" value as the total item quantity.

Then, enter the "Accepted Scheduled Ship Date" date and click the "Save" button.

Marking as “Accept” and “Backorder”

As in the example below, please fill in the Accepted and Backordered Item quantity fields so that it does not exceed the total item quantity. Then, enter the Accepted and Backordered Scheduled Ship Dates and click the “Save” button.

Marking as “Reject”

As in the example below, select the rejected reason and click the “Save” button.

4. Confirm and Submit Acknowledgements

Finally, click on the "Confirm and Submit Acknowledgments" button as in the image below.

Note: Make sure that all items are marked with acknowledgement info.

Review the marked items and click the “Submit” button.

 

 

 

How To Setup QuickBooks (TradeGecko)

1- Log in to the URL https://go.tradegecko.com/oauth/applications with your QuickBooks account.

2- Please click the New Application button.

3- Please fill in the Name and Redirect URI fields as in the example below. And click the Submit button.

Redirect URI: https://production.channelapi.co.uk/authorization/quickbooks

4- Copy the UID (APP ID) and Secret (APP Secret) fields.

How to Set Up Fruugo

Please copy the email and password info entered to https://retailer.fruugo.com.

How to Set Up OnBuy

1. Go to the URL: https://seller.onbuy.com

Then sign in with your Seller Account.

2. Please enter the URL: https://seller.onbuy.com/inventory/integrations/onbuy-api

3. And copy the Consumer Key and Secret Key fields in the "Live keys" section.

How to Set Up Wish

1. Log in with your Wish merchant account: https://merchant.wish.com/login

If you don't have a merchant account, please create one. https://merchant.wish.com/open-express

2. Enter the URL: https://merchant.wish.com/client-settings 

3. Then, click on the "Register a private app" link and fill in the fields below.

App Name: Any name

Redirect URL: https://production.channelapi.co.uk/authorization/wish

4. Then copy the Client ID and Client Secret fields.

 

 

How to Set Up Magento 1

1. Log in to your Magento Panel.

2. Click on Panel Menu -> System -> Web Services -> SOAP/XML-RPC - Roles.

3. Click on the "Add New Role" button.

4. Fill the fields in the image below.

5. Then, click on the Role Resources tab.

Select Resource Access as "All"

 

6. Click on the Save Role button.

7. Then Click on the Panel Menu -> System -> Web Services -> SOAP/XML-RPC - Users.

8. Click the "Add New User" button.

Fill the fields in the image below.

Note: Take note of the User Name and API Key. These values are required to complete the integration.

9. Select the role and click on the "Save User" button.

How To Set Up Magento 2

Please copy the email address and password used to log into your Magento Dashboard.

How To Set Up WooCommerce

1. Log in to your WooCommerce Dashboard.

2. Click the menu WooCommerce -> Settings

3. Then Click "Advanced" Tab and Page Setup -> Rest API

4. Click on the "Add Key" button.

5. Define the API key according to the image below.

Note: The Permissions field must be Read/Write.

6. Then copy the Consumer Key and the Consumer Secret.

How To Set Up PrestaShop

1. Log in to your PrestaShop Dashboard.

2. Click the menu Advanced Parameters -> Webservice.

3. Then Click on the  "Add new webservice key" button.

4. And click Generate Key button or write a unique one.

5. Please select the permissions below.

products (GET),

product_options (GET),

product_option_values (GET),

stock_availables (GET, PUT),

orders (GET),

order_invoices (GET),

order_details (GET),

order_carriers (PUT),

addresses (GET),

customers (GET),

currencies (GET),

combinations (GET)

6. Then copy the API Key and click the "Save" button.

 

 

 

How to Set Up SquareSpace

1. Log in to the Squarespace site.
2. In the left navigation menu, click Settings; scroll down and click Advanced.
3. Click Developer API Keys.
4. Click the GENERATE KEY button.
5. In the dialogue box, add a key name under "KEY NAME", and please select the permissions below.

Products (Read and Write)

Inventory (Read and Write)

Orders (Read and Write)

6. Then, click GENERATE KEY button above.

7. Keep the generated key in a safe and secure place.

How to Set Up BigCommerce

1. Log in to your BigCommerce Dashboard.

2. Navigate to Advanced Settings > API Accounts > Create API Account

3. Then click Create API Account > Create V2/V3 API Token

4. Give the account a name (it will only be visible to store users).

5. Record the "your_store_hash" in a safe and secure place.

https://api.bigcommerce.com/stores/{your_store_hash}/v3

Example;

6. In the OAuth Scopes section,

Select the Orders (Modify) and Products (Modify) scopes.

7. Then, click the Save button.

8. Keep the Client ID, Client Secret and Access Token in a safe and secure place.

 

How to Set Up Shopify

1. From your Shopify admin, click Apps.

2. Click on Manage private apps.
3. Click on Create a new private app.
4. Enter the details for your private app.
5. Click on the Show inactive Admin API permissions button.

6. Please select the permissions below.

 - Fulfillment Services (Read and Write)

 - Inventory (Read and Write)

 - Orders (Read and Write)

- Products (Read and Write)

7. Select Webhook API version "2020-07"

8. Then click Save.
9. Keep the API key and Password in a safe and secure place.