# Order Book API Changelog

This changelog contains version history extracted from the Order Book API specifications.

## Version 1.11.1

* updated `Order` `labels` description to mention `Plan profiles` instead


## Version 1.11.0

* Added `labels` to `Location`.


## Version 1.10.1

* Added optional `description` to `capacity`.
* Added optional `ignore_consecutive_restrictions` to `Location`
* Added `client` to `Order` in `TransportRequest`
* Added `version` to `TransportRequest`


## Version 1.10.0

* Added optional `type` to time_frame. When omitted, defaults to SERVICE_ARRIVAL.


## Version 1.9.1

* Documented upper bounds for `max_time_in_vehicle`: `max_time` must be at most 1 day (PT24H), `penalty` must be at most 10000.


## Version 1.9.0

* Added optional `max_time_in_vehicle` to order information, constraining how long an order's cargo may remain on a vehicle.


## Version 1.8.2

* Added correct examples for PUT's of pickups, deliveries and pickup deliveries.
Previous examples were built by combining the examples of each property, but this ignored rules such as visitLocation and siteLocation being exclusive.


## Version 1.8.1

* `Order.service_time` should not be negative
Added validation and API clarification for this pre-existing constraint.


## Version 1.8.0

* paginated find all endpoint for `PreplannedPartialRoute`


## Version 1.7.0

* paginated find all endpoint for `Order`


## Version 1.6.1

* clarify precondition for `Location` DELETE


## Version 1.6.0

* specify which entities can be used by categories


## Version 1.5.2

* rename security scheme
* clarify `color` property on Orders
* clarify `mandatory` property on Orders
* fix location_category parameter name


## Version 1.5.1

* rename security scheme
* clarify `color` property on Orders
* clarify `mandatory` property on Orders


## Version 1.5.0

* rename security scheme


## Version 1.4.9

* rename security scheme


## Version 1.4.8

* Documented ID format constraints


## Version 1.4.7

* changed example url to use /orderbook path prefix instead of /masterdata


## Version 1.4.6

* Add Preplanned `PartialRoutes` GET endpoint
* Add Preplanned `PartialRoutes` DELETE endpoint
* Add `routeGroup` to `PartialRoutes`
* Remove default [] for `windows` in `TimeWindows` to enable sample
* Remove default [] for `pickups` & `deliveries` in `Stops` to enable sample
* Remove description from delivery
* Rename `route_group` to `same_route_group`


## Version 1.4.5

* Add Preplanned `PartialRoutes` GET endpoint
* Add Preplanned `PartialRoutes` DELETE endpoint
* Add `routeGroup` to `PartialRoutes`
* Remove default [] for `windows` in `TimeWindows` to enable sample
* Remove default [] for `pickups` & `deliveries` in `Stops` to enable sample
* Remove description from delivery


## Version 1.4.4

* Add Preplanned `PartialRoutes` GET endpoint
* Add Preplanned `PartialRoutes` DELETE endpoint
* Add `routeGroup` to `PartialRoutes`
* Remove default [] for `windows` in `TimeWindows` to enable sample
* Remove default [] for `pickups` & `deliveries` in `Stops` to enable sample


## Version 1.4.3

* Add Preplanned `PartialRoutes` GET endpoint
* Add Preplanned `PartialRoutes` DELETE endpoint
* Add `routeGroup` to `PartialRoutes`
* Remove default [] for `windows` in `TimeWindows` to enable sample


## Version 1.4.2

* Add Preplanned `PartialRoutes` GET endpoint
* Add Preplanned `PartialRoutes` DELETE endpoint
* Add `routeGroup` to `PartialRoutes`


## Version 1.4.1

* Add Preplanned `PartialRoutes` GET endpoint
* Add Preplanned `PartialRoutes` DELETE endpoint


## Version 1.4.0

* Add Preplanned `PartialRoutes` GET endpoint


## Version 1.3.3

* Add Preplanned `PartialRoutes` endpoint
* Allow empty capacities
* Add empty array as default value for arrays


## Version 1.3.2

* Add Preplanned `PartialRoutes` endpoint
* Allow empty capacities


## Version 1.3.1

* Add Preplanned `PartialRoutes` endpoint


## Version 1.3.0

* Add Preplanned `PartialRoutes` endpoint


## Version 1.2.11

* Added PlanGroup to orders


## Version 1.2.10

* Restored visibility of categories
* Explain Category schemas
* Clarify custom data
* Clarify custom data hierarchy
* Clarify TransportRequest-related Order endpoints
* Add business constraint for Location deletion


## Version 1.2.9

* Restored visibility of categories
* Explain Category schemas
* Clarify custom data
* Clarify custom data hierarchy
* Clarify TransportRequest-related Order endpoints
* Add business constraint for Location deletion


