Changelog
Start typing to search…

(v.2.2.0) Introducing Temporary EVSE status and full Locations CRUD

🔹 What's New?

With version 2.2.0, we have just released 2 major upgrades to the Spirii API:

Temporary EVSE Status

Spirii's Temporary EVSE status functionality allows the charge point operator (CPO) to modify the charger status shared with the e-Mobility Service Providers (eMSPs). This feature updates the displayed charger status in the eMSP apps without touching the actual charger status.

The CPO can utilize this functionality for multiple use cases:

  • Maintenance mode: Avoid having drivers turn up at the charger only to be disappointed, whilst keeping the charger available for the technician to work on it.
  • Commissioning: Create hype for new chargers being planned, installed, tested, and configured.
  • Parking sensors: Allow an external sensor system to update the status when the parking space in front of the charger becomes occupied.
  • Reservation system: Allow an external booking system to update the reservation status of the charger.

📌 New Endpoints:
POSt /v2/temporary-evse-statuses
GET /v2/temporary-evse-statuses
GET /v2/temporary-evse-statuses/{id}
PATCH /v2/temporary-evse-statuses/{id}
DELETE /v2/temporary-evse-statuses/{id}

Locations V2 - Full CRUD operations

In addition to the existing GET endpoints, Locations V2 now includes the full CRUD operations, including the ability to create, update, and delete locations programmatically.

📌 New Endpoints:
POST /v2/locations
PATCH /v2/locations/{id}
DELETE /v2/locations/{id}

❌ What's Deprecated?

The old Locations V1 update endpoint is now deprecated under the Spirii Legacy API.

📌 Deprecated Endpoints:
PUT /locations

🔔 Action Required:
Partners using this endpoint should migrate to V2 as soon as possible.

🔄 Key Changes & Improvements

Endpoints

Change

Description

POSt /v2/temporary-evse-statuses GET /v2/temporary-evse-statuses GET /v2/temporary-evse-statuses/{id} PATCH /v2/temporary-evse-statuses/{id} DELETE /v2/temporary-evse-statuses/{id}

Temporary EVSE status

  • Set a temporary status on an EVSE
  • Get existing temporary statuses for an EVSE
  • Get all existing temporary statuses
  • Update the temporary status for an EVSE
  • Delete the temporary status for an EVSE

POST /v2/locations
PATCH /v2/locations/{id}
DELETE /v2/locations/{id}

Locations

  • Create a location
  • Update an existing location
  • Delete an existing location

📢 Migration & Next Steps

  • All partners using V1 should transition to V2 as soon as possible.
  • The V1 endpoint will remain operational for now, but will be fully sunset at a later date (to be announced).
  • If you use V1, please update your integrations accordingly and reach out if you need support.

📌 Breaking Changes Notice:
Some properties are not available in the V2 anymore and the structure has changes in a breaking manner, but if you are using V1, we strongly recommend migrating now to take advantage of the new capabilities and ensure long-term compatibility. See the API documentation for the full details.

(v.2.1.0) Introducing Locations V2 and Tariffs V2 for AFIR compliance

🔹 What's New?

We've introduced Locations V2 and Tariffs V2 under the Spirii API.

The Charge Point Operator (CPO) of public chargers can use these GET endpoints to comply with the EU's Alternative Fuel Infrastructure Regulation (AFIR) article 20, which went into effect on April 14th, 2025.

Additionally, the added endpoints provide extended data fields related to location management and the pricing of public charging compared to the legacy Locations endpoint.

Both endpoints are structured and formatted in compliance with OCPI version 2.3.0.

📌 New Endpoints:
GET /v2/locations
GET /v2/locations/{id}
GET /v2/tariffs/{id}

❌ What's Deprecated?

The old Locations V1 endpoint is now deprecated under the Spirii Legacy API.

📌 Deprecated Endpoints:
GET /locations
GET /locations/{id}

🔔 Action Required:
Partners using this endpoint should migrate to V2 as soon as possible.

🔄 Key Changes & Improvements

Change

Endpoints

Description

Locations

GET /v2/locations
GET /v2/locations/{id}

  • Format upgraded to OCPI 2.3.0 structure
  • Added data for facilities, opening hours, directions, contact information, and energy mix.

Tariffs

GET /v2/tariffs/{id}

  • Format upgraded to OCPI 2.3.0 structure
  • Added data for tariff type, price components, and price restrictions

