Cancel a reservation

POST

https://api.ocpplab.io/booking/bookings/:booking_id/cancel

POST

/booking/bookings/:booking_id/cancel

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.booking.bookings.cancel({
        booking_id: "BOOK-2026-10-03-0001",
        country_code: "NL",
        party_id: "OCP",
        idempotencyKey: "7d3f2a9e-5b1c-4e8a-9f0d-2c6b8e1a4f70",
    });
}
main();

{
  "id": 3001,
  "booking_id": "BOOK-2026-10-03-0001",
  "request_id": "REQ-2026-10-03-0001",
  "location_id": "LOC-AMS-01",
  "period": {
    "start_date_time": "2026-10-03T12:00:00Z",
    "end_date_time": "2026-10-03T13:00:00Z"
  },
  "reservation_status": "CANCELED",
  "authorization_reference": "AUTH-7f3c9a",
  "booking_terms": {
    "early_start": 10
  },
  "booking_requests": [
    {
      "request_id": "REQ-2026-10-03-0001"
    }
  ],
  "last_updated": "2026-10-03T10:00:00Z",
  "role": "CPO",
  "origin": "LOCAL",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "country_code": "NL",
  "party_id": "OCP",
  "ocpi_version": "2.3.0",
  "created_at": "2026-10-03T10:00:00Z",
  "updated_at": "2026-10-03T13:05:00Z",
  "booking_tokens": [
    {
      "uid": "04A2B3C4D5E6F7",
      "type": "RFID",
      "contract_id": "NL-OCP-C12345678-X"
    }
  ],
  "tariff_ids": [
    "TARIFF-AC-STD"
  ],
  "access_information": [
    {
      "text": "Barrier opens with your charge card."
    }
  ]
}

Moves a PENDING or RESERVED reservation to CANCELED. Send {}, or an OCPI canceled object to record why.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

booking_idstringRequired1-36 characters

OCPI id of the reservation.

Query parameters

country_codestringRequiredformat: "^[A-Za-z]{2}$"=2 characters

OCPI country code of the party that owns the row, e.g. NL.

party_idstringRequiredformat: "^[A-Za-z]{3}$"=3 characters

OCPI party id of the party that owns the row, e.g. OCP.

Request

This endpoint expects an object.

canceledobject or nullOptional

OCPI cancellation object.

Response

The reservation, now CANCELED (it was PENDING or RESERVED).

idinteger

booking_idstring

request_idstring

location_idstring

periodobject

When the reservation may be used.

reservation_statusenum or any

authorization_referencestring

booking_termsobject

Terms accepted for the reservation.

booking_requestslist of objects

last_updateddatetime

roleenum or any

originenum or any

organization_idstring

country_codestring

party_idstring

ocpi_versionenum or any

created_atdatetime

updated_atdatetime

booking_optionmap from strings to any or nullOptional

booking_tokenslist of objects or nullOptional

tariff_idslist of strings or nullOptional

canceledmap from strings to any or nullOptional

access_informationlist of objects or nullOptional

deleted_atdatetime or nullOptional

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error

504

Gateway Timeout Error