## Version 1.2.8

* Restored visibility of categories
* Explain Category schemas
* Clarify custom data
* Clarify custom data hierarchy
* Clarify TransportRequest-related Order endpoints


## Version 1.2.7

* Restored visibility of categories
* Explain Category schemas
* Clarify custom data
* Clarify custom data hierarchy


## Version 1.2.6

* Restored visibility of categories
* Explain Category schemas
* Clarify custom data


## Version 1.2.5

* Restored visibility of categories
* Explain Category schemas


## Version 1.2.4

* Restored visibility of categories


## Version 1.2.3

* add Cost to TimeFrame on orders
* remove [EXPERIMENTAL] from order endpoints
* Clarify Order stopTime strategies
* Extend API documentation


## Version 1.2.2

* add Cost to TimeFrame on orders
* remove [EXPERIMENTAL] from order endpoints
* Clarify Order stopTime strategies


## Version 1.2.1

* add Cost to TimeFrame on orders
* remove [EXPERIMENTAL] from order endpoints


## Version 1.2.0

* add Cost to TimeFrame on orders
* remove [EXPERIMENTAL] from order endpoints


## Version 1.1.2

* Add endpoints for `Orders` without a `TransportRequest`
* Fix: remove `business_id` from request for individual Order upserts
* introduce specific `ServiceTime` iso duration type


## Version 1.1.1

* Add endpoints for `Orders` without a `TransportRequest`
* Fix: remove `business_id` from request for individual Order upserts


## Version 1.1.0

* Add endpoints for `Orders` without a `TransportRequest`


## Version 1.0.0

* Release version `1.0.0`
* Introduce and clarify **Experimental** API endpoints
* `DELETE /locations/{business_id}`
* `ANY /categories/{entity}`
* `ANY /categories/{entity}/{code}`


## Version 0.27.1

* Updated description for unplannable_reasons in Consolidated Orders to make the inherent character more explicit


## Version 0.27.0

* Added endpoint for unplannable orders


## Version 0.26.4

* Capacity should be greater than or equal to 0


## Version 0.26.3

* Remove bulk upsert for `TransportRequest`
* Remove bulk upsert for `Location`
* Order sequence should be strictly positive
* Add `X-Conundra-Unwrap` header
* Remove Fence support from security schemes


## Version 0.26.2

* Remove bulk upsert for `TransportRequest`
* Remove bulk upsert for `Location`
* Order sequence should be strictly positive
* Add `X-Conundra-Unwrap` header


## Version 0.26.1

* Remove bulk upsert for `TransportRequest`
* Remove bulk upsert for `Location`
* Order sequence should be strictly positive


## Version 0.26.0

* Remove bulk upsert for `TransportRequest`
* Remove bulk upsert for `Location`


## Version 0.25.0

* Remove `plangroup`
* Remove `sub_orders`
* `location_category`, `transport_category` and `order_category` are optional
* Remove `time_window_type`


## Version 0.24.0

* Remove `CustomDataDefinition`
* Remove unused HTTP/410 response
* Remove unused components


## Version 0.23.2

* Restrict `Capacity` types to fixed set of values
* Update Authentication
* Clarify allowed language codes in `MultiLanguages`
* Extract `ConditionsCategory` from `Conditional` conditions.
* Fix authentication documentation
* Clarify the usage of `site_location` and `visit_location`
* Update security schemes
* Add location header for `Company` upsert
* Distinguish `id` from `business_id`


## Version 0.23.1

* Restrict `Capacity` types to fixed set of values
* Update Authentication
* Clarify allowed language codes in `MultiLanguages`
* Extract `ConditionsCategory` from `Conditional` conditions.
* Fix authentication documentation
* Clarify the usage of `site_location` and `visit_location`
* Update security schemes
* Add location header for `Company` upsert


## Version 0.23.0

* Restrict `Capacity` types to fixed set of values
* Update Authentication
* Clarify allowed language codes in `MultiLanguages`
* Extract `ConditionsCategory` from `Conditional` conditions.
* Fix authentication documentation
* Clarify the usage of `site_location` and `visit_location`
* Update security schemes


## Version 0.22.1

* Restrict `Capacity` types to fixed set of values
* Update Authentication
* Clarify allowed language codes in `MultiLanguages`
* Extract `ConditionsCategory` from `Conditional` conditions.
* Fix authentication documentation
* Clarify the usage of `site_location` and `visit_location`


## Version 0.22.0

* Add `CustomData` to `TransportInformation` *(i.e. pickup and delivery)*.


## Version 0.21.2

* Rename `penalty_cost` to `outsourcing_cost`
* Add `VisitLocation` scheme (`GeoAddress` with name)
* Fix small spelling mistakes
* Migrate to Redocly