Migration Guide

Migrate from 2024-07 to 2024-10

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

• Added new optional field order.custom_fields, no action required if this field is not utilized.

• Added new optional field order.status_timestamps, no action required if this field is not utilized.

Order Response

• Added new fields order.custom_fields and order.status_timestamps, please make sure the response is parsed properly, and update your response validator if needed.

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.