How To

API Integration Guide

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

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.
  • Marketplace Ads – The Marketplace Ad Service provides methods to manipulate Ads in ChannelAdvisor.
  • Order – The Order Service contains public web methods for retrieving and submitting Orders. An order represents an entire purchase commitment from a buyer to a ChannelAdvisor seller.
  • Shipping – The Shipping Service is used to manage and query shipping information into a ChannelAdvisor account.

 

Video


API Overview – This video gives a brief overview of how the ChannelAdvisor API works. View the transcript of this video .

 

Prerequisites


You should be familiar with the following topics before continuing:

 

Tasks to Complete to use ChannelAdvisor APIs


The following steps will guide you through the process of requesting your Developer Key and requesting access to a ChannelAdvisor account.

  1. Request a Developer Key
  2. Suggested Integration Process
  3. Choose SOAP API Integration or REST API Integration (or a combination of both if needed)
    1. Read about benefits/drawbacks of each API here
    2. 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.
    3. 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”.
  4. Support

 

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.

The following table outlines our suggested integration method:

Data Frequency Preferred Method Other Methods
Full Product DataOnce a WeekFTPUpload
Delta Product DataOne to twice a dayFTPUpload, Manual
Delta Price ChangesHourlyAPIFTP, Upload, Manual
Delta Stock Change15-30 MinsAPIFTP, Upload, Manual
Orders15-30 MinsAPICheckout Reports
Shipment & Refunds15-30 MinsAPICheckout Reports

 

Back to top

 

Support

You can access the ChannelAdvisor Developer Network here .

  • For SOAP API, go to the SOAP API subsection . While the remainder of the site speaks to REST API, this part of the site contains all of our WSDLs, code samples and release notes that are unique to SOAP API.
  • 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.

Back to top

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

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.
  • Marketplace Ads – The Marketplace Ad Service provides methods to manipulate Ads in ChannelAdvisor.
  • Order – The Order Service contains public web methods for retrieving and submitting Orders. An order represents an entire purchase commitment from a buyer to a ChannelAdvisor seller.
  • Shipping – The Shipping Service is used to manage and query shipping information into a ChannelAdvisor account.

 

Video


API Overview – This video gives a brief overview of how the ChannelAdvisor API works. View the transcript of this video .

 

Prerequisites


You should be familiar with the following topics before continuing:

 

Tasks to Complete to use ChannelAdvisor APIs


The following steps will guide you through the process of requesting your Developer Key and requesting access to a ChannelAdvisor account.

  1. Request a Developer Key
  2. Suggested Integration Process
  3. Choose SOAP API Integration or REST API Integration (or a combination of both if needed)
    1. Read about benefits/drawbacks of each API here
    2. 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.
    3. 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”.
  4. Support

 

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.

The following table outlines our suggested integration method:

Data Frequency Preferred Method Other Methods
Full Product DataOnce a WeekFTPUpload
Delta Product DataOne to twice a dayFTPUpload, Manual
Delta Price ChangesHourlyAPIFTP, Upload, Manual
Delta Stock Change15-30 MinsAPIFTP, Upload, Manual
Orders15-30 MinsAPICheckout Reports
Shipment & Refunds15-30 MinsAPICheckout Reports

 

Back to top

 

Support

You can access the ChannelAdvisor Developer Network here .

  • For SOAP API, go to the SOAP API subsection . While the remainder of the site speaks to REST API, this part of the site contains all of our WSDLs, code samples and release notes that are unique to SOAP API.
  • 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.

Back to top

0
Your rating: None
0
Your rating: None