Planning API Changelog

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

v1.8.0

• Removed location_id from ChargingLocation
• Removed business_id from ChargingStation

v1.7.0

• Added endpoints for managing charging location sets
• Introduced consistent validation pattern for business_id parameters across all endpoints

v1.6.3

• For location workload levelling set - mark business_id as read-only
• For break rules - align response headers, status codes and request bodies with our API guidelines + document validation rules
  • As this API is marked as EXPERIMENTAL we did not consider this a breaking change

v1.6.2

• Rename cursor to cursors for the list endpoint of break rule sets and depot sets
  • As these APIs are marked as EXPERIMENTAL we did not consider this a breaking change

v1.6.1

• Only expose next cursor for break rule sets and depot sets
  • As these APIs are marked as EXPERIMENTAL we did not consider this a breaking change

v1.6.0

• Added endpoints for managing break rule sets

v1.5.0

• Added endpoints for managing depot sets

v1.4.1

• Add Location header when creating a new location workload levelling set

v1.4.0

• Added endpoints for managing order-order restriction sets

v1.3.0

• Added endpoint for retrieving location workload levelling sets:
  • GET /planning/v1/settings/location-workload-levelling-sets

v1.2.1

• rename security scheme

v1.2.0

• Added endpoints for managing location workload levelling sets:
  • GET /planning/v1/settings/location-workload-levelling-sets/{business_id}
  • PUT /planning/v1/settings/location-workload-levelling-sets/{business_id}
  • DELETE /planning/v1/settings/location-workload-levelling-sets/{business_id}

v1.1.0

• GET /planning/v1/plannings now also shows the planning name and planning labels.
• The following endpoints are marked for removal on 30/06/2025. More information on how to migrate can be found here.
  • GET /planning/v0/releases
  • GET /planning/v0/plannings/{id}/releases/latest

v1.0.0

• The following endpoints are marked for removal on 30/06/2025. More information on how to migrate can be found here.
  • GET /planning/v0/releases
  • GET /planning/v0/plannings/{id}/releases/latest
• The following v0 endpoints will remain supported for now, even after 30/06/2025, until further notice:
  • GET /planning/v0/ping > Will be kept for convenience as long as there are v0 endpoints available.
  • GET /planning/v0/plannings/{id}/export > No alternative in v1. No excel export will be created in v1 and onwards. These will be replaced with alternative endpoints in the future that will fulfill the same needs.
  • GET /planning/v0/plannings > Although this endpoint will still be available until further notice, we strongly suggest you already migrate to the newer GET /planning/v1/plannings. Please contact us, if the newer endpoint does not fulfill your needs.
• Upgraded some endpoints from v0 to v1:
  • GET /planning/v0/ping has been superseded by GET /planning/v1/ping. No changes were made to the API contract.
  • GET /planning/v0/plannings has been superseded by GET /planning/v1/plannings. Note that the response body has been changed significantly from the v0 endpoint.
  • GET /planning/v0/releases has been deprecated in favor of GET /planning/v1/plannings?released_since={date-time}. The response body contains small changes compared to the v0 endpoint.
  • GET /planning/v0/plannings/{id}/releases/latest has been deprecated in favor of GET /planning/v1/plannings/{id}/releases/latest. This introduces the concept of routes with multiple trips. Note that this changes the response body of the endpoint significantly compared to the v0 endpoint.