> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/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/docs/developers/field-deprecation-and-removal-policy.md). # Field deprecation & removal policy How we retire a field, and how much notice you get. Fields are occasionally removed — because they are no longer used, or because they have moved to another entity. This is the process we follow so that it never surprises you. ## 1. Deprecation notice Before a field is removed we: * Mark it **deprecated** in the OpenAPI specification. * Write a description saying why, and where the value lives now if it moved. * Set a planned removal date — normally **three months** out, sometimes longer or shorter depending on impact. * Mark it **optional** in the response schema, so a client that requires it starts failing loudly while there is still time to fix it. ## 2. Documentation and changelog Every deprecation is recorded in the deprecation log and in the API changelog under the `DEPRECATED` tag. When the field is finally removed, the log is updated and a `REMOVED` entry is added. ## 3. Telling you about it We notify registered integration partners and client development teams directly, with the reason and the planned removal date. If that timeline does not work for your integration, tell us. Adjusting it is usually easier than you think, and much easier than an integration breaking in production. ## 4. In short 1. Mark deprecated, document why and when, make it optional. 2. Log it under `DEPRECATED`. 3. Notify integrators, and adjust the date if someone needs longer. 4. Remove it, and log it under `REMOVED`. The specification at `https://api.flowretail.com/v2/spec` always reflects what is actually deployed, so a field still present there is still safe to read today. --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.flowretail.com/docs/developers/field-deprecation-and-removal-policy.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.