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.

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 changes history inside the changes object which shows, for each modified attribute, the values before and after the change. Changes to non-fetchable attributes (i.e. that are not exposed to the user in the single resource object) are tracked anyway by the versions API but you won't be able to see the modified values.

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

• Exports

• Imports

• Line items

• Line item options

• Order copies

• Order factories

• Order subscription items

• Organization

• Recurring order copies

• Return line items

• Stock reservations

• Subscription models

• Tags

• All geocoder types:

  • Bing geocoders

  • Google geocoders

Version history storage

The length of time that the versions API holds your resources' changes history depends on the way the change is triggered:

• Changes made via imports to other resources (e.g. updating prices, SKUs, stock items using imports, etc.) are stored for 1 month.

• Any other changes (e.g. triggered by direct API calls on any resource) are stored for 1 year.

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 specific single one.