HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Location / Create

Create a new location

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer | null

The operator ID for this resource.
Required for global admin tokens.
Optional for operator-scoped tokens (defaults to token's operator).

string | null
name
array of objects
required
name*
string
enum

Deprecated.

Allowed:
description
array of objects
description
shortDescription
array of objects
shortDescription
additionalDescription
array of objects
additionalDescription
geoposition
object
required
address
array of objects
required

The full address of the location

address*
streetAddress
array of objects

The street address of the location

streetAddress
string | null
string | null

When country is not in US, AU, CA, UM or RO, you can provide the region

enum

When the selected country is one of US, AU, CA, UM or RO


When the country is US.

string
enum
required
string | null

Postal code of the location. Required for most countries — omitting it for those will result in a validation error.

string | null

A valid timezone in the form of Area/Location, required when Allow Multiple Time Zones option is turned on in the Timezone Setting.

string | null
enum

Indicates the type of parking available at the charging location. This field helps EV drivers understand the physical parking environment before arrival.

Valid values:

  • ALONG_MOTORWAY - Located along a motorway/highway, typically at rest areas or service stations
  • PARKING_GARAGE - Multi-level parking garage structure, either above-ground or mixed-use
  • PARKING_LOT - Surface parking lot, open-air parking area
  • ON_DRIVEWAY - Located on a private driveway, typically residential or small business
  • ON_STREET - Street-side parking, curbside charging locations
  • UNDERGROUND_GARAGE - Underground parking structure, subterranean parking facility
  • IS_TENT - Site located on the Trans-European Transport Network (Lithuania NAP / Via Lietuva extension; may not be interpreted by all roaming partners)
  • SECURE - Restricted-access parking such as gated lots, key-card access, or staffed parking (Lithuania NAP / Via Lietuva extension; may not be interpreted by all roaming partners)

Request behavior (POST/PATCH):

  • Optional field when creating or updating locations
  • Send null to clear the parking type
  • Omit the field in PATCH requests to leave the existing value unchanged

Response behavior (GET):

  • Field is omitted from the response when no parking type is configured (null in database)
  • When present, returns one of the valid enum values listed above
accessMethods
array of strings | null

Physical access methods available at this location. Multiple methods can be selected if the site supports different access types.

Request behavior (POST/PATCH):

  • Optional field when creating or updating locations
  • Send null to clear all access methods
  • Send [] to store an empty access methods list
  • Duplicate values are automatically de-duplicated before storage
  • Omit the field in PATCH requests to leave the existing value unchanged

Response behavior (GET):

  • Field is omitted from the response when no access methods are configured (null in database)
  • When access methods are configured but the array is empty, returns an empty array []
  • When present, returns an array of valid enum values listed above

Available methods:

  • OPEN - Publicly accessible without restrictions
  • TOKEN - Access via RFID token or card
  • LICENSE_PLATE - Access via license plate recognition
  • ACCESS_CODE - Access via PIN/access code entry
  • INTERCOM - Access via intercom system
  • PARKING_TICKET - Access via parking ticket validation
accessMethods
Allowed:
facilities
array of strings | null

Describes amenities and facilities available at or near the charging location. Most values are self-explanatory. Special categories include:

  • RECREATION_AREA - Parks, playgrounds, or leisure facilities
  • CARPOOL_PARKING - Dedicated parking for carpooling/ridesharing
  • NATURE - Natural attractions or green spaces
  • STAFFED - Location has staff present
  • BATHROOM - Bathroom facilities available

Request behavior (POST/PATCH):

  • Optional field when creating or updating locations
  • Send null to clear all facilities
  • Send [] to store an empty facilities list
  • Duplicate values are automatically de-duplicated before storage
  • Omit the field in PATCH requests to leave the existing value unchanged

Response behavior (GET):

  • Field is omitted from the response when no facilities are configured (null in database)
  • When facilities are configured but the array is empty, returns an empty array []
  • When present, returns an array of valid enum values listed above
facilities
paymentOptions
array of objects | null

Payment methods accepted at the charging location, as required by AFIR (Alternative Fuels Infrastructure Regulation) for regulatory reporting.

Null vs empty semantics:

  • null - Not yet specified by the operator (unknown). Omitted from DATEX II reporting.
  • [] (empty array) - The operator explicitly confirmed that no payment options are available at this location.

Request behavior (POST/PATCH):

  • Optional field when creating or updating locations
  • Send null to clear all payment options
  • Send [] to store an empty payment options list
  • Duplicate values are automatically de-duplicated before storage
  • Omit the field in PATCH requests to leave the existing value unchanged

Response behavior (GET):

  • Field is omitted from the response when no payment options are configured (null in database)
  • When payment options are configured but the array is empty, returns an empty array []
  • When present, returns an array of valid enum values listed above
paymentOptions
Allowed:
acceptedPaymentBrands
array of objects | null

Payment card brands accepted at the charging location. Only applicable when paymentOptions includes a payment terminal option (EMV_CHIP_TERMINAL or NFC_CONTACTLESS_TERMINAL).

If paymentOptions does not contain any terminal option, any provided acceptedPaymentBrands value is silently ignored and stored as null.

Null vs empty semantics:

  • null - Not yet specified or not applicable (no terminal options in paymentOptions).
  • [] (empty array) - The operator explicitly confirmed that no specific payment brands are accepted.

Request behavior (POST/PATCH):

  • Optional field when creating or updating locations
  • Send null to clear all accepted payment brands
  • Send [] to store an empty accepted payment brands list
  • Duplicate values are automatically de-duplicated before storage
  • Omit the field in PATCH requests to leave the existing value unchanged
  • If paymentOptions does not contain EMV_CHIP_TERMINAL or NFC_CONTACTLESS_TERMINAL, this field is silently stored as null

Response behavior (GET):

  • Field is omitted from the response when no accepted payment brands are configured (null in database)
  • When accepted payment brands are configured but the array is empty, returns an empty array []
  • When present, returns an array of valid enum values listed above
acceptedPaymentBrands
Allowed:
workingHours
object
tags
array of strings
tags
externalAppData
object | null

Used to hold any external application data related to the Location.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json