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

BenefitsDrawbacks
  1. Regular updates with new properties and features
  2. Retrieve data from multiple profiles in a single request
  3. Newer fields only available in REST
  4. REST is more flexible to include/exclude properties & data
  5. Smaller payload delivery/responses
  6. Faster addition of features/properties
  7. Simple request limit design
  1. Product endpoints require ChannelAdvisor stored Product ID (ie: cannot use SKU in URL)

    1. This can be remedied by using Product Uploads

    2. Capture all Product IDs by using Product Exports

  2. Not possible to page through thousands of products directly (e.g. GET /Products)

    1. Better integration design can assist

    2. Use of asynchronous Product Uploads and Product Exports avoids this entirely

  3. Cannot withdraw listings for eBay
  4. Cannot retrieve all carrier/class values available for a profile
Features Only Available in REST API

Products

  1. Create bundles
  2. See Bundle/Component associations
  3. Query for label pricing
  4. Generate Labels
  5. Generate & updated Distribution Centers
  6. Support for Vary By (Variations v2)

Orders

  1. Streamlined bundle experience in order data
  2. Buyer Initiated Returns workflow to automate the process end-to-end

SOAP API

BenefitsDrawbacks
  1. Use of SKU to make product-related requests (e.g. Quantity updates)

  2. Retrieve available carrier/class values for a profile
  3. Withdraw listings (eBay Only)
  1. No more feature updates or expansion to SOAP API platform

  2. Single profile data retrieval
  3. Newer fields may not exist

  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

  9. Cannot query for label pricing
  10. Cannot generate labels
  11. Cannot generate or manage bundle SKUs and component affiliations