> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salesive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Versioning

> Ask for a dated API version with the X-Salesive-Api-Version header so a breaking change never reaches your app until you choose it.

## Versions

The Apps API is versioned by month, in the form `YYYY-MM`. A new version ships only when there is a
breaking change. Additive changes, such as a new field or a new endpoint, reach every version
without one.

| Version | Status |
| - | - |
| `2026-11` | Stable, current |

## Ask for a version

Send the version you built against on every call:

```bash theme={null}
curl https://api.salesive.com/api/v1/orders \
  -H "Authorization: Bearer app_<your-app-access-token>" \
  -H "X-Salesive-Api-Version: 2026-11"
```

Every response tells you which version answered it:

```http theme={null}
X-Salesive-Api-Version: 2026-11
```

* **No header:** you get the **oldest supported** version. That keeps an app that never sends the
  header working, but it will move when that version is retired, so send the header.
* **A supported version:** you get it as is.
* **A retired version:** you get the oldest supported version instead. Compare the response
  header with what you asked for to notice.
* **A malformed or unknown version:** `400`, with the versions you can use:

```json theme={null}
{
  "status": 400,
  "success": false,
  "message": "API version 2099-01 does not exist.",
  "data": { "supportedVersions": ["2026-11"] }
}
```

## Deprecation

When a version starts winding down, responses served with it carry standard headers:

```http theme={null}
Deprecation: @1798761600
Sunset: Sat, 01 May 2027 00:00:00 GMT
Link: <https://docs.salesive.com/apps-api/versioning>; rel="deprecation"
```

`Deprecation` is when it was deprecated, `Sunset` when it stops being served. Log these headers
and move to a newer version before the sunset date.

## Webhooks

Webhook deliveries carry ids only, never record fields, so they are the same in every version.
The record you fetch after a webhook is shaped by the version you send on that fetch.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.