Field Deprecation & Removal Policy
Occasionally, fields in the Flow Retail API may be removed because they are no longer used or have been moved to another entity.
To give you time to adapt and ensure smooth integrations, we follow the process below.
1. Deprecation Notice
Before a field is removed, we will:
Mark the field as “Deprecated” in the API specification.
Provide a description explaining:
Why the field is deprecated.
Where it has been moved (if applicable), or why it is being removed.
Set a planned removal date:
Normally 3 months from the deprecation date.
This may be shorter or longer depending on the severity and impact of the change.
Mark the field as OPTIONAL in the response schema.
This means that the field may be missing after the removal date.
2. Documentation & Changelog
All deprecations are recorded in:
The Deprecation Log (this documentation).
The API Changelog under the DEPRECATED tag.
When the field is removed, we will:
Update the Deprecation Log to mark it as removed.
Add an entry in the API Changelog under the REMOVED tag.
3. Communication with API Consumers
When a field is deprecated:
We will notify all registered client development teams and integrators.
You will receive:
The reason for the change.
The planned removal date.
If the proposed timeline is not feasible for your integration, contact us so we can discuss possible adjustments.
4. Summary
Deprecate the field → Add description & planned removal date → Set as OPTIONAL.
Log the change in the Deprecation Log + Changelog (DEPRECATED).
Notify all API consumers → Adjust timeline if needed.
Remove the field → Update Deprecation Log + Changelog (REMOVED).
Last updated