API Integration Guide

Visit our new Community site! The SSC is no longer updated. If you have bookmarked this page, click on the banner below – this will lead you to the corresponding page in the Community. Then, you can use the Star to save it there to show in the new ‘My Support Center’, in your Favourite Articles section. Use the search bar to find any other topics you're interested in.

Welcome to the ChannelAdvisor API Program! The ChannelAdvisor Developer Network provides two different methods of web service integrations that give programmatic access to ChannelAdvisor Marketplaces accounts. Sample uses include creating and updating inventory, and retrieving orders and sending back tracking numbers.

To access information programmatically, you build web service clients that connect to one or more of the ChannelAdvisor Web Services. Each service can be used independently, although for some operations, you will need to use multiple services in a single client program.

We offer a SOAP API and REST API to complete many functions that would otherwise need to be completed via files and/or our user interface.

The SOAP API is our original API that we are no longer expanding. We will continue to support this API until further notice.

The REST API is our newer API that is going to be constantly evolving. As of 2016, we recommend utilizing this API if you have the capability to do so.

Read further below to help in your decision which API to utilize.

ChannelAdvisor Developer Network

We offer the following API Services:

Inventory – The Inventory Service provides methods to manipulate products in a ChannelAdvisor account.

Listing – The Listing Service provides methods to process information regarding open listings in a ChannelAdvisor account.

SOAP API Integrations – if you're new to the ChannelAdvisor SOAP API this link gives you some context and basics about our SOAP API. As a seasoned developer, access the complete SOAP API documentation by going to this page on our Developer Network.

REST API Integrations – this link takes you to our Developer Network which contains documentation on both of our SOAP and REST APIs, but primarily focuses on REST API. We recommend following the documentation on the landing page, starting with “Getting Started”.

Requesting a Developer Key

Request your Developer Key by completing the form found here . You will receive one email to verify your email address and a second email to deliver your developer key. You will need the developer key to make requests to the ChannelAdvisor SOAP and REST APIs.

Suggested Integration Process

The most common use of our API is Price and QTY updates, and order management. Since this is a quick start guide we will focus on that.

For REST API, this site contains guidance on how to integrate with the API, tables of the entities/properties, and a lot of of code examples to help get your integration up and running. Follow the “Getting Started” section on the primary landing page to ensure you don’t skip a step.

Subscribe to our Developer Google Group Posts to this group are monitored, and ChannelAdvisor will respond to questions about general call formats and integration concepts. Avoid asking specific questions about your calls, code, and specific errors unless you hope a non-ChannelAdvisor developer will chime in. Those kinds of questions can be fielded by our Support team (see next option for “Contact Support”). This is why the forum is a great way to connect with fellow developers – over the years it’s served as a support forum becoming a living knowledge base. We will use this forum to announce new API releases and support issues.

Contact Support If you are having specific call issues with whether these are errors, integration problems, or unexpected behaviors, please contact our support team by opening a support ticket . An initial response will be provided within 1 business day unless you indicate you have a critical, time-sensitive need.

Visit our new Community site! The SSC is no longer updated. If you have bookmarked this page, click on the banner below – this will lead you to the corresponding page in the Community. Then, you can use the Star to save it there to show in the new ‘My Support Center’, in your Favourite Articles section. Use the search bar to find any other topics you're interested in.

Welcome to the ChannelAdvisor API Program! The ChannelAdvisor Developer Network provides two different methods of web service integrations that give programmatic access to ChannelAdvisor Marketplaces accounts. Sample uses include creating and updating inventory, and retrieving orders and sending back tracking numbers.

To access information programmatically, you build web service clients that connect to one or more of the ChannelAdvisor Web Services. Each service can be used independently, although for some operations, you will need to use multiple services in a single client program.

We offer a SOAP API and REST API to complete many functions that would otherwise need to be completed via files and/or our user interface.

The SOAP API is our original API that we are no longer expanding. We will continue to support this API until further notice.

The REST API is our newer API that is going to be constantly evolving. As of 2016, we recommend utilizing this API if you have the capability to do so.

Read further below to help in your decision which API to utilize.

ChannelAdvisor Developer Network

We offer the following API Services:

Inventory – The Inventory Service provides methods to manipulate products in a ChannelAdvisor account.

Listing – The Listing Service provides methods to process information regarding open listings in a ChannelAdvisor account.

SOAP API Integrations – if you're new to the ChannelAdvisor SOAP API this link gives you some context and basics about our SOAP API. As a seasoned developer, access the complete SOAP API documentation by going to this page on our Developer Network.

REST API Integrations – this link takes you to our Developer Network which contains documentation on both of our SOAP and REST APIs, but primarily focuses on REST API. We recommend following the documentation on the landing page, starting with “Getting Started”.

Requesting a Developer Key

Request your Developer Key by completing the form found here . You will receive one email to verify your email address and a second email to deliver your developer key. You will need the developer key to make requests to the ChannelAdvisor SOAP and REST APIs.

Suggested Integration Process

The most common use of our API is Price and QTY updates, and order management. Since this is a quick start guide we will focus on that.

For REST API, this site contains guidance on how to integrate with the API, tables of the entities/properties, and a lot of of code examples to help get your integration up and running. Follow the “Getting Started” section on the primary landing page to ensure you don’t skip a step.

Subscribe to our Developer Google Group Posts to this group are monitored, and ChannelAdvisor will respond to questions about general call formats and integration concepts. Avoid asking specific questions about your calls, code, and specific errors unless you hope a non-ChannelAdvisor developer will chime in. Those kinds of questions can be fielded by our Support team (see next option for “Contact Support”). This is why the forum is a great way to connect with fellow developers – over the years it’s served as a support forum becoming a living knowledge base. We will use this forum to announce new API releases and support issues.

Contact Support If you are having specific call issues with whether these are errors, integration problems, or unexpected behaviors, please contact our support team by opening a support ticket . An initial response will be provided within 1 business day unless you indicate you have a critical, time-sensitive need.