Create a charge point

POST

https://api.ocpplab.io/cpo/charge-points

POST

/cpo/charge-points

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.cpo.chargePoints.create({
        charge_point_id: "CP-AMS-001",
        ocpp_version: "ocpp2.0.1",
        charge_point_vendor: "ABB",
        charge_point_model: "Terra AC W22",
        location_id: 12,
        max_power_kw: 22,
        connector_count: 2,
        is_roaming: true,
    });
}
main();

{
  "id": "5f0c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "charge_point_id": "CP-AMS-001",
  "is_online": false,
  "is_roaming": true,
  "use_status_notification_0": false,
  "revision": 1,
  "ocpp_version": "ocpp2.0.1",
  "charge_point_vendor": "ABB",
  "charge_point_model": "Terra AC W22",
  "firmware_version": "1.8.2",
  "max_power_kw": 22,
  "connector_count": 2,
  "location_id": 12
}

Registers a charger. It starts offline; a real charger also needs credentials before it can connect. 409 if the OCPP identity is taken.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

charge_point_idstringRequired1-36 characters

ocpp_versionenum or nullOptional

OCPP protocol version stored on ocpp.charge_points.ocpp_version.

Allowed values:

charge_point_vendorstring or nullOptional<=20 characters

charge_point_modelstring or nullOptional<=20 characters

location_idinteger or nullOptional>=1

coordinatesstring or nullOptional<=128 characters

floor_levelstring or nullOptional<=50 characters

parking_restrictionslist of strings or nullOptional

capabilitieslist of strings or nullOptional

max_power_kwdouble or nullOptional>=0

connector_typestring or nullOptional<=50 characters

connector_countinteger or nullOptional>=0

accessibilitystring or nullOptional<=100 characters

use_status_notification_0boolean or nullOptionalDefaults to true

image_urlstring or nullOptional<=512 characters

is_roamingboolean or nullOptionalDefaults to false

Response

The created object.

idstring

organization_idstring

charge_point_idstring

is_onlineboolean

is_roamingboolean

use_status_notification_0boolean

When true, OCPP 1.6 StatusNotification connectorId 0 updates every connector.

revisioninteger

ocpp_versionstring or nullOptional

charge_point_vendorstring or nullOptional

charge_point_modelstring or nullOptional

charge_point_serial_numberstring or nullOptional

charge_box_serial_numberstring or nullOptional

firmware_versionstring or nullOptional

last_heartbeatdatetime or nullOptional

iccidstring or nullOptional

imsistring or nullOptional

meter_typestring or nullOptional

meter_serial_numberstring or nullOptional

floor_levelstring or nullOptional

parking_restrictionslist of strings or nullOptional

capabilitieslist of strings or nullOptional

max_power_kwdouble or nullOptional

connector_typestring or nullOptional

connector_countinteger or nullOptional

accessibilitystring or nullOptional

location_idinteger or nullOptional

image_urlstring or nullOptional

proxy_urlsmap from strings to any or nullOptional

responded_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