📢 Migration & Next Steps

  • All partners using V1 should transition to V2 as soon as possible.
  • The V1 endpoint will remain operational for now, but will be fully sunset at a later date (to be announced).
  • If you use V1, please update your integrations accordingly and reach out if you need support.

📌 Breaking Changes Notice:
Some properties are not available in the V2 anymore and the structure has changes in a breaking manner, but if you are using V1, we strongly recommend migrating now to take advantage of the new capabilities and ensure long-term compatibility. See the API documentation for the full details.

(v.2.0.1) Bug fixes

We fixed various bugs across the Transaction V2 and Voucher endpoints.

🔄 Key Changes & Improvements

Change

Endpoints

Description

Bug fix

Fixed an issue with the startedAt filter not being applied

Bug fix

Fixed an issue with retrieving voucher groups where the companyId was null

Bug fix

Fixed an issue where the response included deleted voucher groups (deletedAt timestamp being populated). These are now filtered out.

Introducing Transaction V2

🔹 What's New?

We've introduced Transaction V2 under the Spirii API.
This new version increases readability, introduces new transaction properties and improves the overall response structure and filtering capabilities.

📌 New Endpoint:
GET /v2/transactions

📌 New Endpoint:
GET /v2/transactions/{id}

❌ What's Deprecated?

The old Transaction V1 endpoint is now deprecated under the Spirii Legacy API.

📌 Deprecated Endpoint:
GET /v1/transactions

GET /v1/transactions/{id}

🔔 Action Required:
Partners using this endpoint should migrate to V2 as soon as possible.

🔄 Key Changes & Improvements

Change

Transaction V1

Transaction V2

Data Structure

N/A

Response structure changes:

  • auth object has been added.
  • location object now returns type, countryCode, isEligibleForRefund properties
  • price object has been expanded to include VAT and tariff information
    -user object has been replaced by appUserId
  • chargingDetails has been added containing detailed charing information like charging status, state of charge meter start and stop values, and C02 emissions data
    -company object has been added
  • paymentStatus object has been added

Data Structure

meterValues object contains all meter values

meterValues has been deprecated and replaced by meterStart and meterStop properties inside the chargingDetails object

Pagination

Offset-based

Cursor-based for better scalability

Filtering

Limited filtering options

Enhanced filtering based on multiple fields: ongoing ,chargeBoxId ,evseId,locationType ,transactionType ,voucherId

📢 Migration & Next Steps

  • All partners using V1 should transition to V2 as soon as possible.
  • The V1 endpoint will remain operational for now, but will be fully sunset at a later date (to be announced).
  • If you use V1, please update your integrations accordingly and reach out if you need support.

📌 Breaking Changes Notice:
Some properties are not available in the V2 anymore and the structure has changes in a breaking manner, but if you are using V1, we strongly recommend migrating now to take advantage of the new capabilities and ensure long-term compatibility. See the API documentation for the full details.

Introducing Charge Record V2

🔹 What's New?

We've introduced Charge Detail Records V2 under the Spirii API.
This new version enhances performance, consistency, and scalability while improving response structure and filtering capabilities.

📌 New Endpoint:
GET /v2/charge-records

❌ What's Deprecated?

The old Charge Record V1 endpoint is now deprecated under the Spirii Legacy API.

📌 Deprecated Endpoint:
GET /v1/charge-records

🔔 Action Required:
Partners using this endpoint should migrate to V2 as soon as possible.

🔄 Key Changes & Improvements

ChangeCharge Record V1Charge Record V2
Base Path/v1/charge-records/v2/charge-records
Data StructureFlattened response formatStructured response with nested data
FilteringLimited filtering optionsEnhanced filtering on multiple fields (e.g., start/end timestamps, CPO ID, EMP ID)
PaginationOffset-basedCursor-based for better scalability
Status FieldLimited status valuesExpanded status values for better charge session tracking
Meter ValuesBasic meter readingsMore detailed energy consumption metrics
TimestampsUnix timestampsISO 8601 format for consistency

📢 Migration & Next Steps

  • All partners using V1 should transition to V2 as soon as possible.
  • The V1 endpoint will remain operational for now, but will be fully sunset at a later date (to be announced).
  • If you use V1, please update your integrations accordingly and reach out if you need support.

📌 Breaking Changes Notice:
No immediate disruptions, but if you are using V1, we strongly recommend migrating now to take advantage of the new capabilities and ensure long-term compatibility.

For any questions or migration support, please reach out to support at [email protected].

Welcome to spirii

Welcome to the developer hub and documentation for spirii!