HomeGuidesAPI ReferenceChangelog
Terms of Use
Changelog

3.248.0 release notes

  1. ⚠️ Breaking changes
    1. Removed PATCH /public-api/resources/sessions/v1.0/{session}. To update Session custom fields, use POST /public-api/actions/session/v1.0/{session}/set-custom-fields instead; the replacement returns 202 Accepted rather than 200 OK.
    2. Moved the Charge point powerSharing property from the top level to smartCharging.powerSharing. Update payloads and response handling for POST /public-api/resources/charge-points/v2.0, GET and PATCH /public-api/resources/charge-points/v2.0/{chargePoint}, GET /public-api/resources/charge-points/v2.0, and POST /public-api/resources/charge-points/v2.0/{chargePoint}/smart-charging.
    3. Made Partner administrator email validation stricter on POST /public-api/resources/partners/v2.0/{partner}/admins and PATCH /public-api/resources/partners/v2.0/{partner}/admins/{admin}. Email addresses must now be valid strict ASCII email addresses.
  2. New features
    4. Added POST custom-field actions for Partners, Payment terminals, Partner settlement reports, and Sessions: /public-api/actions/partner/v1.0/{partner}/set-custom-fields, /public-api/actions/payment-terminal/v1.0/{paymentTerminal}/set-custom-fields, /public-api/actions/partner-settlement-report/v1.0/{partnerSettlementReport}/set-custom-fields, and /public-api/actions/session/v1.0/{session}/set-custom-fields. Send values in a customFields object; omitted identifiers remain unchanged and null clears a value.
    5. Added custom-field filtering using filter[customFields.<identifier>] to GET /public-api/resources/partners/v2.0, GET /public-api/resources/payment-terminals/v1.1, and GET /public-api/resources/partner-settlement-reports/v1.0.
    6. Added the optional customFields response property to Partner, Payment terminal, and Partner settlement report read representations, including GET /public-api/resources/partners/v2.0, GET /public-api/resources/partners/v2.0/{partner}, GET /public-api/resources/payment-terminals/v1.1, GET /public-api/resources/payment-terminals/v1.1/{paymentTerminal}, GET /public-api/resources/partner-settlement-reports/v1.0, and GET /public-api/resources/partner-settlement-reports/v1.0/{partnerSettlementReport}.
    7. Added the optional lastHardwareStatusUpdateAt timestamp to Charge point and EVSE responses from GET and POST /public-api/resources/charge-points/v2.0, GET and PATCH /public-api/resources/charge-points/v2.0/{chargePoint}, the nested /evses endpoints, and GET, POST, and PATCH /public-api/resources/evses/v2.1 endpoints.
    8. Added the optional options.allowToLogExemptPeriods property to Partner payloads on GET and POST /public-api/resources/partners/v2.0 and GET and PATCH /public-api/resources/partners/v2.0/{partner}. Set it to allow eligible Partner administrators to log exempt periods.
    9. Added the optional timelineSnapshot inclusion to GET /public-api/resources/sessions/v1.0/{session}. Request it with include[]=timelineSnapshot to receive the Session timeline snapshot in the response.
  3. 🔧 Improvements
    10. Expanded supported language values with ko for Partner invites, Partner settlement-report notification language, and User locale fields across the applicable Partner invite, Partner, and User endpoints.
    11. Added Adyen Castles as a supported terminalType on POST /public-api/resources/payment-terminals/v1.1 and PATCH /public-api/resources/payment-terminals/v1.1/{paymentTerminal}. Responses from those endpoints can now also return this value.
    12. Expanded Session timeline event types with start_transaction_wh and stop_transaction_wh on GET /public-api/resources/sessions/v1.0/{session}/timeline-snapshot.
    13. Expanded the Transactions pendingReason field with awaiting_reconciliation on GET and POST /public-api/resources/transactions/v1.0 and GET and PATCH /public-api/resources/transactions/v1.0/{transaction}.
    14. Changed Authorization responses to return the Charge point's operator identifier when available, including for deleted Charge points, on the v1.0, v2.0, and v2.1 Authorization read endpoints.
    15. Added a 425 Too Early response to POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/issue-credit-note when the original invoice has not yet been certified. Retry after its fiscalization status becomes certified.