SOAP API Documentation

This section provides documentation, code samples, and other information regarding legacy API connectivity to the ChannelAdvisor platform.  The documentation specifically describes the latest version of the SOAP API, V7.

REST vs SOAP

Having been in service since 2006, the SOAP API is our legacy interface.  Full support is still offered for V7, but where possible, developers of new integrations are strongly encouraged to consume the newer REST API, which offers the vast majority of the functionality present in the SOAP API plus much more.  The REST API includes the SOAP API Credentials Flow to help SOAP API users transition to REST as seamlessly as possible.

Getting Started

Steps for Developer:

  1. See the Understanding Security page for instructions on setting up API access.
  2. Check out the Intro to Integrations guide to get an idea of the API's capabilities.
  3. Review the provided Code Samples and Application Example - Exporting Orders for ideas on how to get started with an integration.
  4. To ask questions about how to use the API, join our ChannelAdvisor Developer Network Google Group. A wealth of previous discussion threads are available to be searched for answers, or new questions can be posted as needed.
  5. For help troubleshooting an error, create a support ticket on the ChannelAdvisor Community. Please be prepared to provide the full XML request and response.

Web Services

Please note, SOAP v1.1 is supported, but SOAP v1.2 is not.

Frequently Used Services

Other Services

Service Name

Service Description

WSDL

Cart Service

Manage shopping carts.

https://api.channeladvisor.com/ChannelAdvisorAPI/v7/CartService.asmx?WSDL

Deprecated Services

Resources