Order Book API Changelog

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

• Location.location_category now rejects blank values when provided. The field remains optional (nullable).

• Added documentation note about dash-splitting behavior upon exporting and re-importing the order set in PTV OptiFlow Route Optimization to the following fields: OrderInformation.lifo_groups, TransportInformation.labels, OrderRequirements.tags, OrderRequirements.forbidden_tags, Location.labels, VisitLocation.labels.

• Order tags, forbidden_tags, and lifo_groups now enforce a maximum length of 200 characters per element.

• Order labels, tags, forbidden_tags, lifo_groups, and custom_data now enforce a maximum size of 100 entries.

• Order labels now enforce a maximum length of 200 characters and must not be blank.

• Added labels to VisitLocation request and response schema.

• updated Order labels description to mention Plan profiles instead

• Added labels to Location.

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

• Added optional type to time_frame. When omitted, defaults to SERVICE_ARRIVAL.

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

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

• 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.

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

• paginated find all endpoint for PreplannedPartialRoute

• paginated find all endpoint for Order

• clarify precondition for Location DELETE

• specify which entities can be used by categories

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

• rename security scheme
• clarify color property on Orders
• clarify mandatory property on Orders

• rename security scheme

• rename security scheme

• Documented ID format constraints

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

• 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

• 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

• 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

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

• Add Preplanned PartialRoutes GET endpoint
• Add Preplanned PartialRoutes DELETE endpoint
• Add routeGroup to PartialRoutes

• Add Preplanned PartialRoutes GET endpoint
• Add Preplanned PartialRoutes DELETE endpoint

• Add Preplanned PartialRoutes GET endpoint

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

• Add Preplanned PartialRoutes endpoint
• Allow empty capacities

• Add Preplanned PartialRoutes endpoint

• Add Preplanned PartialRoutes endpoint

• Added PlanGroup to orders

• 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

• 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

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

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

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

• Restored visibility of categories
• Explain Category schemas

• Restored visibility of categories

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

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

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

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

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

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

• Add endpoints for Orders without a TransportRequest

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

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

• Added endpoint for unplannable orders

• Capacity should be greater than or equal to 0

• 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

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

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

• Remove bulk upsert for TransportRequest
• Remove bulk upsert for Location

• Remove plangroup
• Remove sub_orders
• location_category, transport_category and order_category are optional
• Remove time_window_type

• Remove CustomDataDefinition
• Remove unused HTTP/410 response
• Remove unused components

• 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

• 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

• 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

• 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

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

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