> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/api/introduction/field-deprecation-and-removal-policy.md).

# 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.<br>

#### 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

1. Deprecate the field → Add description & planned removal date → Set as OPTIONAL.
2. Log the change in the Deprecation Log + Changelog (DEPRECATED).
3. Notify all API consumers → Adjust timeline if needed.
4. Remove the field → Update Deprecation Log + Changelog (REMOVED).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.flowretail.com/api/introduction/field-deprecation-and-removal-policy.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.