Skip to main content

Basics of the Seller-API

Important facts in a glance

Channel Pilot Pro Seller-API

Channel Pilot Pro offers you a SOAP api (wsdl) for automated control of your marketing activities. With this, you can optimize the sales processes for marketplaces by automating them. You import orders, transmit payment receipt, send shipping notifications or cancel orders.

Via this one interface, you can reach every marketplace you have connected via Channel Pilot Pro. This way, you manage your business processes from your system and avoid manual data transfer and process interruptions.


In addition, the prices adjusted by Channel Pilot Pro can also be retrieved.
Via the interface, e.g. store systems, product databases or entire merchandise management systems can be directly connected to marketplaces like eBay, as well as individual software solutions can be developed. The Seller-API is the connection between your environment and Channel Pilot Pro.

The following diagram will give you a better idea of how the Seller-API fits into the process.

Channel Pilot Pro integrates all "MarketplaceConnections", found on the right side, and handles all communication between marketplaces and Channel Pilot Pro (import orders, update order status, import market prices, etc.).

On the left side, you can see your environment. The Seller-API offers a way to interact with Channel Pilot Pro and, in doing so, indirectly with the marketplaces. The major advantage is that the ability to process all marketplaces with a single standardized process.

The integration can be split between Systems. For example, if you want to import new orders into your shop system, call "getNewMarketplaceOrders" and "setImportedOrders" from the shop system. But if the orders are imported into your ERP system which handles logistics, call "registerDeliveries" and other methods from the ERP system. This is called mixed integration mode.

Channel Pilot Solutions offers you finished integrations for various Shop- and ERP-Systems like Magento, Shopware, WooCommerce or PrestaShop.

For those Systems, there is no need to integrate the Seller-API on your own!

For more information, see our help section for Shop-Plugins.

Please email us if you have questions:

A ready-to-use php-implementation of the API with documentation can be found ​here.

Processing of marketplace orders

Here you find samples of the most important functions of the Seller API as PHP code snippets. A complete list of all functions with examples for SOAP UI can be found here.

Version of the Seller-API

The current version of the Seller-API is 4.3.

Minor changes or bug fixes will be integrated without a version change.

If a major change is released that will change the API and, consequently, affect existing integrations, a version change will happen.

Channel Pilot Pro will still support older versions of the API. New major versions will have a new version number and a new WSDL-Url.

If, for example, Channel Pilot Pro introduces a major change in the behavior of the method "getNewMarketplaceOrders" by adding a new parameter for filter orders by time, the version of the API will switch and the WSDL will be available at https://seller.api.channelpilot.com/4_2?wsdl.

Older versions will still be available and supported in their original form.

The documentation for the current version is available via this link. ChannelPilot_SellerAPI_v4_3_20251230 1.pdf

Generate a client

Almost all technologies offer integrated functionality to interact with a SOAP service and services to generate a client from the WSDL automatically. If you have any problems doing this, don’t hesitate to contact us for support.

A detailed documentation can be found here.

For PHP, Channel Pilot Solutions offers a PHP-SDK which can be downloaded here.

For testing purposes, we recommend the free SOAP-UI Client: http://www.soapui.org/

Authentication

Every method requires a CPAuth as input-parameter. This contains a "merchantId" that belongs to your Channel Pilot Pro Account and a "shopToken" that belongs to the shop created in Channel Pilot Pro.

Therefore, you will have one "merchantId" but may have more than one "shopToken". Make sure to use the correct "shopToken" in your calls.

The "shopToken" and "merchantId" can be found here:

The communication can be restricted to specific IPs on both sides. Plugins provided by Channel Pilot Pro automatically restrict the communication to specific IPs. Please notify us if you have a static IP and want Channel Pilot Pro to restrict incoming traffic for your "merchantId" to this IP.

Did this answer your question?