CPO Locations
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.
CPO Location Management APIs
POST/2/locations/cpo
Create Location
Create a new CPO location.
Authorization
User sessionAPI credentialPermissions
cpo-locations:writeOAuth
-
Request
Request bodyapplication/json
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimburseaccountIdstringREQUIRED
accountLegacyIdstring
addressstringREQUIRED
billingPolicyobject
billingPolicyobject
subscriptionBillingobject[]REQUIRED
subscriptionBillingobject[]REQUIRED
entityobject
entityobject
accountIdstring
typestringREQUIRED
accountuseruserIdstring
percentagenumber
min
0max 100usageReimbursementobject | object | object | object[]REQUIRED
citystringREQUIRED
countrystringREQUIRED
facilitatorAccountIdstring | null
facilitiesstring[]
geoLocationobject
geoLocationobject
coordinatesnumber[]
typestring
legacyIdstring
namestringREQUIRED
opening_timesobject | null
opening_timesobject | null
exceptional_closingsobject[]
exceptional_closingsobject[]
period_beginstring <date-time>REQUIRED
period_endstring <date-time>REQUIRED
exceptional_openingsobject[]
exceptional_openingsobject[]
period_beginstring <date-time>REQUIRED
period_endstring <date-time>REQUIRED
regular_hoursobject[]
regular_hoursobject[]
period_beginstringREQUIRED
period_endstringREQUIRED
weekdaynumberREQUIRED
min
1max 7twentyfoursevenboolean
parking_typestring
postal_codestringREQUIRED
publishingModestring
userEmailstring <email>
userIdstring
Responses
200OK application/json
dataLocationResource
dataLocationResource
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburseaccountobject
accountIdstring
addressstring
auditEntiresboolean
billingPolicyobject
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
creditBillingTargetobject[]
creditBillingTargetobject[]
accountIdstring
percentagenumber
typestring
creditreimbursementuserIdstring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
facilitatorAccountIdstring
facilitiesstring[]
geoLocationobject
geoLocationobject
coordinatesobjectREQUIRED
coordinatesobjectREQUIRED
0numberREQUIRED
1numberREQUIRED
lengthnumberREQUIRED
2typestringREQUIRED
hasTariffInfoboolean
idstringREQUIRED
importsobject
importsobject
importIdsstring[]REQUIRED
referencestringREQUIRED
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestringREQUIRED
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
postalCodestring
postal_codestring
powerTypestring
providerContextstringREQUIRED
cpomspproviderIdstringREQUIRED
publishingModestring
privatepublicsourcestringREQUIRED
cpoeclearingocpiroad-cpo-internalstatusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timestampsboolean
timezonestring
typestring
userobject
userIdstring
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/2/locations/cpo/search
Search Locations
Search CPO locations with filters and optional CSV export.
Authorization
User sessionAPI credentialPermissions
cpo-locations:readOAuth
-
Request
Request bodyapplication/json
accessPolicystring
accountIdstring
createdAtobject
createdAtobject
$eqnumber | string <date-time>
$gtenumber | string <date-time>
$ltenumber | string <date-time>
filenamestring
default
locations-cpo.csvformatstring
default
jsonfromstring <date-time>
hasErrorsboolean
idstring
idsstring[]
importIdstring
limitnumber
default
50localestring
Browser locale, e.g. nl-NL, for a CSV export: sets its decimal sign and delimiter. Without it the CSV keeps its default format.
namestring
searchIdstring
searchPhrasestring
shallowboolean
default
falseskipnumber
default
0sortobjectdefault {"field":"createdAt","order":"desc"}
sortobject
default
{"field":"createdAt","order":"desc"}fieldstringREQUIRED
orderstringREQUIRED
ascdesctostring <date-time>
Responses
200OK application/json
dataLocationResource[]REQUIRED
dataLocationResource[]REQUIRED
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburseaccountobject
accountIdstring
addressstring
auditEntiresboolean
billingPolicyobject
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
creditBillingTargetobject[]
creditBillingTargetobject[]
accountIdstring
percentagenumber
typestring
creditreimbursementuserIdstring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
facilitatorAccountIdstring
facilitiesstring[]
geoLocationobject
geoLocationobject
coordinatesobjectREQUIRED
coordinatesobjectREQUIRED
0numberREQUIRED
1numberREQUIRED
lengthnumberREQUIRED
2typestringREQUIRED
hasTariffInfoboolean
idstringREQUIRED
importsobject
importsobject
importIdsstring[]REQUIRED
referencestringREQUIRED
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestringREQUIRED
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
postalCodestring
postal_codestring
powerTypestring
providerContextstringREQUIRED
cpomspproviderIdstringREQUIRED
publishingModestring
privatepublicsourcestringREQUIRED
cpoeclearingocpiroad-cpo-internalstatusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timestampsboolean
timezonestring
typestring
userobject
userIdstring
metaobjectREQUIRED
metaobjectREQUIRED
limitnumberREQUIRED
skipnumberREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/2/locations/cpo/{location}
Get Location
Returns a single CPO location.
Authorization
User sessionAPI credentialPermissions
cpo-locations:readOAuth
-
Request
Path parameters1
locationstringREQUIRED
Responses
200OK application/json
dataLocationResource
dataLocationResource
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburseaccountobject
accountIdstring
addressstring
auditEntiresboolean
billingPolicyobject
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
creditBillingTargetobject[]
creditBillingTargetobject[]
accountIdstring
percentagenumber
typestring
creditreimbursementuserIdstring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
facilitatorAccountIdstring
facilitiesstring[]
geoLocationobject
geoLocationobject
coordinatesobjectREQUIRED
coordinatesobjectREQUIRED
0numberREQUIRED
1numberREQUIRED
lengthnumberREQUIRED
2typestringREQUIRED
hasTariffInfoboolean
idstringREQUIRED
importsobject
importsobject
importIdsstring[]REQUIRED
referencestringREQUIRED
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestringREQUIRED
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
postalCodestring
postal_codestring
powerTypestring
providerContextstringREQUIRED
cpomspproviderIdstringREQUIRED
publishingModestring
privatepublicsourcestringREQUIRED
cpoeclearingocpiroad-cpo-internalstatusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timestampsboolean
timezonestring
typestring
userobject
userIdstring
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
PATCH/2/locations/cpo/{location}
Update Location
Update a CPO location.
Authorization
User sessionAPI credentialPermissions
cpo-locations:writeOAuth
-
Request
Path parameters1
locationstringREQUIRED
Request bodyapplication/json
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimburseaccountIdstringREQUIRED
accountLegacyIdstring
addressstringREQUIRED
billingPolicyobject
billingPolicyobject
subscriptionBillingobject[]REQUIRED
subscriptionBillingobject[]REQUIRED
entityobject
entityobject
accountIdstring
typestringREQUIRED
accountuseruserIdstring
percentagenumber
min
0max 100usageReimbursementobject | object | object | object[]REQUIRED
citystringREQUIRED
countrystringREQUIRED
facilitatorAccountIdstring | null
facilitiesstring[]
geoLocationobject
geoLocationobject
coordinatesnumber[]
typestring
legacyIdstring
namestringREQUIRED
opening_timesobject | null
opening_timesobject | null
exceptional_closingsobject[]
exceptional_closingsobject[]
period_beginstring <date-time>REQUIRED
period_endstring <date-time>REQUIRED
exceptional_openingsobject[]
exceptional_openingsobject[]
period_beginstring <date-time>REQUIRED
period_endstring <date-time>REQUIRED
regular_hoursobject[]
regular_hoursobject[]
period_beginstringREQUIRED
period_endstringREQUIRED
weekdaynumberREQUIRED
min
1max 7twentyfoursevenboolean
parking_typestring
postal_codestringREQUIRED
publishingModestring
suboperatorobject
suboperatorobject
namestring | null
userEmailstring <email>
userIdstring
Responses
200OK application/json
dataLocationResource
dataLocationResource
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburseaccountobject
accountIdstring
addressstring
auditEntiresboolean
billingPolicyobject
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
creditBillingTargetobject[]
creditBillingTargetobject[]
accountIdstring
percentagenumber
typestring
creditreimbursementuserIdstring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
facilitatorAccountIdstring
facilitiesstring[]
geoLocationobject
geoLocationobject
coordinatesobjectREQUIRED
coordinatesobjectREQUIRED
0numberREQUIRED
1numberREQUIRED
lengthnumberREQUIRED
2typestringREQUIRED
hasTariffInfoboolean
idstringREQUIRED
importsobject
importsobject
importIdsstring[]REQUIRED
referencestringREQUIRED
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestringREQUIRED
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
postalCodestring
postal_codestring
powerTypestring
providerContextstringREQUIRED
cpomspproviderIdstringREQUIRED
publishingModestring
privatepublicsourcestringREQUIRED
cpoeclearingocpiroad-cpo-internalstatusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timestampsboolean
timezonestring
typestring
userobject
userIdstring
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
DELETE/2/locations/cpo/{location}
Delete Location
Soft-delete a CPO location.
Authorization
User sessionAPI credentialPermissions
cpo-locations:writeOAuth
-
Request
Path parameters1
locationstringREQUIRED
Responses
200OK application/json
No response body.
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED