This page contains information about changes to the ChannelAdvisor API over time. All changes will be noted here. The differences are noted with the following information:
"> note" = added in new version
note" = removed from new version, present in previous version
"~ note" = change in new version
Update to V7
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.
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.
> Extended SetOrdersExportStatus to accept an array of OrderID values and return an array of type SetExportStatusResponse to provide more detailed results
> Added new values to SiteToken (V6 & V7): AMAZON_IT, AMAZON_WEBSTORE_IT, CHECKOUT_BY_AMAZON_IT
~ Simplified the data contracts used by SubmitOrderShipmentList: removed OrderShipmentList and ShipmentContents and changed OrderShipment, PartialShipmentContents, and FullShipmentContents
< Removed OrderShipped from Shipping Service
Update to V6: The March 2013 release includes additions to V6.
Update to V6: The September 2012 release includes additions to V6.
Update to V6: The July 2012 release includes additions to V6.
> 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.
Update to V6: The June 2012 release includes additions to V6.
> 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.
Update to V6: The March 2012 release includes additions to V6.
> 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.
~ 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.
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.
~ 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.
> 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.
Update to V5: The September 2011 release includes an addition to OrderService in V5. There will not be a new version; we are simply updating V5.
Update to V5: The August 2011 release includes additions to OrderService in V5. There will not be a new version; we are simply updating V5.
> 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.
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.
> 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.
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.
> Added support for upsell relationships. New methods include AddUpsellRelationship, DeleteUpsellRelationship, and GetUpsellRelationship. 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.
< 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.
~ 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.
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.
> 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.
> 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.
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. V1 is scheduled to permanently go offline during the February 2011 release. The changes listed below do not apply to V1. The changes and additions will only be present in V2.
> 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.
> 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.
> 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.
>SynchInventoryItemList: Submit up to 100 inventory items per call: http://developer.channeladvisor.com/display/cadn/SynchInventoryItemList
>OrderShipped() bug fix. ShippedDateGMT parameter was ignored and defaulted to today's date: http://developer.channeladvisor.com/display/cadn/OrderShipped
>OrderService.SubmitAmazonFullRefund and OrderService.SubmitAmazonPartialRefund.
> InventoryService.SynchInventoryItem bug fix on item update. See Known Issues for details.
For Bug Fixes, refer to the Known Issues page for a more detailed explanation of the bug.
> Added OrderShipped method.
> Added GetShippingCarrierList method
> 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
> This is now fixed. This fix has been removed from the release. It will be re-released later this month. 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
> Added GetInventoryItemList method.
> Added GetInventoryItemQuantityInfo method.
> Added GetInventoryItemClassificationAttributeList method.
> Added GetInventoryItemStoreInfo method.
> Added GetInventoryItemImageList method.
> Added GetInventoryItemVariationInfo method.
The following services and requests were introduced in Version 1 of the APIs in ChannelAdvisor's Developer Program: