cancel
Showing results for 
Search instead for 
Did you mean: 
CommunityJedi22
Community Manager
Community Manager

Click HERE to follow this general process to begin using the Ingram Micro APIs.

1.   Click the link above. To register for Ingram Micro API Access, use the signup button at the top of
the page to start this process. This process authorizes your existing Ingram Micro reseller account for API channel access.

If you already have a Developer Account with Ingram, skip registering and jump to logging in 
instead.

2.   Once the Signup has been approved, click Create a Production App by selecting ‘+Add Production App’.  Do not click into the Sandbox that will already be listed under ‘My Apps’. You will need to create a new Prod app.

Picture1.png

 

Client ID & Client Secret

3.   Select your API functions from the API Catalog, shown below. Please select all the API products you will be using with ChannelOnline.  You may use any of the options other than v7. This will cause it to fail. The depreciated selections are also not needed.

Picture2.png

4.   You can now copy & paste the Client ID, Client Secret ID from the ‘API Catalog’ selection
screen (image above) into your ChannelOnline account’s Ingram Micro integration settings
page under Suppliers > Ingram Micro > Edit Integration Settings.   See the ‘ChannelOnline Credentials Review ’ section below for navigating to this in COL.

5.   Once entered into COL, save the credentials. Your ‘Webhook Key’ field will be blank when saving in this step.  The app will then go into ‘In Review’ status. Nothing more can be done until it changes to approved.

6.   Check IM Dev Portal for Approval, then select the ‘Webhooks’ link on your main ‘My Apps’ screen, shown in the image below:

Picture3.png

7.   The pre-generated ‘Signature Token’ on the Webhook Details page will need to be copied and pasted into the COL credentials for the ‘Webhook Key’ field.

Picture4.png

 

Webhook – Entered in IM Dev Portal

You can now refer to this visual walkthrough guide for completing the Credentials Setup in
the next few steps – Also continues below ‼️CLICK: Ingram API Webhook & Credentials Walkthrough

 

9.   Add the ChannelOnline Destination URL into the IM Dev Portal (image above). Copy & Paste the below URL into the Destination URL field – you will need to remove & replace with your COL shortcut, from the URL to your login page.

Example: global.channelonline.com/smbi/home.... You would replace with smbi and leave the /1 at the end if you have a US account or /29 for Canadian

USA : https://api.channelonline.com/supplierapi/distributorWebhook//1

Canada : https://api.channelonline.com/supplierapi/distributorWebhook//29

 

10.   Select ‘Notification Events’ Options on the Webhook Details page, shown in screenshot above.  

  • The most basic functionality of the API is real-time Pricing & Availability (Live Cost) --this is enabled with the 'IM::stock_update' event. 
  • The xVantage Quote Import function is enabled with the 'IM::quote_to_order' event
  • PO Tracking & Serial Updates are enabled with the 'IM::order_shipped' event
  • Enabling ‘IM:quote_create’ will most likely generate many ‘Error’ email notifications
    to your inbox.

Contact electronic.services@ingrammicro.com for any questions

 

ChannelOnline Credentials Review

Follow this process to begin using the Ingram Micro APIs. In ChannelOnline:
1.   Log in to ChannelOnline and navigate to the Settings page for Ingram Micro (Tip: Click on Ingram Micro from the upper-right side Supplier Status box on your homepage Dashboard). Otherwise, you can click into the Admin Menu > Suppliers > Ingram Micro.

2.   On the Supplier Setup Page, switch the API Type from XML to ‘APIS (Recommended)’ 

3.   After switching, enter the following:
a. Enter your Webhook API Key/Signature Token (see Webhooks link in step 3 above).
b. Enter your Client ID
c. Enter your Client Secret

4.   Once all the API credentials have been entered, click the Save and Exit button below.
5.   Click ‘Run Test’ on the main screen once the credentials pop-up has closed to ensure the connection is working.

 

Picture5.png

Find information for TD Synnex API Setup HERE.

Please post your questions in the comments below.

 

Version history
Revision #:
2 of 2
Last update:
‎03-19-2026 08:36 AM
Updated by:
 
Contributors