How To

Sample Integration Operations

The ChannelAdvisor API is powerful and flexible, and here are some of the most common use cases for this type of integration. Using the API may complement or replace the use of FTP or the ChannelAdvisor UI for handling updates.

We have two APIs available – SOAP and REST – for you to integrate to. The following sample integration operations are applicable to both APIs.

 

Prerequisites


You should be familiar with the following before continuing:

 

Sample Integration Operations


 

Inventory Sync with Recommended Intervals

  • Add new SKUs: Perform a full sync of all fields for an item. Frequency: only when necessary.
  • Price and quantity updates: Only for changed items. Frequency: at most every 15 minutes and as infrequently as once per day for a changed item.
  • Update of inventory fields other than price and quantity. Frequency: once or twice a day, only for changed items.
  • Tips
    • Wherever possible, track changes on your external system and only sync changed items with ChannelAdvisor. This greatly limits the number of calls that have to be processed as well as the payload size of each API call. Compared to syncing all items, we find that syncing changes-only eliminates well over 90% of traffic between CA and external systems, leading to greatly improved application performance.
    • API inventory synchronization is recommended where 20,000 or fewer SKUs are being updated hourly. Above 20,000 SKUs, we recommend submitting updates via FTP to avoid excessive latencies.

 

Pulling Orders from ChannelAdvisor into External System

  • Retrieve New Orders: typically sellers want to retrieve orders that are ready to ship (the payment has cleared and the order is unshipped.)
  • Only retrieve the order once so your downloads don't get duplicated.
  • After downloading, you should mark the order as having been previously downloaded.

 

Updating Shipping Status from External System to ChannelAdvisor

  • Tracking Numbers: once the order ships from the external system, the seller can send ChannelAdvisor the shipping details including the Carrier and Class code.

 

Refunding Customer Orders

  • Many sellers have a defined refund process in the external system and would like to eliminate manual processes throughout the order lifecycle - the API refund method allows you to tie your existing system flows into ChannelAdvisor in an automated fashion. The exact refund process may vary by marketplace.

 

Reference


The ChannelAdvisor API is powerful and flexible, and here are some of the most common use cases for this type of integration. Using the API may complement or replace the use of FTP or the ChannelAdvisor UI for handling updates.

We have two APIs available – SOAP and REST – for you to integrate to. The following sample integration operations are applicable to both APIs.

 

Prerequisites


You should be familiar with the following before continuing:

 

Sample Integration Operations


 

Inventory Sync with Recommended Intervals

  • Add new SKUs: Perform a full sync of all fields for an item. Frequency: only when necessary.
  • Price and quantity updates: Only for changed items. Frequency: at most every 15 minutes and as infrequently as once per day for a changed item.
  • Update of inventory fields other than price and quantity. Frequency: once or twice a day, only for changed items.
  • Tips
    • Wherever possible, track changes on your external system and only sync changed items with ChannelAdvisor. This greatly limits the number of calls that have to be processed as well as the payload size of each API call. Compared to syncing all items, we find that syncing changes-only eliminates well over 90% of traffic between CA and external systems, leading to greatly improved application performance.
    • API inventory synchronization is recommended where 20,000 or fewer SKUs are being updated hourly. Above 20,000 SKUs, we recommend submitting updates via FTP to avoid excessive latencies.

 

Pulling Orders from ChannelAdvisor into External System

  • Retrieve New Orders: typically sellers want to retrieve orders that are ready to ship (the payment has cleared and the order is unshipped.)
  • Only retrieve the order once so your downloads don't get duplicated.
  • After downloading, you should mark the order as having been previously downloaded.

 

Updating Shipping Status from External System to ChannelAdvisor

  • Tracking Numbers: once the order ships from the external system, the seller can send ChannelAdvisor the shipping details including the Carrier and Class code.

 

Refunding Customer Orders

  • Many sellers have a defined refund process in the external system and would like to eliminate manual processes throughout the order lifecycle - the API refund method allows you to tie your existing system flows into ChannelAdvisor in an automated fashion. The exact refund process may vary by marketplace.

 

Reference


0
Your rating: None
0
Your rating: None
Tags
API