Create a bookable site

POST

https://api.ocpplab.io/booking/booking-locations

POST

/booking/booking-locations

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.booking.locations.create({
        idempotencyKey: "7d3f2a9e-5b1c-4e8a-9f0d-2c6b8e1a4f70",
        booking_location_id: "BLOC-AMS-01",
        location_id: "LOC-AMS-01",
        tariff_ids: [
            "TARIFF-AC-STD",
        ],
        booking_terms: {
            early_start: 10,
        },
        calendars: [
            {
                begin_from: new Date("2026-10-01T00:00:00Z"),
            },
        ],
        role: "CPO",
        country_code: "NL",
        party_id: "OCP",
    });
}
main();

{
  "id": 12,
  "booking_location_id": "BLOC-AMS-01",
  "location_id": "LOC-AMS-01",
  "last_updated": "2026-10-01T09: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-01T09:00:00Z",
  "updated_at": "2026-10-01T09:00:00Z",
  "tariff_ids": [
    "TARIFF-AC-STD"
  ],
  "booking_terms": {
    "early_start": 10
  },
  "calendars": [
    {
      "begin_from": "2026-10-01T00:00:00Z"
    }
  ]
}

Opens an OCPI location for reservations. Country code and party id are stored in upper case. 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_location_idstringRequired1-36 characters

location_idstringRequired1-36 characters

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.

policyobject or nullOptional

OCPI booking policy. Later fields are kept.

tariff_idslist of strings or nullOptional

booking_termsobject or nullOptional

Terms accepted for the reservation.

calendarslist 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 bookable site.

idinteger

booking_location_idstring

location_idstring

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

policymap from strings to any or nullOptional

tariff_idslist of strings or nullOptional

booking_termsobject or nullOptional

Terms accepted for the reservation.

calendarslist 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