Dashboard > ChannelAdvisor Developer Network > ChannelAdvisor Developer Network > FAQ
Log In   View a printable version of the current page.
Added by Rick Watson, last edited by Marshall McClure on Aug 08, 2013  (view change)

Getting Started

This page contains frequently asked questions from developers using ChannelAdvisor's API.

How do I sign up for the ChannelAdvisor Developer Network?

We are happy to grant you credentials to the APIs.  However, they are not very useful unless you have a CA customer grant you access to their account.

See the Understanding Security page for instructions.

I am an Independent Software Vendor (ISV) who wishes to provide an integrated solution to ChannelAdvisor customers. What do I need to do?

You can learn about our partner program here http://www.channeladvisor.com/partners/channeladvisor-partner-program/ and submit a request to join the program here http://www.channeladvisor.com/partners/become-a-partner/.

Can I get access to a test account?

To request a test account, please complete the following ChannelAdvisor support form: http://ssc.channeladvisor.com/support/common-requests/request-new-posting-account.

If you are a 3rd party software developer working on an API integration for a ChannelAdvisor client, please have the client submit this request on your behalf. This will ensure the account is created with the proper information for you to work on the client's behalf.

Once the account has been created, you or the client you are working with will be notified. At that time you can follow the instructions on the Understanding Security page to gain access to the new account using the API.

Please note that all transactions completed within a ChannelAdvisor account are billable transactions. Note: Additional fees may be required for an additional posting account.

How does authentication work in ChannelAdvisor's API?

ChannelAdvisor assigns each developer or organization a Developer Key and password.  These two pieces of information are required in every call to a ChannelAdvisor API.  For any call accessing ChannelAdvisor account data, an AccountID is required as well.  Developers must have permission from the seller to access their account's data.  Sellers seeking access to their own account data through APIs are welcome as well.  Our code samples show the usage of the Developer Key and password.

See Understanding Security for more details.

How do I find the AccountID for one of my accounts?

If you are a CA customer, go to My Accounts > Developer Network > Account Authorizations in the ChannelAdvisor user interface. You will find the information there.

If you are a developer, call the GetAuthorizationList API method.

How do return types work in ChannelAdvisor's API?

See the APIResult documentation.

What's a Web Service?

Here are some useful articles to get you started. In general pay attention to the articles about SOAP and WSDL:

Can your API do this?

How do I retrieve a list of orders from ChannelAdvisor?

The GetOrderList function in the Order Service enables you to do this.  A working sample is located here: Application Example - GetOrderList by ExportState

Can I write software to add and update inventory items in ChannelAdvisor automatically?

Yes. The SynchInventoryItemList method in Inventory Service can be used to send detailed inventory information to ChannelAdvisor.

I have my own eCommerce Store front-end, but want to use ChannelAdvisor's checkout. How do I do this?

The methods of the Cart Service, particularly CreateCart, allow you to send shopping cart information to ChannelAdvisor. This method returns a CheckoutURL which you can use to redirect your buyers to ChannelAdvisor Checkout.

I want to submit sales for channels outside of ChannelAdvisor.  How does that work?

The SubmitOrder function in Order Service allows this behavior.

Coding and Web Service Interoperability

Can ChannelAdvisor's API be used with Perl?

Yes. While trying to make this work, we found these articles helpful:

Can ChannelAdvisor's API be used with Java?

Yes. This article contains details about using Apache SOAP for connecting to a .NET XML Web Service.

Can ChannelAdvisor's API be used with Python?

Yes, but it can be challenging. At the very least, you can post the XML and make it work.

I can choose any language to connect to ChannelAdvisor.  Which should I use?

At ChannelAdvisor, we prefer and recommend C#, but really any .Net-based language will be the easiest to connect to ChannelAdvisor's Developer Network.  Java is our next recommendation, followed by PHP.

See the Code Samples page for examples of connecting to ChannelAdvisor using different languages.

What SOAP Framework is used to build ChannelAdvisor's Web Services?

ChannelAdvisor uses Microsoft's .NET technology to create its Web Services.  The API supports SOAP 1.1 only.

Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.5.1 Build:#806 May 06, 2007) - Bug/feature request - Contact Administrators