HomeGuidesAPI ReferenceChangelog
Terms of Use
Changelog
Terms of Use
Back to All

3.273.0 release notes

about 2 hours ago by ReadMe API
  1. ⚠️ Breaking changes
    1. Changed physicalReference validation on POST /public-api/resources/charge-points/v2.0/{chargePoint}/evses, PATCH /public-api/resources/charge-points/v2.0/{chargePoint}/evses/{evse}, POST /public-api/resources/evses/v2.1, and PATCH /public-api/resources/evses/v2.1/{evse} to allow at most 30 characters, limited to ASCII letters, digits, *, -, _, ., and :. Existing references can still be submitted unchanged when updating an EVSE.
    2. Changed idTagUid validation on POST /public-api/resources/id-tags/v2.0 and PATCH /public-api/resources/id-tags/v2.0/{idTag} to accept only ASCII letters, digits, -, _, :, *, @, and . when creating or changing a tag UID. Existing UIDs remain valid when submitted unchanged.
    3. Changed integrationId validation on POST /public-api/resources/flexibility-assets/v1.0 and PATCH /public-api/resources/flexibility-assets/v1.0/{flexibilityAsset} to reject grid-aware charging integrations, which must be managed through the admin panel.
    4. Changed endDate updates on PATCH and PUT /public-api/resources/partner-contracts/v1.0/{partnerContract}: changing the end date of an ended contract now returns 409 Conflict; an offboarding contract cannot have its end date cleared or changed to a past date. Partial updates that omit endDate, and submissions that retain the existing date, remain supported.
    5. Changed charge point status updates on PATCH /public-api/resources/charge-points/v1.0/{chargePoint} and PATCH /public-api/resources/charge-points/v2.0/{chargePoint} to prevent partner- and sub-operator-scoped tokens from changing a charge point disabled by a partner contract to a non-disabled status. The v2.0 endpoint returns 409 Conflict for this restriction.
    6. Changed POST /public-api/actions/session/v1.0/{session}/retry-payment to return 409 Conflict while a payment transaction is still processing, preventing overlapping payment attempts.
  2. ✨ New features
    1. Added partner category management through GET and POST /public-api/resources/partner-categories/v1.0, and GET, PATCH, and DELETE /public-api/resources/partner-categories/v1.0/{partnerCategory}. Categories support translated names; deleting a category that is still in use returns 409 Conflict.
    2. Added optional categoryId to partner creation and update requests on POST /public-api/resources/partners/v2.0 and PATCH /public-api/resources/partners/v2.0/{partner}. Added it to partner responses from GET and POST /public-api/resources/partners/v2.0, GET and PATCH /public-api/resources/partners/v2.0/{partner}, and POST /public-api/actions/partner/v1.0/{partner}/set-custom-fields, plus a filter[categoryId] filter on GET /public-api/resources/partners/v2.0 for tokens not scoped to a partner or sub-operator.
    3. Added experimental partner contract lifecycle actions: POST /public-api/actions/partner-contract/v1.0/{partnerContract}/disable, POST /public-api/actions/partner-contract/v1.0/{partnerContract}/start-offboarding, and POST /public-api/actions/partner-contract/v1.0/{partnerContract}/reactivate. Disabling requires disableChargePoints, starting offboarding requires endDate, and successful actions return 202 Accepted; these experimental endpoints may change without a version bump.
    4. Added optional disableChargePointsAtEndDate and billOnlyOnlineChargePoints request fields on POST /public-api/resources/partner-contracts/v1.0 and PATCH and PUT /public-api/resources/partner-contracts/v1.0/{partnerContract}. Added both fields and read-only status (active, offboarding, or ended) to the corresponding responses and to GET /public-api/resources/partner-contracts/v1.0 and GET /public-api/resources/partner-contracts/v1.0/{partnerContract}.
    5. Added partner invite lifecycle actions through POST /public-api/actions/partner-invite/v1.0/{partnerInvite}/expire and POST /public-api/actions/partner-invite/v1.0/{partnerInvite}/restore. Successful actions return 202 Accepted; restoring an expired invite reinstates its previous status and clears its expiration date, but does not restore benefits whose policies have been deleted or disabled.
    6. Added optional startsOn and expiresOn request fields to POST /public-api/resources/partner-invites/v2.0 and PATCH /public-api/resources/partner-invites/v2.0/{partnerInvite} for scheduling invite validity. Added startsOn, expiresOn, and expiryCause to responses from those endpoints and from GET /public-api/resources/partner-invites/v2.0 and GET /public-api/resources/partner-invites/v2.0/{partnerInvite}; dates can be cleared with JSON null in update requests.
    7. Added report listing and retrieval through GET /public-api/resources/reports/v1.0 and GET /public-api/resources/reports/v1.0/{report}. Added generated-file listing, metadata retrieval, and download through GET /public-api/resources/reports/v1.0/{report}/generated-files, GET /public-api/resources/reports/v1.0/{report}/generated-files/{reportGeneratedFile}, and GET /public-api/resources/reports/v1.0/{report}/generated-files/{reportGeneratedFile}/download; file listings support filter[generatedAfter] and filter[generatedBefore], and downloads redirect to a link valid for five minutes.
    8. Added optional integer priority to POST /public-api/actions/circuit/v2.0/{circuit}/set-session-boost/{session} to control a boosted session's load management weight, including updating an already boosted session. The minimum is 2, the default is 1000, and the field must be omitted when enabled is false.
    9. Added optional read-only uuid to tariff scheduled change responses from GET and POST /public-api/resources/tariffs/v1.0/{tariff}/scheduled-changes, and GET and PATCH /public-api/resources/tariffs/v1.0/{tariff}/scheduled-changes/{scheduledChange}.
  3. 🔧 Improvements
    1. Expanded termType with the value location in responses from GET /public-api/resources/consent-history/v1.0, GET and POST /public-api/resources/consents/v1.0, GET /public-api/resources/terms-and-policies/v2.0, and GET /public-api/resources/terms-and-policies/v2.0/{termVersion}. Added the same value to filter[termType] on the consent history and consent listing endpoints.
    2. Expanded partner invite status with expired in responses from GET and POST /public-api/resources/partner-invites/v1.0, GET and PATCH /public-api/resources/partner-invites/v1.0/{partnerInvite}, GET and POST /public-api/resources/partner-invites/v2.0, and GET and PATCH /public-api/resources/partner-invites/v2.0/{partnerInvite}. Added expired to filter[status] on both listing endpoints.
    3. Expanded partnerInvites[].status with expired in user responses from GET and POST /public-api/resources/users/v1.0, GET and PATCH /public-api/resources/users/v1.0/{user}, GET and POST /public-api/resources/users/v1.1, GET and PATCH /public-api/resources/users/v1.1/{user}, and POST /public-api/actions/users/v1.0/{user}/set-custom-fields.
    4. Made it possible to create a new invite for the same partner and email address after an earlier invite has expired, through POST /public-api/resources/partner-invites/v1.0 and POST /public-api/resources/partner-invites/v2.0.