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

> ## Agent Instructions
> If you're integrating Kardinal into an application with an SDK, start with Integration paths: https://developers.kardinal.ai/getting-started/integration-paths.md. It lists the sections to read, in order. If you follow Integration paths, you don't need llms-full.txt or openapi.yaml. Each step links the section you need.

# Changelog

> Version history of Kardinal's Route Optimization API: what changed in each release, including new behavior, changed responses, and fields you need to update.

This changelog covers the Route Optimization API itself. The SDKs have their own: see the [Python SDK changelog](https://developers.kardinal.ai/sdks/python/changelog.md) and the [TypeScript SDK changelog](https://developers.kardinal.ai/sdks/typescript/changelog.md).

**Docs fix**

Released on 2026-11-03. The LIFO rule sets its order in strategy

* The API did not change.
* A `removalStrategy` constraint takes its unloading order in the `strategy` field. The reference called this field `removalStrategy` until this fix.
* The API ignores a field it doesn't know. A constraint written with `"removalStrategy": "lifo"` was still accepted, and it applied `lifo`, because `lifo` is the default. Rename the field to `strategy` in your payloads anyway, so that the order you set is the one the API reads.
* A `RemovalStrategyViolation` returns the order in `strategy` too. The reference called it `removalStrategyType`. See [Last in, first out](https://developers.kardinal.ai/guides/capacities.md#last-in-first-out).

**API update**

Released on 2026-10-20. A cost cap needs a maximum, and a tag that matches no resource raises a warning

* A `maxCumulatedCost` entry in `globalConstraints` without `maximum` is now rejected with a `400` `INVALID_VALUE` error. Before, the API accepted it and stored a `maximum` of 0, so the cap allowed no counted cost at all. Add `maximum` to any such entry before you send the plan again.
* A tag in the `costsByResourceTag` of a `maxCumulatedCost` entry that no resource of the plan carries now raises a warning in the response. The plan is still accepted, and the tag still counts nothing.
* See [Capping a fleet-wide cost with `maxCumulatedCost`](https://developers.kardinal.ai/guides/cost-modeling#capping-a-fleet-wide-cost-with-maxcumulatedcost).

**Docs fix**

Released on 2026-10-19. Truck dimensions are in centimetres

* The API did not change.
* `height`, `width`, and `length` of a `truck` profile have always been whole numbers of centimetres. The reference said metres until this fix.
* A whole number in metres, such as `length: 12`, is accepted with no error and read as 12 centimetres. Check any truck profile that you wrote from the old reference. See [Data model](https://developers.kardinal.ai/reference/data-model.md#vehicle-profiles).

**API update**

Released on 2026-10-07. A cost whose base is 0 no longer charges constantCost

* A cost whose base is 0 on a tour is now 0. Before, a resource that was used paid the `constantCost` of that cost even then.
* This affects `costsByStopTag` on a tour that visits no stop with the tag, and `costsByCapacity` on a tour that handles none of that capacity. The same rule holds for every cost built from `constantCost`, `costCoeff`, and `overcostCoeff`.
* Two cases never paid and still do not: a resource that is not used, and a tag that no stop of the plan carries.
* If a minimum must hold on every tour, put it in `using`, because `using` is charged once for every resource that is used. See [Piecewise-linear cost functions](https://developers.kardinal.ai/guides/cost-modeling.md#piecewise-linear-cost-functions) and [Guaranteeing a minimum per-tour revenue](https://developers.kardinal.ai/guides/cost-modeling.md#guaranteeing-a-minimum-per-tour-revenue-via-costsbycapacity).

**v1.0.1**

Released on 2026-09-16. Plan listing pagination, running-endpoint response, and payload warnings

* `GET /plans` (light representation) is now always paginated — previously, no paging was applied unless `page` or `itemsPerPage` was explicitly set.
* `PUT /plans/{planId}/running` now returns an `EnvelopedPlanReference` body instead of an empty response.
* The light plan representation gains the same metadata fields as the full `Plan` object: `state`, `nbResources`, `nbOrders`, `createdAt`, `createdBy`, `updatedAt`, `updatedBy`, `archivedAt`.
* Several plan and paging fields that were `nullable` now use field absence instead — check for the field's presence rather than for a `null` value.
* New `Warning` concept: non-blocking amendments applied to an accepted payload (traffic turned off, crow-fly forced, `maxOptimizationDuration` clamped, and so on) are now surfaced on five response envelopes instead of silently applied.

**v1.0.0**

Released on 2026-08-07. Initial release

First public release of the Kardinal Route Optimization API.


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