Create a reservation

POST

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

POST

/booking/bookings

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.booking.bookings.create({
        idempotencyKey: "7d3f2a9e-5b1c-4e8a-9f0d-2c6b8e1a4f70",
        booking_id: "BOOK-2026-10-03-0001",
        request_id: "REQ-2026-10-03-0001",
        location_id: "LOC-AMS-01",
        booking_tokens: [
            {
                uid: "04A2B3C4D5E6F7",
                type: "RFID",
                contract_id: "NL-OCP-C12345678-X",
            },
        ],
        tariff_ids: [
            "TARIFF-AC-STD",
        ],
        period: {
            start_date_time: new Date("2026-10-03T12:00:00Z"),
            end_date_time: new Date("2026-10-03T13:00:00Z"),
        },
        access_information: [
            {
                text: "Barrier opens with your charge card.",
            },
        ],
        authorization_reference: "AUTH-7f3c9a",
        booking_terms: {
            early_start: 10,
        },
        booking_requests: [
            {
                request_id: "REQ-2026-10-03-0001",
            },
        ],
        last_updated: new Date("2026-10-03T10:00:00Z"),
        role: "CPO",
        country_code: "NL",
        party_id: "OCP",
    });
}
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": "PENDING",
  "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-03T10:00: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."
    }
  ]
}

Records a reservation request as PENDING; reserve or reject it next. Retrying with the same Idempotency-Key returns the first result.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

booking_idstringRequired1-36 characters

request_idstringRequired1-36 characters

location_idstringRequired1-36 characters

periodobjectRequired

When the reservation may be used.

authorization_referencestringRequired1-36 characters

booking_termsobjectRequired

Terms accepted for the reservation.

booking_requestslist of objectsRequired

roleenumRequired

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

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

booking_optionobject or nullOptional

OCPI booking option. The gateway stores the object it received.

booking_tokenslist of objects or nullOptional

tariff_idslist of strings or nullOptional

canceledobject or nullOptional

OCPI cancellation object.

access_informationlist of objects or nullOptional

last_updateddatetime or nullOptional

originenum or nullOptionalDefaults to LOCAL

Allowed values:

ocpi_versionenum or nullOptionalDefaults to 2.3.0

Allowed values:

Response

The created reservation, PENDING.

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

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error

504

Gateway Timeout Error

Authentication

Headers

Request

Response

Errors