SOAP API Release Notes

Overview

This page contains information about changes to the ChannelAdvisor SOAP API over time.  All changes will be noted here. The differences are noted with the following information:

Legend
    "> note" = added
    "< note" = removed
    "~ note" = changed

April 26, 2021

< Remove ability to cancel fulfillments directly via FulfillmentUpdateSubmit. To properly cancel an item, use SubmitOrderRefund.

May 4, 2020

~ HTTP support for SOAP API deprecated. HTTPS is required for all ChannelAdvisor API requests.

Feb 13, 2018

Update to all versions

Inventory Service

< AddUpsellRelationship, DeleteUpsellRelationship, and GetUpsellRelationship have been deprecated in all versions of the SOAP API to coincide with the upsell relationship feature being removed from the ChannelAdvisor platform.

Oct 10, 2017

Update to V3 and V5

< The following unused methods have been deprecated in old API versions. Please upgrade to V7 if you wish to continue using these methods.

Mar 15, 2016

Order Service
~ In GetOrderList, the behavior of FulfillmentTypeFilter has been changed slightly to improve compatibility with the Multiple Distribution Centers feature.  The SellerOnly filter value will now match and return line items that are split across multiple distribution centers.  Previously, split line items could only be retrieved by using the All filter value.

Feb 16, 2016

Update to V1 V2, V3, V4, and V5

< The following unused methods have been deprecated in old API versions. Please upgrade to V7 if you wish to continue using these methods.

January 19, 2016

Order Service 
~ In V7, V6, and V5, the behavior of UpdateOrderList has been changed slightly. If ShippingInfo is included in the request, then EmailAddress is a required field and must be in the form of an email address.

May 12, 2015

Order Service
~ In V7 and V6, renamed the MEIN_PAKET SiteToken to ALL_YOU_NEED and added CDISCOUNT and WALMART_MARKETPLACE.

August 26, 2014

Admin Service
< The following methods were deprecated in this release: GetAuthorizationList and RequestAccess in V2.

July 1, 2014

Update to V7

Inventory Service
> Added BlockExternalQuantity boolean to InventoryItemSubmit for use in SynchInventoryItem and SynchInventoryItemList. This field blocks externally managed quantity from being listed on marketplaces or used to fulfill orders. The most common scenario would be preventing an FBA-managed product from being listed on a marketplace.

May 6, 2014

< The following methods were deprecated in this release:

Febuary 11, 2014

Update to V7

Fulfillment Service
> Added FulfillmentService to V7.
From drop shipping to in-store pickup, sellers are using new methods to fulfill their orders. In an effort to give our users more control over their fulfillment methods, we've released the new Fulfillment Service. This service provides methods to manage fulfillments in a more straightforward and precise way than the SubmitOrderShipmentList method in ShippingService.

This service includes the following methods:
- GetOrderFulfillmentDetailList: returns all fulfillment details, including items
- MoveFulfillmentItems: moves all or part of a fulfillment item from one fulfillment to another
- UpdateOrderFulfillments: sets the fulfillment status, carrier, class, tracking, and other details
- CreateOrderFulfillments: allows a user to specify the details of a new fulfillment: fulfillment type and status, carrier, class, tracking, DC, cost (for unpaid orders), shipped date, seller fulfillment ID, items

While this service is not required* we suggest the following workflow:
1. GetOrderList searches for orders ready for shipment
2. GetOrderFulfillmentDetailList gets fulfillment information for requested orders
3. CreateOrderFulfillments and/or MoveFulfillmentItems rearranges fulfillment data as desired
4. UpdateOrderFulfillments sets final tracking, carrier, and status for remaining unshipped fulfillments

Order Service
> New site token added to V6 and V7 : SHOPIFY_POS

Inventory Service
> Added GetDistributionCenterList to V7 Inventory Service. This method returns the list of Distribution Centers (DC) available to the account.

January 12, 2014

Update to V7

Shipping Service
> Added Canceled to FulfillmentStatus. Cancellations processed with SubmitOrderRefund will automatically place canceled items in a canceled fulfillment to indicate they should not be fulfilled.

Inventory Service
> Added DCQuantityUpdateType to InventoryItemSubmit, which is used in SynchInventoryItem and SynchInventoryItemList.  DCQuantityUpdateType specifies how to update quantities across multiple distribution centers.  See InventoryItemSubmit for more information.

Order Service
> The value in the  PaymentType has changed from "Buy.com" to "Rakuten.com Shopping". If you have have downstream system such as shipping or reporting system, you might need to update these so that they recognize "Rakuten.com Shopping" as a payment type instead of "Buy.com". The Site Name will stay the same - Buy.com.

Update to V1 V2, V3, V4, V5, and V6

< Unused methods have been deprecated in old API versions. Please upgrade to V7 if you wish to continue using these methods. None of the WSDLs have changed; however, if a deprecated method is called, it will return the following error message: "This method has been deprecated in this obsolete version of the API.  Upgrade to the current API version to continue using this method.  Please visit http://developer.channeladvisor.com/ for information."

The following methods have been deprecated:

October 29, 2013

Update to V6 and V7

Order Service
    > Added MEIN_PACKET to SiteToken

August 27, 2013

Update to V6 and V7

Order Service
    > Added PLAY_DOT_COM to SiteToken

Update to V7

Order Service
    > Added LineItemID to RefundItem in the SubmitOrderRefund request and response.
    > Added FulfillmentType to OrderLineItemItem in the SubmitOrder request and GetOrderList response.
    > Added new options for FulfillmentTypeFilter in OrderCriteria: SellerShipOnly, SellerPickupOnly, SellerShipToStoreOnly, and SellerCourierOnly.

Shipping Service
    > Added FulfillmentType and FulfillmentStatus to PartialShipmentContents in the SubmitOrderShipmentList request.
    > Added FulfillmentType and FulfillmentStatus to OrderShipmentResponse in the GetOrderShipmentHistoryList response.

June 13, 2013

Update to V6 and V7

Order Service
    > Added BIGCOMMERCE and SHOPIFY to SiteToken

May 2, 2013

Update to V7

Order Service
    > Added FulfillmentTypeFilter to OrderCriteria in the GetOrderList request.
    ~ In OrderLineItemItem, renamed IsFBA to IsExternallyFulfilled.

April 16, 2013

New version: The April 2013 release marks the introduction of a new version of the ChannelAdvisor API. V7 is accessible via a slightly different URL from previous versions.  All WSDL URLs in the documentation will be updated after the release to point to the new version.  The changes listed below only affect V7, unless otherwise specified.

Inventory Service
Changes have been made to the following methods to provide better quantity management at the distribution center level across multiple centers. Quantity updates are now submitted at the item-distribution center level rather than the item level. See the documentation of each method and its objects for more details.

• GetFilteredInventoryItemList
• GetInventoryItemList
• GetInventoryItemQuantityInfo
• GetInventoryItemShippingInfo
• SynchInventoryItem
• SynchInventoryItemList
• UpdateInventoryItemQuantityAndPrice
• UpdateInventoryItemQuantityAndPriceList

Order Service
    > Extended SetOrdersExportStatus to accept an array of OrderID values and return an array of type SetExportStatusResponse to provide more detailed results. The clientOrderIdentifiers field was renamed clientOrderIdentifierList.
    > Added new values to SiteToken (V6 & V7): AMAZON_IT, AMAZON_WEBSTORE_IT, CHECKOUT_BY_AMAZON_IT

Shipping Service
    ~ Simplified the data contracts used by SubmitOrderShipmentList: removed OrderShipmentList and ShipmentContents and changed OrderShipment, PartialShipmentContents, and FullShipmentContents
    < Removed OrderShipped from Shipping Service

API V7
    < Removed Tax Service and Store Service from V7.

March 12, 2013

Update to V6: The March 2013 release includes additions to V6.

Order Service
    > Added new value to SiteToken: SHOP_DOT_COM

Inventory Service
    > Bug fix for all API versions - GetFilteredInventoryItemList now populates the following fields: ShortDescription, WarehouseLocation, TaxProductCode, BlockComment

September 5, 2012

Update to V6: The September 2012 release includes additions to V6.

Order Service
    > Added new values to SiteToken: GROUPON_GOODS, LA_REDOUTE, ONE_STOP_PLUS

July 10, 2012

Update to V6: The July 2012 release includes additions to V6.

Inventory Service
    > Added the ability to remove the Amazon FBA distribution center from an item in SynchInventoryItem and SynchInventoryItemList. This new ability applies to all versions of the API. See ShippingInfo_ for details.

Order Service
    > Added new values to SiteToken: AMAZON_CA, TRADEME, WALMART

Shipping Service
    ~ Improved error messaging in SubmitOrderShipmentList.

June 5, 2012

Update to V6: The June 2012 release includes additions to V6.

Order Service
    > Added the ability to change the requested shipping method of an order without changing the shipping status via UpdateOrderList. The new object type ShippingMethodInfoUpdateSubmit has been added to OrderUpdateSubmit to do this.
    > Added ItemSaleSourceTransactionID to OrderLineItemItemResponse.
    > Added a new value to SiteToken: BEST_BUY.

March 7, 2012

Update to V6: The March 2012 release includes additions to V6.

Order Service
    > Added new values to SiteToken: AMAZON_WEBSTORE_CA, AMAZON_WEBSTORE_DE, AMAZON_WEBSTORE_FR, AMAZON_WEBSTORE_UK, AMAZON_WEBSTORE_US, CHECKOUT_BY_AMAZON_CA, CHECKOUT_BY_AMAZON_DE, CHECKOUT_BY_AMAZON_FR, CHECKOUT_BY_AMAZON_UK, and CHECKOUT_BY_AMAZON_US. The new sites were added to V6 only.

Shipping Service
    ~ Shipment notifications submitted via SubmitOrderShipmentList and OrderShipped for orders that already have a ShippingStatusCode of Shipped will now update the existing shipments instead of returning an error. This applies to all versions of the API.

January 15, 2012

New version: The January 2012 release marks the introduction of a new version of the ChannelAdvisor API. V6 is accessible via a slightly different URL from previous versions.  All WSDL URLs in the documentation will be updated after the release to reflect the change.  The changes listed below only affect V6, unless otherwise specified.

All Services
    ~ Nearly all enumeration-type inputs and outputs have been replaced with string equivalents. Inputs and outputs are still required to conform to the published lists of valid values, but the data type is now string. This will allow us to add new values to existing enumerations in the future without changing the WSDL and thus requiring a new API version.

Order Service
    > Added new value to LineItemTypeCode: RecyclingFee.
    > Added a new element to LineItemInvoiceList with LineItemTypeCode of RecyclingFee for retrieval and submission of recycling fees at the order level in SubmitOrder and GetOrderList.
    > Added new value to SiteToken: EBAY_NL.

September 21, 2011

Update to V5: The September 2011 release includes an addition to OrderService in V5.

Order Service
    > Added RefundStatusFilter to OrderCriteria to filter orders by refund status in GetOrderList.

August 24, 2011

Update to V5: The August 2011 release includes additions to OrderService in V5.

Order Service
    > Added boolean IsFBA to OrderLineItemItem to indicate if an order line item is fulfilled by Amazon in GetOrderList.
    > Added string SellerOrderID to Order and OrderResponseItem for retrieval and submission in GetOrderList and SubmitOrder. SellerOrderID is a user-defined order identifier that already existed, but support for it is being expanded.
    > Added decimal RecyclingFee to OrderLineItemItem and RefundItem for retrieval and submission of recycling fees at the line item level in GetOrderList, SubmitOrder, SubmitOrderRefund, and GetOrderRefundHistory.
    > Added DateTime EstimatedShipDate and DeliveryDate to ShippingInfo and ShippingInfoUpdateSubmit for retrieval and submission in GetOrderList, SubmitOrder, and UpdateOrderList.

May 4, 2011

New version: The May 2011 release marks the introduction of a new version of the ChannelAdvisor API. V5 is accessible via a slightly different URL from previous versions.  All WSDL URLs in the documentation will be updated after the release to reflect the change.  The changes listed below only affect V5, unless otherwise specified.

Order Service
    > Added ClientOrderIdentifierList to OrderCriteria to support the retrieval of orders by ClientOrderIdentifier.
    > Added new values to SiteToken: SELL_ON_SEARS, NEWEGG, MAGENTO_ENTERPRISE, MAGENTO_GO, and AMAZON_WEBSTORE.
    > Added SearsMarketplace to CheckoutSourceType.
    > Added PendingShipment to ShippingStatusCode.
    > Added RegionDescription to AddressInfo to support full region names for UK shipping.
    > Expanded UpdateOrderList functionality. New objects include BillingInfoUpdateSubmit, ShippingInfoUpdateSubmit, and PaymentInfoUpdateSubmit. In OrderUpdateSubmit, added NewClientOrderIdentifier, BillingInfo, ShippingInfo, and PaymentInfo. In OrderUpdateResponse, added ShippingAndCOIDSuccess, ShippingAndCOIDMessage, BillingAndPaymentSuccess, and BillingAndPaymentMessage.
    > Added OrderMerge method.
    > Added OrderSplit method.

Shipping Service
    > Added GetOrderShipmentHistoryList method. New objects include OrderShipmentHistoryResponse, OrderShipmentResponse, and ShipmentLineItemResponse.

Admin Service
    ~ Improved the performance of GetAuthorizationList.

Cart Service
    ~ In ModifyCart, renamed lineItem to be lineItemList.

February 9, 2011

New version: The February 2011 release marks the introduction of a new version of the ChannelAdvisor API. V4 is accessible via a slightly different URL from previous versions.  All WSDL URLs in the documentation will be updated after the release to reflect the change.  The changes listed below only affect V4, unless otherwise specified.

Inventory Service
    > Added support for upsell relationships. New methods include AddUpsellRelationship - Deprecated, DeleteUpsellRelationship - Deprecated, and GetUpsellRelationship - Deprecated. New objects include InventoryUpsellChildInfo, InventoryUpsellInfoSubmit, and InventoryUpsellInfoResponse.
    > In SynchInventoryItem and SynchInventoryItemList, added the ability to delete individual inventory field data using defined constant values. This ability was added for all API versions. See the Notes section of InventoryItemSubmit for details.

Order Service
    < In OrderCriteria, got rid of "hidden" ExportStateSpecified field.
    > Added new value to ExportStateType enum, enabling GetOrderList to retrieve exported orders only, if desired.
    > In GetOrderList and SubmitOrder, added support for multiple item-level promotions per SKU-type line item. New objects include OrderLineItemItemPromo. Affected objects include OrderLineItemItem.
    > In UpdateOrderList, added support for overriding checkout status, payment status, and shipping status. New objects include OrderStatusUpdateSubmit. Affected objects include OrderUpdateSubmit.

Shipping Service
    ~ Modified SubmitOrderShipmentList to continue processing even after an error occurs and return a list of success/failure indicators along with an individual error message for each failure. New objects include ShipmentResponse.

November 10, 2010

New version: The November 2010 release marks the introduction of a new version of the ChannelAdvisor API. V3 is accessible via a slightly different URL from V1 and V2.  All WSDL URLs in the documentation will be updated after the release to reflect the change.  The changes listed below only affect V3, unless otherwise specified.

Inventory Service
    > Added new inventory fields: Manufacturer, Brand, Condition, Warranty, ProductMargin, SupplierPO, ReceivedInInventory, HarmonizedCode, Height, Length, and Width. Affected objects include InventoryItemSubmit and InventoryItemResponse.
    ~ Separated attributes list from classification to provide better support for attributes that are not specific to a class. Affected objects include InventoryItemSubmit and InventoryItemResponse.
    ~ Renamed ClassificationAttributeInfo class to be AttributeInfo.
    ~ Replaced ClassificationInfo class with Classification string. Affected objects include InventoryItemSubmit and InventoryItemResponse.
    ~ Renamed GetInventoryItemClassificationAttributeList method to be GetInventoryItemAttributeList.
    ~ Increased the maximum allowed number of items in UpdateInventoryItemQuantityAndPriceList from 500 to 1000.

Note: Fixed a defect that prevented MetaDescription from being set in SynchInventoryItem and SynchInventoryItemList.

Order Service
    > Added JoinDateFiltersWithOr and DistributionCenterCode to OrderCriteria.
    > Added DistributionCenterCode to GetOrderList response. Affected objects include OrderLineItemItem.
    ~ Fixed a typo in the RefundAdjustmentReason enum. AlternateItemProvied is now AlternateItemProvided.

Shipping Service
    ~ Improved error messaging for SubmitOrderShipmentList to indicate which shipment notification caused the failure. This affects all API versions.

August 11, 2010

New version: The August 2010 release marks the introduction of the first new version of the ChannelAdvisor API. V2 is accessible via a slightly different URL from V1.  All WSDL URLs in the documentation will be updated after the release to reflect the change. The changes listed below do not apply to V1 and will only be present in V2.

Shipping Service
    > Added Seller Fulfillment ID input to OrderShipped and SubmitOrderShipmentList. Affected objects include PartialShipmentContents and FullShipmentContents.

Order Service
    > Added Seller Refund ID input to SubmitOrderRefund. Affected objects include RefundItem.
    > Added Seller Refund ID output to GetOrderRefundHistory. Affected objects include OrderLineItemRefundHistoryResponse.
    > Added Flag Style, Flag Description, and Transaction Notes outputs to GetOrderList. Affected objects include OrderResponseItem.
    ~ In the GetOrderList response, OrderLineItemItem.LineItemID is now populated with the actual LineItemID.
    > Added UpdateOrderList method. New objects include OrderUpdateSubmit and TransactionNoteSubmit.
    > Added SetSellerOrderItemIDList method.
    > Added AMAZON_DE and AMAZON_FR to SiteToken.

Note: Miscellaneous error message improvements have also been made with this release.

May 19, 2010

Order Service
   ~ modified SubmitOrder, GetOrderList, SubmitOrderRefund, and GetOrderRefundHistory to support gift wrap.
   > added new fields to several objects in Order Service to support gift wrap.

March 24, 2010

Admin Service
   > added optional localID parameter to GetAuthorizationList method to limit results to a specific Authorization record.

February 20, 2010

Order Service
   > added OrderRefundStatus field to OrderStatus object at all GetOrderList detail levels.
   > added UserName field to OrderLineItemItem object at High and Complete GetOrderList detail levels.
   ~ modified SubmitOrderRefund to support line item partial refunds for all marketplaces except ChannelAdvisor Premium Stores and Yahoo! Stores.
   ~ modified SubmitOrderRefund to support restocking inventory with refunded line items for all marketplaces except Amazon, Buy.com and Pixmania.
   > added optional RestockQuantity field to RefundItem object.
   > added GetOrderRefundHistory method with associated request and response objects.

Listing Service
   > added Listing Service.
   > added WithdrawListings method.

January 13, 2010

Order Service
   > added BuyerIpAddress field to OrderResponseItem object at Complete detail level.
   > added new SiteToken enum value to OrderLineItemItem object for orders from Amazon 2.0.

August 15, 2009

Order Service
   ~ modified SubmitOrderRefund method to support Buy.com (US) Amazon UK, and Pixmania.

July 15, 2009

Order Service
   > added SubmitOrderRefund method to Order Service to allow developers to automate refunds to buyers.

March 21, 2009

Inventory Service
   > modified InventoryItemSubmit object to add support for ASIN, UPC, EAN, MPN and ISBN.
   > modified InventoryItemResponse object to add support for ASIN, UPC, EAN, MPN and ISBN.

February 14, 2009

Inventory Service
   > modified InventoryItemSubmit object to add support for Labels.
   > added AssignLabelListToInventoryItemList method.
   > added RemoveLabelListFromInventoryItemList method.

September 20, 2008

Inventory Service
   > added DoesSKUExistList method.
   > added UpdateInventoryItemQuantityAndPrice method.
   > added UpdateInventoryItemQuantityAndPriceList method.

April 26th, 2008

> Ability to retrieve only Orders that have not been exported.  This includes a new filter in the OrderCritieria called ExportState so users can call GetOrderList and request only orders that have not been exported as part of their filter critieria.  After the orders are processed by the client, a call to OrderService.setOrderExportStatus needs to be called to actually mark the order as exported.  (See sample)

> Retrieve an account's list of defined Classifcations and their attributes. function: InventoryService.GetClassificationConfigurationInformation

> Retrieve an item's shipping details if defined at the item level.   This does not apply to all the CA business logic of filtering up to the Global shipping level if no item level shipping is applied.  function: InventoryService.GetInventoryItemShippingInfo

> Bug fix - Invoices with 'Addl Cost/Discount' or BuyerOptInDiscount do not balance in API.  For OrderLineItemPromo there are two new types (LineItemTypes), AdditionalCostOrDiscount and BuyerOptInIncentive.  These will only appear for orders that have a value in these positions.  The previously existing type, Promotion will still appear whether there is a promo or not.

January 26th, 2008

> SynchInventoryItemList: Submit up to 100 inventory items per call

> OrderShipped() bug fix. ShippedDateGMT parameter was ignored and defaulted to today's date

> OrderService.SubmitAmazonFullRefund and OrderService.SubmitAmazonPartialRefund.

> InventoryService.SynchInventoryItem bug fix on item update.

October 13, 2007

Shipping Service
    > Added OrderShipped method.
    > Added GetShippingCarrierList method

Inventory Service
    > Added DeleteInventoryItem method
    > Added GetFilteredSkuList method
    > Added GetFilteredInventoryItemList
    > Bug Fix 10227: Error Sync-ing Item Inventory Store Info
    > Bug Fix 10274: Blocking An Item Does Not Work
    > Bug Fix 10353: Updating an Item was setting the CreateDate
    > Bug Fix 10489: Updating an Item was removing existing Flag
    > Bug Fix 10690: Unable to set Flag to Exclamation Point

Order Service
   > Bug Fix 10482: GetOrderList was failing on last page of multi-page responses.

Marketplace Ad Service
> Bug Fix 9928: Cannot Override Primary/Secondary Store Category

May 19, 2007

Marketplace Ad Service (Added)
    > Added AddMarketplaceAd method.

March 24, 2007

Inventory Service
    > Added GetInventoryItemList method.
    > Added GetInventoryItemQuantityInfo method.
    > Added GetInventoryItemClassificationAttributeList method.
    > Added GetInventoryItemStoreInfo method.
    > Added GetInventoryItemImageList method.
    > Added GetInventoryItemVariationInfo method.

Store Service
    > Added GetSearchAnalysisStats method.

January 17, 2007

Cart Service
    > GetCart added CheckoutURL field.
    > CreateCart added E-mail Address field.

Inventory Service
    > Added DoesSkuExist method.
    > Added SynchInventoryItem method.

October 14, 2006

The following services and requests were introduced in Version 1 of the ChannelAdvisor API:

Inventory Service
    > GetInventoryQuantity
    > GetInventoryQuantityList

Order Service
    > GetOrderList
    > SubmitOrder

Cart Service
    > GetCart
    > CreateCart
    > ModifyCart
    > DeleteCart

Shipping Service
    > GetShippingRateList

Tax Service
    > GetTaxRateList