Create location, optionally with chargers

POST

https://api.ocpplab.io/evcharger/location

POST

/evcharger/location

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.evcharger.location.create({
        name: "La Defense Charging Hub",
        address: "1 Parvis de la Defense",
        city: "Puteaux",
        country: "FRA",
        coordinates: {
            lat: 48.892,
            lng: 2.238,
        },
        timezone: "Europe/Paris",
        chargers: [
            {
                identity: "CP-001",
                brand_slug: "wallbox",
                model: "wallbox-pulsar-plus",
                connector_type: "Type2",
                ws_url: "wss://evcharger.example.com",
            },
        ],
    });
}
main();

{
  "detail": "Location creation accepted; chargers are deploying in the background.",
  "location_id": "3f129601-158b-47d6-aab9-489d4d6163fa",
  "status": "accepted"
}

Returns 202 at once and deploys the chargers in the background. Follow progress with GET /evcharger/deployment-runtime-ops/status (client.evcharger.deployment_runtime_ops.status()) until every charger is online. With no chargers only the location is created; add chargers later with POST /evcharger/deployment and location_id. A failed charger does not abort the batch. Background work is not durable across restarts.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

Location display name.

addressstringRequired>=1 character

citystringRequired>=1 character

countrystringRequired>=1 character

coordinatesobjectRequired

GPS coordinates; lat in [-90,90], lng in [-180,180].

timezonestring or nullOptional

owner_namestring or nullOptional

publicboolean or nullOptional

chargerslist of objectsOptional

Chargers to deploy at this location. Optional: an empty list creates the location only; add chargers later with POST /evcharger/deployment and its location_id.

Response

Location creation accepted

detailstring

What was accepted and is running in the background.

location_idstring

Id of the location being created; pass it to DELETE /evcharger/location to remove the location and its chargers.

statusstringOptionalDefaults to accepted

Always 'accepted'.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error