Migrate from 2024-04 to 2024-07

This migration guide outlines the essential changes required to maintain the same functionality when transitioning from the previous API version. It does not cover any new resources or endpoints.

For comprehensive details on new features, please refer to the Changelog for a complete overview of all API updates.

Order Requests

• order.delivery_method is now required, please make sure to include this field.
• Remove these fields:
  • order.shipments
  • order.shipping_address.tax_number
  • order.shipping_address.source_id
  • order.shipping_address.description
  • order.billing_address.tax_number
  • order.billing_address.source_id
  • order.billing_address.description
• Rename order.shipping_address.address_line_1 to order.shipping_address.street_1
• Rename order.shipping_address.address_line_2 to order.shipping_address.street_2
• Rename order.shipping_address.address_line_3 to order.shipping_address.street_3
• Rename order.shipping_address.address_line_1 to order.billing_address.street_1
• Rename order.shipping_address.address_line_2 to order.billing_address.street_2
• Rename order.shipping_address.address_line_3 to order.billing_address.street_3
• Rename order.items.*.title to order.items.*.product_variant_title
• Update order.items.*.unit_price from a number to {"currency": "{currency}", "amount": "{value}"}
• Prevent from using an existing Order ID (order.id) when creating an order

Fulfillment Request

For order requests that previously included the order.shipments field, please note that this field has been deprecated and replaced by a new fulfillment resource. To create a new fulfillment request, follow this mapping table:

Field in Order	Field in Fulfillment	Description	Sample
-	source_id	The original fulfillment ID in your system.	321324145553321
id	order_id	The ID of the order resource	30a68a3a715247caac19eb3302bfe6da
-	type	Fulfillment type, please use shipping for all typical non-BOPIS cases	shipping
-	status	Fulfillment status.	pending
-	line_items	Items to be fulfilled	-
-	ship_from_location	Ship from location detail, please refer to the API reference for the detailed format.	-
-	ship_from_location	Ship to location detail, please refer to the API reference for the detailed format.	-
shipments	trackings	Shipment information	-

Sample Fulfillment Request

Please also refer to the API reference for the detailed specification, and also common scenario pages for the specific use case samples.

preparing...

Store Requests

• Remove store.plan_name
• Rename store.address.address_line_1 to store.address.street_1
• Rename store.address.address_line_2 to store.address.street_2
• Rename store.address.address_line_3 to store.address.street_3
• Update store.address.latitude to store.address.coordinate.latitude
• Update store.address.longitude to store.address.coordinate.longitude

Migrate from legacy API to Versioned API

For all legacy API user (with the API URL https://api.aftership.com/commerce/v1), please visit 2024-04 migration guide for the detail instruction.