Migrating from Accountshipping to Shippingsettings

This guide covers changes between the use of the Accountshipping service and the use of the Shippingsettings service. The Accountshipping service will be turned off on March 1, 2017, so please migrate well in advance so we may help you with any issues that might arise.

Method changes

  • Shippingsettings contains a new method, getsupportedcarriers, which retrieves the supported carriers and carrier services for the given account.

Resource changes

  • Shipping labels are no longer used to make decisions within the cost rule tree, but instead determine which rateGroup is used for a given service.
  • Instead of describing shipping rate decisions via a cost rule tree, shipping rate decisions are now described in tables of shipping rates. Table-based rateGroups have one mainTable and a set of auxilliary subtables. Each table is either one- or two-dimensional, and to subdivide among more dimensions, a main table entry can reference a subtable via the subtableName field.
  • Carrier rates are no longer specified at the top-level of the resource, but instead are specified within particular rateGroups. Entries within a rate group can only refer to carrier rates within the same rate group.
  • The top-level locationGroups field has been replaced with the top-level postalCodeGroups field. This means it is no longer possible to name a set of location ids, only postal codes. Location ids can still be used as a method for determining shipping rates, but they must now appear directly within the appropriate row or column headers.
  • Each service must include the currency field, which contains the currency to which the shipping service applies. This currency must match the currency used for prices within the service's rate groups.

Also see the Account-level Tax and Shipping guide for examples of the new Shippingsettings resource.

Converting existing shipping rules

If you are an existing Accountshipping client, you can retrieve your current settings as a Shippingsettings resource by using the Shippingsettings.get method. The resulting resource will help you see how your existing tree-based shipping rules can be expressed in the new table-based format.

Send feedback about...

Content API for Shopping