Versioning Master Data
Most Item-related entities provide a revision
property. This property can be set by integrations to ensure sequential changes are processed in the correct order.
Note: The
revision
property is not required; input APIs will set it if not provided.
It will always be set to the epoch timestamp when the input was received.
The revision
property is a long
or Int64
(numeric) value for each entity version. This allows you to determine if an input is older than an already processed input for the same entity.
How to Use revision
Provide a
revision
only if your integration may send updates for the same entity so close in time that network latency could cause requests to arrive out of order.
The value must be greater than the previous value and set by a trusted part of your system.
Recommended: Set it to a UNIX epoch timestamp in milliseconds.
For Price Specifications, it is required to use a UNIX epoch timestamp with millisecond precision!
You may use any numeric value (e.g., auto-incremented primary key or <previous-value>+1
) as long as it always increases reliably.
This ensures trustworthy versioning, regardless of database cleanups or counter resets.
Network latency is always a factor; use the revision
property if your integration is prone to this issue.