REST API vs SOAP API (Benefits & Drawbacks)

This table is meant to provide insight into the benefits and drawbacks of each API.

Some of the REST API drawbacks may disappear as we expand functionality, but SOAP API will remain in place, as we are no longer updating this API.

REST API

Benefits Drawbacks
  1. ChannelAdvisor is continuing to update this API, adding new features
  2. Can retrieve data from multiple profiles in a single request
  3. SecondaryOrderId exists (may be important coming from certain marketplaces)
  4. Can create bundles
  5. Bundles are easier to interact with on the orders side
  6. Can utilize the Buyer Initiated Returns workflow to automate the process end to end outside of the UI
  7. Generally a very flexible platform - it's easier to add/omit data that isn’t needed
  8. Smaller package delivery/responses
  9. Allows for faster addition of features/properties
  10. Multiple methods to deal with request limits
  1. Product endpoints require ChannelAdvisor stored Product ID (ie: cannot use SKU in URL)

    1. This can be remedied by using Product Uploads

    2. Alternatively, to capture all Product IDs, use the Product Exports endpoint

  2. Processing limitations when two conditions exist: 1) Higher SKU counts; 2) Making requests to products via the API directly

    1. Work around this with creative integration design and the use of asynchronous Product Uploads and Product Exports 

SOAP API

Benefits Drawbacks
  1. Use of SKU to make product-related requests (ie: Quantity updates)

  1. ChannelAdvisor not adding features or upgrading SOAP API platform

  2. Cannot retrieve data from multiple profiles in a single request - each profile requires a unique request
  3. No SecondaryOrderID data exists

  4. Cannot create bundles
  5. Bundles order data only exists in specific request type, and therefore orders retrieval may require two requests depending on integration design
  6. Cannot utilize the Buyer Initiated Returns workflow

  7. Very strict formatting / not as flexible as REST

  8. Larger request delivery and responses