Versions

The version object and the allowed CRUD operations on the related resource endpoint

Versions are associated with almost all the resources and are created upon every update or cancellation of the related resource to help you track the history of each resource's data changes. Resource creation is not tracked by the versions API.

Versions are no longer stored as of August 2025. Older versions are still fetchable, but please note that this endpoint will be deprecated soon. Start using event stores to get the same information you got from versions, and more. If you're an enterprise customer, you can also connect to our event stream hub and consume updates as they happen (no polling required).

Each version object contains information about the event that generated it (one of update or destroy), the type of resource that has been modified/deleted, the request involved, the application, worker or user that triggered the change, and more. You can find the change history inside the changes object which shows, for each modified attribute, the values before and after the change.

Changes to the order resource are tracked only if the order status is different from draft or pending. The first version is created starting from the change of status that moves the order to placed (status change included).

Non-versionable resources

At the moment, these are the resources that doesn't support versioning:

• Application

• Attachments

• Customers

• Customer password resets

• Events

• Event callbacks

• Imports

• Line items

• Line item options

• Links

• Order copies

• Order factories

• Order subscription items

• Organization

• Recurring order copies

• Return line items

• Stock reservations

• Subscription models

• Tags

• All pickups types:

  • EasyPost pickups

• All geocoder types:

  • Bing geocoders

  • Google geocoders

Version history storage

Changes triggered by direct API calls on any resource are stored for 1 year.

Changes made via imports to other resources (e.g. updating prices, SKUs, stock items using imports, etc.) are not versioned at the moment. They are included in the recently released event stream (enterprise only). Non-enterprise customers can track those changes by fetching the event stores of each single resource.

This is an immutable API, meaning that create, update, and delete operations are not allowed on this endpoint. You can only fetch a list of versions or a single version object.