YourParkingSpace
API docs by Redocly

Your Parking Space (2.0.0)

Download OpenAPI specification:

Terms of Service

Introduction

This is the documentation for version 2.0.0 of the Your Parking Space API. The API requires authentication and API credentials are only available to selected third-parties and a per-request basis.

Auth

Checks if the email exists

Authorizations:
application
Request Body schema: application/json
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "email@email.com"
}

Checks if the social account is already connected

Authorizations:
application
Request Body schema: application/json
provider
required
string
Enum: "facebook" "google"
token
required
string

Responses

Request samples

Content type
application/json
{
  • "provider": "facebook",
  • "token": "long_token_string"
}

Connect a social provider to account

Authorizations:
user
Request Body schema: application/json
provider
required
string
Enum: "facebook" "google"
token
required
string

Responses

Request samples

Content type
application/json
{
  • "provider": "facebook",
  • "token": "long_token_string"
}

Disconnect a social provider

Authorizations:
user
path Parameters
provider
required
string
Enum: "facebook" "google"
Example: facebook

Responses

Registers a user

Authorizations:
application
Request Body schema: application/json
first_name
string
last_name
string
email
required
string
password
required
string
mobile
string
marketing_consent_given
boolean

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "password": "string",
  • "mobile": "string",
  • "marketing_consent_given": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "mobile": "string",
  • "date_of_birth": "string",
  • "city": "string",
  • "postcode": "string",
  • "login_hash": "string",
  • "notification_preferences": {
    },
  • "profile_image_url": "string",
  • "social": {
    },
  • "is_admin": true
}

Sends 'Reset password' email

Authorizations:
application
Request Body schema: application/json
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Resets user's password

Authorizations:
application
Request Body schema: application/json
token
required
string
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "email": "string",
  • "password": "string"
}

Search

Location availability search

Perform a location availability search:

  • To perform a standard search (location based) both a latitude and longitude must be supplied.
  • To perform a site ID search, supply the users value in location and do not send a latitude or longitude.
Authorizations:
application
query Parameters
location
required
string

A string representation of what the user searched for (eg. York, UK). Enter the site ID here if searching by this.

lat
string

The latitude for this search

lng
string

The longitude for this search

start
required
string <YYYY-MM-DDTHH:MM:SS+00:00>

The request start time for the search. Has to be later than now minus 24h.

end
required
string <YYYY-MM-DDTHH:MM:SS+00:00>

The request end time for the search. Has to be later than start.

rental
required
string
Enum: "long" "short"

The type of rental to search for.

type
required
string
Enum: "parking" "garage" "both"

The type of space to search for

space_size
string
Enum: "small" "medium" "large" "van" "minibus"

The size of vehicle the spaces need to accommodate

radius
string
Default: "10mi"

The search radius in miles

price_pins
boolean
Default: false

Include base64 encoded price-pins in the response

with
string
Default: "location"
Enum: "location" "features"

Any additional information that needs including in the response

spaces_available
string
include_booked
boolean

Include booked spaces in the response. Booked spaces are marked as waiting_list: true.

season_plan
string
Enum: "mon-sun" "mon-fri" "any-three-days"

Filter spaces with the requested plan. Behaviour differs slightly based on the value of the Platform header.

  • ios: Will return exact plan matches only.
  • default: Will return exact plan matches first. If there's a secondary plan match, these will come after primary matches. Each subset is ordered by distance iff no sort given, or sort is location (i.e. default). If season_plan is given with and a sort (which isn't location), the sorting by primary plan first and secondary plan is removed. They are still filtered, but ordered by sort.
sort
string
Enum: "reviews" "price" "location"

Sort results by average review (desc), or price (asc), or location (asc, default)

page
required
integer [ 1 .. 100 ]

The number of results to return per page

per_page
required
integer
offset
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Search for a location by Site ID

Perform a search for a location by the specified Site ID or by latitude and longitude (closest location with a Site ID) Warning this search endpoint does not check availability.

Authorizations:
application
query Parameters
location
string

The Site ID to search for. These are normally prefixed with 1089

lat
string

The latitude to find Site IDs close to

lng
string

The longitude to find Site IDs close to

page
integer

Results page number

per_page
integer

Limit the search results

radius
string

NOT AVAILABLE YET! Will be added in YPS-8694. Example values '0.5mi', '0.25km'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search for EV charging points

Allows to search for EV charge points

Authorizations:
application
query Parameters
connector_types[]
Array of strings

Search for any of given connector types. Expects the connector's slug property as value, e.g. type_2_mennekes. If not provided or all option is used, then it will return any connector type.

lat
string

The latitude to find EV chargers close to

lng
string

The longitude to find EV chargers close to

page
integer

Results page number

per_page
integer

Search result page size. Default value is 50.

radius
string

Search radius in miles. Example value '0.5mi'. If not provided, defaults to 10mi.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Me

Get information on current authenticated user

Authorizations:
user

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "mobile": "string",
  • "date_of_birth": "string",
  • "city": "string",
  • "postcode": "string",
  • "login_hash": "string",
  • "notification_preferences": {
    },
  • "profile_image_url": "string",
  • "social": {
    },
  • "is_admin": true
}

Update the users details

Authorizations:
user
Request Body schema: application/json
first_name
string
last_name
string
mobile
string
date_of_birth
string
email
string
city
string
postcode
string
fcm_token
string
object

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "mobile": "string",
  • "date_of_birth": "string",
  • "email": "string",
  • "city": "string",
  • "postcode": "string",
  • "fcm_token": "string",
  • "notification_preferences": {
    }
}

Update the users details

Authorizations:
user
Request Body schema: application/json
first_name
string
last_name
string
mobile
string
fcm_token
string
marketing_consent_given
boolean

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "mobile": "string",
  • "fcm_token": "string",
  • "marketing_consent_given": true
}

Update the users profile image

Authorizations:
user
Request Body schema: multipart/form-data
profile_image
string <binary>

Responses

Update the users password

Authorizations:
user
Request Body schema: application/json
current_password
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "current_password": "string",
  • "password": "string"
}

Update VAT status

Update VAT status and VAT number of a user.

Authorizations:
user
Request Body schema: application/json

The VAT settings to use for the update.

vat_registered
boolean
vat_number
string

Responses

Request samples

Content type
application/json
{
  • "vat_registered": true,
  • "vat_number": "string"
}

List user's referral codes

Get a list of referral codes that can be used by the authenticated user

Authorizations:
user
query Parameters
booking-type
string
Enum: "short-term" "long-term" "both"
booking-value
number <0.00>
location
number

ID of the space that we are going to book

vehicle-reg
string

Vehicle registration

start-date
string

start date & time of booking

include-expired
string
Enum: true false

include vouchers expired up to 10 days ago

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a referral code

Add a referral code to the current user.

Authorizations:
user
Request Body schema: application/json
voucher
required
string

Responses

Request samples

Content type
application/json
{
  • "voucher": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Order existing referral codes

Change order of current user's referral codes.

Authorizations:
user
Request Body schema: application/json
vouchers
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "vouchers": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

List user's features

List all features that are enabled for the authenticated user

Authorizations:
user

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the latest space bookings

Gets the latest three bookings grouped by spaces

Authorizations:
user

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lists all tenant's confirmed bookings

Authorizations:
user
query Parameters
include
string
Enum: "space" "vehicle" "vehicle.vehicle_data" "states" "receipt" "permit_address" "horizon_barcode"
Example: include=space,vehicle,horizon_barcode
status
string
Enum: "active" "completed" "cancelled" "active_started" "upcoming" "past"
Example: status=upcoming
vrn
string
Example: vrn=ABC123
start_from
string
Example: start_from=24-12-2023
start_to
string
Example: start_to=24-12-2023
space_id
integer
Example: space_id=4294961145

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get notification settings

Authorizations:
user

Responses

Response samples

Content type
application/json
{
  • "reminder": {
    },
  • "general": {
    },
  • "confirmation": {
    }
}

Set notification settings

Request Body schema: application/json
booking-reminder-tenant
Array of strings
general
Array of strings
booking-confirmation-tenant
Array of strings

Valid items value - 'sms'

Responses

Request samples

Content type
application/json
{
  • "booking-reminder-tenant": "email",
  • "general": "email",
  • "booking-confirmation-tenant": [
    ]
}

Get SO notification settings

Authorizations:
user

Responses

Response samples

Content type
application/json
{
  • "reminder": {
    },
  • "general": {
    },
  • "confirmation": {
    }
}

Set notification settings

Request Body schema: application/json
booking-reminder-tenant
Array of strings
general
Array of strings
booking-confirmation-tenant
Array of strings

Valid items value - 'sms'

Responses

Request samples

Content type
application/json
{
  • "booking-reminder-tenant": "email",
  • "general": "email",
  • "booking-confirmation-tenant": [
    ]
}

Get SO tax information

Authorizations:
user

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Set SO tax information

Request Body schema: application/json
account_type
required
string
Enum: "private-individual" "private-business" "commercial"
name
required
string

Labels:

  • account_type is private-individual: Full name
  • account_type is private-business: Personal or business name
  • account_type is commercial: Legal Entity Name
address
required
string

Labels:

  • account_type is private-individual: Primary Residential Address
  • account_type is private-business: Primary business address
  • account_type is commercial: Registered Address
date_of_birth
string <Y-m-d>

Required only when account_type is private-individual.

country
required
string
Enum: "uk" "other"

Required only when account_type is private-business.

company_registration_number
string

Required only when:

  • account_type is private-business and company_registration_country is uk, or
  • account_type is commercial

Labels:

  • Company registration number
tax_identification_number
required
string

Labels:

  • account_type is private-individual: Tax Identification Number
  • account_type is private-business and company_registration_country is uk: Unique tax reference number
  • account_type is private-business and company_registration_country is other: Tax Identification Number
  • account_type is commercial: Tax Identification Number

Responses

Request samples

Content type
application/json
{
  • "account_type": "private-individual",
  • "name": "John Smith",
  • "address": "1 Some Street, Town, AA1 1AA",
  • "date_of_birth": "1990-01-01",
  • "country": "uk",
  • "company_registration_number": "string",
  • "tax_identification_number": "AA123456A"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get space owner's account value

Get the account value of the authenticated space owner

Authorizations:
user
query Parameters
historic_months
integer [ 1 .. 24 ]

Number of months back from now to include. Returns current month if not provided.

Responses

Response samples

Content type
application/json
{
  • "year": 2024,
  • "month": 7,
  • "amount": 42.5,
  • "currency": "GBP",
  • "formatted_amount": "£42.50"
}

Get space owner's PayPal payment details

Get the details of PayPal payout preference for space owners.

Authorizations:
user

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Set space owner's PayPal payment details

Set the details of PayPal payout preference for space owners.

Authorizations:
user
Request Body schema: application/json
bank_country_code
required
string

ISO-3316-3 digit country code

paypal_email
required
string

Email address of PayPal account to send SO earnings

Responses

Request samples

Content type
application/json
{
  • "bank_country_code": "GBR",
  • "paypal_email": "john.smith@yourparkingspace.co.uk"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get space owner's bank transfer payment details

Get the details of bank transfer payout preference for space owners.

Authorizations:
user

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Set space owner's PayPal payment details

Set the details of PayPal payout preference for space owners.

Authorizations:
user
Request Body schema: application/json
bank_country_code
required
string

ISO-3316-3 digit country code

account_holder_name
required
string

Name of account holder

bank_account_number
required
string

Bank account number. Validation depends on bank_country_code.

bank_sort_code
Array of any

Bank sort code (list of digits). Required when bank_country_code is GBR.

Responses

Request samples

Content type
application/json
{
  • "bank_country_code": "GBR",
  • "account_holder_name": "John Smith",
  • "bank_account_number": 12345678,
  • "bank_sort_code": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Send an email with attached VAT receipt in PDF format

Authorizations:
user

Responses

Vehicles

List vehicles

List the vehicles that are attached to the current user.

Authorizations:
user
query Parameters
include
string
Value: "vehicle_data"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a vehicle

Add a vehicle to the current user.

Authorizations:
user
Request Body schema: application/json
reference
string
registration_number
string
object

Responses

Request samples

Content type
application/json
{
  • "reference": "M6 SOJ",
  • "registration_number": "M6SOJ",
  • "custom_data": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "reference": "M6 SOJ",
  • "registration_number": "M6SOJ",
  • "default": false,
  • "vehicle_data": {}
}

View a vehicle's information

Authorizations:
user
path Parameters
id
required
integer
Example: 1
query Parameters
include
string
Value: "vehicle_data"

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "reference": "M6 SOJ",
  • "registration_number": "M6SOJ",
  • "default": false,
  • "vehicle_data": {}
}

Update a vehicle

Update the reference or registration number of a vehicle.

Authorizations:
user
path Parameters
id
required
integer
Example: 1
Request Body schema: application/json

Vehicle data

reference
string
registration_number
string
object

Responses

Request samples

Content type
application/json
{
  • "reference": "M6 SOJ",
  • "registration_number": "M6SOJ",
  • "custom_data": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "reference": "M6 SOJ",
  • "registration_number": "M6SOJ",
  • "default": false,
  • "vehicle_data": {}
}

Set default vehicle

Change the default vehicle for the current user.

Authorizations:
user
path Parameters
id
required
integer
Example: 1
Request Body schema: application/json

Default vehicle

default
required
boolean

Responses

Request samples

Content type
application/json
{
  • "default": true
}

Delete a vehicle

Delete a vehicle from those attached to the user.

Authorizations:
user
path Parameters
id
required
integer
Example: 1

Responses

Retrieve vehicle information

Retrieve information for the vehicle registered to a specific VIN

Authorizations:
application
path Parameters
registration
required
string
Example: M6SOJ

The vehicle registration to query

query Parameters
refresh_if_unroadworthy
boolean
Example: refresh_if_unroadworthy=true

Optional - If the vehicle is unroadworthy and refresh is available, then the vehicle data will be refreshed before returning it.

Responses

Response samples

Content type
application/json
{}

Retrieve a list of vehicle makes

Retrieve a filtered list of known vehicle makes

Authorizations:
application

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Assign a vehicle to bookings

Assign a given vehicle to all user's bookings which do not have a vehicle assigned

Authorizations:
user
path Parameters
id
required
integer
Example: 425968721

Responses

Bookings

Get all tenant's confirmed bookings

Authorizations:
user
query Parameters
include
string
Enum: "space" "vehicle" "vehicle.vehicle_data" "states" "receipt" "permit_address" "horizon_barcode"
Example: include=space,vehicle,horizon_barcode
status
string
Enum: "active" "completed" "cancelled" "active_started" "upcoming" "past"
Example: status=upcoming
order_by
string
Enum: "start" "created_at"
Example: order_by=start
order_direction
string
Enum: "asc" "desc"
Example: order_direction=asc
vrn
string
Example: vrn=ABC123
start_from
string
Example: start_from=24-12-2023
start_to
string
Example: start_to=24-12-2023
space_id
integer
Example: space_id=4294961145

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get a driver's booking

Get booking details.

Authorizations:
user
path Parameters
id
required
integer
Example: 1
query Parameters
include
string
Enum: "space" "vehicle" "vehicle.vehicle_data" "states" "receipt" "permit_address" "horizon_barcode"
Example: include=space,vehicle,horizon_barcode

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "confirmed": true,
  • "value": "4.28",
  • "price": 0,
  • "service_fee": 0,
  • "price_paid_with_service_fee": 0,
  • "currency": {
    },
  • "start": "2018-09-13T10:30:00+01:00",
  • "end": "2018-09-13T10:30:00+01:00",
  • "created_at": "2018-09-13T10:30:00+01:00",
  • "duration": {
    },
  • "has_review": true,
  • "review_required": true,
  • "post_booking_info": "string",
  • "access": {
    },
  • "show_landlord": true,
  • "commission": 0,
  • "barcode": "string",
  • "cancelled_at": "2018-09-13T10:30:00+01:00",
  • "term": "string",
  • "calendar_link": "string",
  • "billing_interval_count": 0,
  • "next_billing_date": "1st Jan 2020",
  • "horizon_barcode": "string",
  • "is_pay_by_mobile": true,
  • "qrCode": "string",
  • "group_booking_id": 0,
  • "states": {
    },
  • "products": {
    },
  • "totalProductsValue": 0.99,
  • "season_plan": "mon-sun",
  • "space": {},
  • "arrangement_fee": 5
}

Update a booking

Update the registration of the vehicle assigned to the booking, or extend/reduce the duration of the booking.

Authorizations:
user
path Parameters
id
required
integer
Example: 1
Request Body schema: application/json
vehicle_id
integer
start
required
string <YYYY-MM-DDTHH:MM:SS+00:00>
end
required
string <YYYY-MM-DDTHH:MM:SS+00:00>
biller
string
token
string
card_id
integer
products_to_cancel
Array of integers

IDs of products you want to cancel when updating booking.

Responses

Request samples

Content type
application/json
{
  • "vehicle_id": 0,
  • "start": "string",
  • "end": "string",
  • "biller": "string",
  • "token": "string",
  • "card_id": 0,
  • "products_to_cancel": [
    ]
}

Update a booking

Update the registration of the vehicle assigned to the booking, or extend/reduce the duration of the booking.

Authorizations:
user
path Parameters
id
required
integer
Example: 1
Request Body schema: application/json
vehicle_id
integer
start
required
string <YYYY-MM-DDTHH:MM:SS+00:00>
end
required
string <YYYY-MM-DDTHH:MM:SS+00:00>
biller
string
token
string
card_id
integer
products_to_cancel
Array of integers

IDs of products you want to cancel when updating booking.

Responses

Request samples

Content type
application/json
{
  • "vehicle_id": 0,
  • "start": "string",
  • "end": "string",
  • "biller": "string",
  • "token": "string",
  • "card_id": 0,
  • "products_to_cancel": [
    ]
}

Cancellation reasons

Get all of the available cancellation reasons for a booking, including if they require additional text.

Authorizations:
user
query Parameters
full-list
boolean
Example: full-list=true

Optional - if included will return full list with sub-reasons

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cancel a booking

Cancel the specified booking for the current user.

Authorizations:
user
path Parameters
id
required
integer
Example: 1
Request Body schema: application/json
cancellation_reason_id
integer
cancellation_reason_text
string

Responses

Request samples

Content type
application/json
{
  • "cancellation_reason_id": 1,
  • "cancellation_reason_text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
}

Obtain a extension quote

Request a quote for either extending or reducing the duration of a booking.

Authorizations:
user
path Parameters
id
required
integer
Example: 1
Request Body schema: application/json
start
string <YYYY-MM-DDTHH:MM:SS+00:00>
end
string <YYYY-MM-DDTHH:MM:SS+00:00>

Responses

Request samples

Content type
application/json
{
  • "start": "2018-02-12T13:00:00+01:00",
  • "end": "2018-02-17T13:00:00+01:00"
}

Response samples

Content type
application/json
{
  • "value": 0,
  • "valueBeforeDiscount": 0,
  • "serviceFee": 0.99,
  • "serviceFeeBeforeDiscount": 0.99,
  • "arrangementFee": 5,
  • "deposit": 0,
  • "discountedDeposit": 0,
  • "additionalPayment": 0,
  • "additionalData": { },
  • "warning": "string",
  • "currency": {
    },
  • "first_billing_date": "2020-11-24",
  • "next_billing_date": "2020-12-24",
  • "products": [
    ],
  • "totalProductsValue": 0.99
}

Generate PDF of VAT receipt for a booking

Download or email a VAT receipt for a given booking in PDF format

Authorizations:
user
path Parameters
id
required
integer
Example: 1
download
required
string
Example: download

Optional. Specify how to view the PDF, either download or email. Defaults to download if excluded

Responses

Skips the required review for a booking

Sets the review required property for the booking to false

Authorizations:
user
path Parameters
id
required
integer
Example: 1

Responses

Cancel a booking product.

Cancel a booking product.

Authorizations:
user
path Parameters
id
required
integer
Example: 1
booking_product_id
required
integer
Example: 1

Responses

Booking ending reasons

Get reasons for ending a long term booking. Can be used to get all reasons or just reasons that belong to specific parent by providing parent_id

Authorizations:
user
query Parameters
parent_id
integer
Example: parent_id=24

Optional - if included, will only return sub-reasons that belong to given main reason. If 0 value is used, then will only return the main reasons.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Locations of driver's bookings

Get a list of locations, in which the logged in driver has made bookings

Authorizations:
user
query Parameters
status
required
string
Enum: "active" "past" "completed" "cancelled"
Example: status=active

Responses

Response samples

Content type
application/json
[
  • {
    }
]

End a long term booking

Submit the end date for a long term booking.

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 1
Request Body schema: multipart/form-data
required
end_date
required
string <YYYY-MM-DD>
ending_reason_id
required
integer
additional_comment
string

Required when the "Other" is selected.

attachment
string <binary>

Required when the "PCN" option is selected.

Responses

View booking products

View a list of all products purchased for a booking

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Purchase one or more products

Purchase one or more products to be associated with a booking

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 1
Request Body schema: multipart/form-data
Array of objects (ProductQuote)

Ancillary products to quote

biller
string

Biller to use for payment

card_id
integer

YPS ID of driver payment method (i.e. card). Required if no token

token
string

Token of new payment method (i.e. when user has added a new card). Required if no card_id

object

Used for 3DS authentication

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_products_value": {
    }
}

View booking product

View a product purchased for a booking

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 1
booking_product_id
required
integer
Example: 1

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a purchased product

Update a purchased product for a booking including taking any required payment or processing refunds

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 1
booking_product_id
required
integer
Example: 1
Request Body schema: multipart/form-data
price
number

Additional amount to pay, or amount to refund, for product (in minor units)

Uber product request (object) or Fast Track Security product update request (object) or Airport Lounge product update request (object)

Product specific data

biller
string

Biller to use for payment

card_id
integer

YPS ID of driver payment method (i.e. card). Required if no token

token
string

Token of new payment method (i.e. when user has added a new card). Required if no card_id

object

Used for 3DS authentication

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Perform actions after a booking is refunded

Creates a promo code as a compensation for given booking

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 4568160

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "id": 0,
  • "type": "string",
  • "value": 0
}

Get all SO bookings

Get all paginated space owner bookings with optional filtering of status

Authorizations:
user
query Parameters
status
string
Example: status=completed,cancelled

Comma separate list of booking statuses to filter by

order_by
string
Enum: "start" "created_at" "end"
Example: order_by=start
order_direction
string
Enum: "asc" "desc"
Example: order_direction=asc
term
string
Enum: "one-off" "mon-sun" "mon-fri" "any-three-days"
Example: term=one-off,mon-fri

Comma separated list of terms

search
string
Example: search=2 Some Street

Free text search on bookings. Looks at VRN, space address/postcode, tenant name/email

between_start
string <Y-m-d>
Example: between_start=2023-01-01

If start date is given but no end date, end date will be now + 10 years

between_end
string <Y-m-d>
Example: between_end=2024-01-01

If start date is given but no end date, end date will be now + 10 years

space_ids
string
Example: space_ids=1234,9876

Comma separated list of space IDs to check for bookings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get SO 'in progress' bookings

Get paginated space owner bookings that are active and in progress.

Authorizations:
user
query Parameters
space_id
integer
Example: space_id=425968721

Optional - if included will return bookings for given location

order_by
string
Enum: "start" "created_at" "end"
Example: order_by=start
order_direction
string
Enum: "asc" "desc"
Example: order_direction=asc
term
string
Enum: "one-off" "mon-sun" "mon-fri" "any-three-days"
Example: term=one-off,mon-fri

Comma separated list of terms

search
string
Example: search=2 Some Street

Free text search on bookings. Looks at VRN, space address/postcode, tenant name/email

between_start
string <Y-m-d>
Example: between_start=2023-01-01

If start date is given but no end date, end date will be now + 10 years

between_end
string <Y-m-d>
Example: between_end=2024-01-01

If start date is given but no end date, end date will be now + 10 years

space_ids
string
Example: space_ids=1234,9876

Comma separated list of space IDs to check for bookings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get SO upcoming bookings

Get paginated space owner bookings that are active and upcoming.

Authorizations:
user
query Parameters
space_id
integer
Example: space_id=425968721

Optional - if included will return bookings for given location

order_by
string
Enum: "start" "created_at" "end"
Example: order_by=start
order_direction
string
Enum: "asc" "desc"
Example: order_direction=asc
term
string
Enum: "one-off" "mon-sun" "mon-fri" "any-three-days"
Example: term=one-off,mon-fri

Comma separated list of terms

search
string
Example: search=2 Some Street

Free text search on bookings. Looks at VRN, space address/postcode, tenant name/email

between_start
string <Y-m-d>
Example: between_start=2023-01-01

If start date is given but no end date, end date will be now + 10 years

between_end
string <Y-m-d>
Example: between_end=2024-01-01

If start date is given but no end date, end date will be now + 10 years

space_ids
string
Example: space_ids=1234,9876

Comma separated list of space IDs to check for bookings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get SO completed bookings

Get paginated space owner bookings that are completed.

Authorizations:
user
query Parameters
space_id
integer
Example: space_id=425968721

Optional - if included will return bookings for given location

order_by
string
Enum: "start" "created_at" "end"
Example: order_by=start
order_direction
string
Enum: "asc" "desc"
Example: order_direction=asc
term
string
Enum: "one-off" "mon-sun" "mon-fri" "any-three-days"
Example: term=one-off,mon-fri

Comma separated list of terms

search
string
Example: search=2 Some Street

Free text search on bookings. Looks at VRN, space address/postcode, tenant name/email

between_start
string <Y-m-d>
Example: between_start=2023-01-01

If start date is given but no end date, end date will be now + 10 years

between_end
string <Y-m-d>
Example: between_end=2024-01-01

If start date is given but no end date, end date will be now + 10 years

space_ids
string
Example: space_ids=1234,9876

Comma separated list of space IDs to check for bookings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get SO cancelled bookings

Get paginated space owner bookings that are cancelled.

Authorizations:
user
query Parameters
space_id
integer
Example: space_id=425968721

Optional - if included will return bookings for given location

order_by
string
Enum: "start" "created_at" "end"
Example: order_by=start
order_direction
string
Enum: "asc" "desc"
Example: order_direction=asc
term
string
Enum: "one-off" "mon-sun" "mon-fri" "any-three-days"
Example: term=one-off,mon-fri

Comma separated list of terms

search
string
Example: search=2 Some Street

Free text search on bookings. Looks at VRN, space address/postcode, tenant name/email

between_start
string <Y-m-d>
Example: between_start=2023-01-01

If start date is given but no end date, end date will be now + 10 years

between_end
string <Y-m-d>
Example: between_end=2024-01-01

If start date is given but no end date, end date will be now + 10 years

space_ids
string
Example: space_ids=1234,9876

Comma separated list of space IDs to check for bookings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get vehicle for a booking

Get the user vehicle assigned to a specific booking

Authorizations:
user
path Parameters
bookingId
required
integer
Example: 425968721

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "reference": "M6 SOJ",
  • "registration_number": "M6SOJ",
  • "default": false,
  • "vehicle_data": {}
}

Get a list of all bookings active (in progress) at the given time for the given VRN

Only accessable from internal network

query Parameters
vrn
required
string

VRN of vehicle for bookings

datetime
required
string <YYYY-MM-DD HH:MM:SS>

Datetime to query for active bookings

space_ids
string

Comma separated list of space IDs to check for bookings

start_time_buffer
integer

Optional number of minutes to add before provided datetime to accept bookings for

end_time_buffer
integer

Optional number of minutes to add after provided datetime to accept bookings for

strict_vrn
boolean

Allows to perform a strict VRN search instead of the default fuzzy search

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of all bookings active (in progress) at the given time for the given VRN

Alternative route, authenticated using client credentials

query Parameters
vrn
required
string

VRN of vehicle for bookings

datetime
required
string <YYYY-MM-DD HH:MM:SS>

Datetime to query for active bookings

space_ids
string

Comma separated list of space IDs to check for bookings

start_time_buffer
integer

Optional number of minutes to add before provided datetime to accept bookings for

end_time_buffer
integer

Optional number of minutes to add after provided datetime to accept bookings for

strict_vrn
boolean

Allows to perform a strict VRN search instead of the default fuzzy search

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Products

Cancel a booking product.

Cancel a booking product.

Authorizations:
user
path Parameters
id
required
integer
Example: 1
booking_product_id
required
integer
Example: 1

Responses

View booking products

View a list of all products purchased for a booking

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 1

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Purchase one or more products

Purchase one or more products to be associated with a booking

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 1
Request Body schema: multipart/form-data
Array of objects (ProductQuote)

Ancillary products to quote

biller
string

Biller to use for payment

card_id
integer

YPS ID of driver payment method (i.e. card). Required if no token

token
string

Token of new payment method (i.e. when user has added a new card). Required if no card_id

object

Used for 3DS authentication

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_products_value": {
    }
}

View booking product

View a product purchased for a booking

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 1
booking_product_id
required
integer
Example: 1

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a purchased product

Update a purchased product for a booking including taking any required payment or processing refunds

Authorizations:
user
path Parameters
booking_id
required
integer
Example: 1
booking_product_id
required
integer
Example: 1
Request Body schema: multipart/form-data
price
number

Additional amount to pay, or amount to refund, for product (in minor units)

Uber product request (object) or Fast Track Security product update request (object) or Airport Lounge product update request (object)

Product specific data

biller
string

Biller to use for payment

card_id
integer

YPS ID of driver payment method (i.e. card). Required if no token

token
string

Token of new payment method (i.e. when user has added a new card). Required if no card_id

object

Used for 3DS authentication

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Chat Bot

Get ChatBot bookings

Get driver's bookings when accessed via the chat bot. Currently limited on backend to 10 results.

Authorizations:
user
query Parameters
booking_id
integer

Allows to fetch a particular booking

term
string
Enum: "short" "long"

Fetch short / long term bookings

only_endable
boolean

When provided and is true, will return long term bookings that can be ended at present moment

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Knowledge Engine

Get Booking details for Knowledge Engine.

Get booking details in a format useful to the Knowledge Engine via Client Credentials.

Authorizations:
application
query Parameters
booking_id
integer

Fetch a booking with a specific ID

payment_id
integer

Fetch a booking associated with this payment ID

Responses

Response samples

Content type
application/json
{
  • "id": 864705,
  • "price": 50,
  • "currency": "GBP",
  • "start": "2024-04-25T00:00:00+01:00",
  • "end": null,
  • "created_at": "2024-04-23T17:33:50+01:00",
  • "term": "Short term",
  • "billing_interval_count": 1,
  • "billing_interval_label": "Once per month",
  • "stripe_subscription_id": "sub_1P8mJ1B1C7jL2S3wQxIWFb6c",
  • "space": {
    },
  • "vehicle": {
    },
  • "payments": [
    ]
}

Payments

List all the users payment methods

List all of the users payment methods, with additional information such as the types of bookings they can be used for. If 'biller' parameter is provided, then we will only return cards for given biller. Otherwise it will return cards for currently enabled biller.

Authorizations:
user
query Parameters
biller
string
Example: biller=stripe

Responses

Response samples

Content type
application/json
{
  • "id": 119271,
  • "brand": "MasterCard",
  • "last4": "3093",
  • "expiry_year": 2021,
  • "expiry_month": 1,
  • "reference": "xxxx-xxxx-xxxx-3093",
  • "default": true
}

Store a payment method

Stores a new payment method either via token or payment method ID

Authorizations:
user
Request Body schema: application/json
biller
string

Required with biller

card_id
integer
authentication_response
Array of strings

Required without token

token
string

Required without authentication_response and with biller

skip
boolean

Used alongside user impersonation to set a null biller

default
boolean

Indicates if new payment method should be the default

Responses

Request samples

Content type
application/json
{
  • "biller": "stripe",
  • "card_id": 123,
  • "authentication_response": [
    ],
  • "token": "abc123",
  • "skip": true,
  • "default": true
}

Response samples

Content type
application/json
{
  • "id": 119271,
  • "brand": "MasterCard",
  • "last4": "3093",
  • "expiry_year": 2021,
  • "expiry_month": 1,
  • "reference": "xxxx-xxxx-xxxx-3093",
  • "default": true
}

Update a users payment method

Updates a users payment method reference or set as the default payment

Authorizations:
user
path Parameters
id
required
integer
Example: 1
Request Body schema: application/json
default
boolean

Indicates if payment method should be the default

reference
string

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "reference": "xxxx-xxxx-xxxx-3093"
}

Response samples

Content type
application/json
{
  • "id": 119271,
  • "brand": "MasterCard",
  • "last4": "3093",
  • "expiry_year": 2021,
  • "expiry_month": 1,
  • "reference": "xxxx-xxxx-xxxx-3093",
  • "default": true
}

Delete a users payment method

Authorizations:
user
path Parameters
id
required
integer
Example: 1

Responses

Fetch a Braintree token

Authorizations:
application

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Location

Returns city data for a given city ID

Authorizations:
application
path Parameters
cityId
required
integer
Example: 5300

ID of the city

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Spaces

Returns location info for given space IDs

Authorizations:
application
Request Body schema: application/json
ids
required
string

Responses

Request samples

Content type
application/json
{
  • "ids": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get space details

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
query Parameters
include
string
Enum: "streetview" "availability" "video" "display_access_times" "what_three_words" "city" "opening_hours" "linked_locations" "seo" "is_upsell_eligible"

Responses

Response samples

Content type
application/json
{
  • "id": 4294955136,
  • "title": "Parking on Exchange House, N8",
  • "access_times": {
    },
  • "description": "<p>One allocated space located on Exchange House in London</p>",
  • "additional_information": "string",
  • "approved": 1,
  • "post_booking_info": "string",
  • "rental_terms": "string",
  • "image_url": "https://yourparkingspace.co.uk/file/medium/5bfdea170bd8dc1d366027933484c223/991e29ce74a763b72e2208934f2bc4331553186200.jpeg",
  • "price_matrix": {
    },
  • "quote": {
    },
  • "currency": {
    },
  • "space_type": "residential_car_park",
  • "owner_type": "private",
  • "max_access_height": "3.50",
  • "rental_types": {
    },
  • "reviews": {
    },
  • "distance": {
    },
  • "enabled": true,
  • "waiting_list": true,
  • "rewards": true,
  • "overnight": true,
  • "schedule": "allweek",
  • "follow_up": 0,
  • "listing_completed_at": {
    },
  • "dynamic_pricing": 0,
  • "notice_periods": {
    },
  • "landlord_id": 0,
  • "archived": true,
  • "monthly_deposit_required": true,
  • "allow_phone_prebookings": true,
  • "lt_pricing_type": "standard",
  • "lt_available_from": {
    },
  • "force_vrn": true,
  • "multi_bookings": {
    },
  • "upper_period_limit": 365,
  • "permit_required": true,
  • "post_pay": {
    },
  • "site_id": 0,
  • "default_cashless_tab": "exit",
  • "post_pay_anpr": true,
  • "should_be_indexed": true,
  • "meta_description": "string",
  • "skip_availability_check_cashless": true,
  • "cashless_minutes_for_prebook_rate": 0,
  • "location": {
    },
  • "address": {
    },
  • "sizes": {
    },
  • "features": {
    },
  • "images": {},
  • "streetview": {},
  • "availability": {
    },
  • "video": "string",
  • "display_access_times": [
    ],
  • "opening_hours": [
    ],
  • "what_three_words": {},
  • "linked_locations": {
    },
  • "seo": {
    },
  • "lt_rental_enabled": true,
  • "lt_pricing": {
    },
  • "lt_season_pricing": [
    ],
  • "update_vrn_restriction": "active",
  • "limit_vrn_discounts": false,
  • "requires_roadworthy_vehicle": false,
  • "roadworthy_grace_period_days": 14,
  • "disable_paypal_st": false,
  • "disable_paypal_lt": false,
  • "hide_webloyalty": false,
  • "airport_space": true,
  • "airport_code": "MAN",
  • "airport_name": "Manchester Airport",
  • "is_upsell_eligible": true
}

Get reduced space info

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564

Responses

Response samples

Content type
application/json
{}

Get space future availability

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
query Parameters
start
string
Example: start=2022-02-14T11:30:00+00:00

Required if end is provided. If not provided, current date and time will be used.

end
string
Example: end=2022-03-14T11:30:00+00:00

Required if start is provided. Must be later than start. If not provided, current date and time + space's upper period limit will be used (up to 1 year).

rental
string
Enum: "short" "long"
Example: rental=long

If the parameter is not provided it will be classed as “short“.

Responses

Response samples

Content type
application/json
{
  • "low_availability": [
    ],
  • "unavailable": [
    ],
  • "unavailable_access_times": [
    ],
  • "fully_booked": {
    }
}

Submit an enquiry for a space

Creates an enquiry record, emailing the customer a confirmation

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
Request Body schema: application/json
first_name
string
last_name
string
mobile
string
email
string
type
string
message
string
start_date
string
end:date
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "mobile": "string",
  • "email": "string",
  • "type": "shortterm",
  • "message": "string",
  • "start_date": "string",
  • "end:date": "string"
}

Get a booking quote

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
Request Body schema: application/json
start
string <ISO8601>

Start date - required unless start_date is provided

end
string <ISO8601>

End date - required for short term bookings with start

email
string

optional email address

vehicle_reg
string

optional vrm

interval_count
integer

For long term bookings only

id
integer

Space ID

rental
string
Enum: "short" "long"

Rental type of the booking

start_date
string <Y-m-d>

Start date (legacy) - required unless start is provided

start_time
string <H:i>

Start time (legacy) - required with start_date

end_date
string <Y-m-d>

End date (legacy)

end_time
string <H:i>

End time (legacy) - required with end_date

book_now
boolean

Allows to by-pass the availability checks, is required for Cashless availability setting to work, activates the check for Book Now access hours warning, switches off time rounding to the nearest 30 mins, tells the quoter to use cashless tariffs under certain conditions.

skip_availability
boolean

Allows to by-pass the quote validation, e.g. validity of start & end dates, amount of notice, overnight booking, maximum bookable duration, available from, etc.

upgrade_booking
integer

Booking ID - is used when upgrading an existing LT booking to a season ticket

voucher_code
string

Optional voucher code to apply to booking quote

Array of objects (ProductQuote)

Ancillary products to quote

season_plan
string (SeasonPlan)
Enum: "mon-sun" "mon-fri" "any-three-days"

Responses

Request samples

Content type
application/json
{
  • "start": "2019-06-27T14:00:00+01:00",
  • "end": "2019-06-27T16:00:00+01:00",
  • "email": "john.doe@gmail.com",
  • "vehicle_reg": "TESTABC",
  • "interval_count": 0,
  • "id": 0,
  • "rental": "short",
  • "start_date": "2019-06-27",
  • "start_time": "14:00",
  • "end_date": "2019-06-28",
  • "end_time": "16:00",
  • "book_now": true,
  • "skip_availability": true,
  • "upgrade_booking": 0,
  • "voucher_code": "string",
  • "products": [
    ],
  • "season_plan": "mon-sun"
}

Response samples

Content type
application/json
{
  • "value": 0,
  • "valueBeforeDiscount": 0,
  • "serviceFee": 0.99,
  • "serviceFeeBeforeDiscount": 0.99,
  • "arrangementFee": 5,
  • "deposit": 0,
  • "discountedDeposit": 0,
  • "additionalPayment": 0,
  • "additionalData": { },
  • "warning": "string",
  • "currency": {
    },
  • "first_billing_date": "2020-11-24",
  • "next_billing_date": "2020-12-24",
  • "products": [
    ],
  • "totalProductsValue": 0.99
}

Apply a referral code to a booking quote

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
Request Body schema: application/json
code
string

Textual discount code

id
integer

Space ID

reservation_id
integer

Required unless quote is provided

quote
number <0.00>

Required unless reservation_id is provided

type
string
Enum: "short" "long"

Rental type of the booking

vehicle_reg
string

optional vrm

start
string <YYYY-MM-DD HH:MM:SS>

Responses

Request samples

Content type
application/json
{
  • "code": "YPS10OFF",
  • "id": 0,
  • "reservation_id": 0,
  • "quote": 0,
  • "type": "short",
  • "vehicle_reg": "string",
  • "start": "string"
}

Response samples

Content type
application/json
{
  • "price": {
    },
  • "currency": {
    },
  • "voucher": {
    }
}

Quote the service fee for multi-day bookings

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
Request Body schema: application/json
amount
number <0.00>

Total amount of all multi-day bookings

Responses

Request samples

Content type
application/json
{
  • "amount": 12.65
}

Response samples

Content type
application/json
{
  • "serviceFee": 0.99,
  • "currency": {
    }
}

Get a multi booking quote

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
Request Body schema: application/json
Array of objects (MultiBookingsQuote)
book_now
boolean

Allows to by-pass the availability checks

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ]
}

Response samples

Content type
application/json
{
  • "quotes": [
    ],
  • "totalValue": 0,
  • "totalValueBeforeDiscount": 0,
  • "serviceFee": 0.99,
  • "serviceFeeBeforeDiscount": 0.99,
  • "currency": {
    },
  • "overallTotalProductsValue": 1.99
}

Creates a reservation / multiple reservations and returns relevant IDs

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
Request Body schema: application/json
terms_and_conditions_accepted
required
boolean
id
integer

Space ID

start
string <YYYY-MM-DDTHH:MM:SS+00:00>

Required unless start_date or reservations is provided

end
string <YYYY-MM-DDTHH:MM:SS+00:00>
interval_count
integer

Used for season tickets

start_date
string <YYYY-MM-DD>

Required unless start or reservations is provided

start_time
string <HH:MM:SS>

Required with start_date

end_date
string <YYYY-MM-DD>

Required with end_time

end_time
string <HH:MM:SS>

Required with end_date

Array of objects (MultiBookingsQuote)

For multi-day bookings only

created_at
string <YYYY-MM-DD HH:MM:SS>
retal
string
Enum: "short" "long"
upgrade_booking
integer
vehicle_id
integer
voucher_id
integer
book_now
boolean

Allows to bypass availability checks. Tags the booking as 'pay-by-phone'. Reserving runs the quoter - see /spaces/{space}/quote for explanation on how it affects the quoting.

skip_rounding
boolean

Allows to bypass time rounding to 30 minute intervals

skip_availability
boolean

Allows to bypass availability checks for non book-now reservations. Reserving runs the quoter - see /spaces/{space}/quote for explanation on how it affects the quoting.

object
object
Array of objects (ProductQuote)

Ancillary products to reserve

season_plan
string
Enum: "mon-sun" "mon-fri" "any-three-days"

Season plan for which to make a LT reservation. Ignored for ST bookings.

Responses

Request samples

Content type
application/json
{
  • "terms_and_conditions_accepted": true,
  • "id": 0,
  • "start": "2018-02-12T13:00:00+01:00",
  • "end": "2018-02-12T14:00:00+01:00",
  • "interval_count": 0,
  • "start_date": "2018-02-12",
  • "start_time": "13:00:00",
  • "end_date": "2018-02-13",
  • "end_time": "14:00:00",
  • "reservations": [
    ],
  • "created_at": "2018-02-12 14:00:00",
  • "retal": "short",
  • "upgrade_booking": 0,
  • "vehicle_id": 0,
  • "voucher_id": 0,
  • "book_now": true,
  • "skip_rounding": true,
  • "skip_availability": true,
  • "permit_address": {
    },
  • "user": {
    },
  • "products": [
    ],
  • "season_plan": "string"
}

Response samples

Content type
application/json
{
  • "billers": [
    ],
  • "reservation_id": 0,
  • "quote_id": 0,
  • "price": "2.56",
  • "price_before_discount": "4.28",
  • "arrangementFee": "5.00",
  • "currency": {
    },
  • "products": [
    ],
  • "totalProductsValue": 0.99
}

Purchase a booking / multiple bookings

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
Request Body schema: application/json
id
integer

Space ID

reservation_id
integer

Required unless reservations is provided

Array of objects (MultiBookingsPurchaseItem)

Required for multi-day bookings

skip
boolean

Allows to skip the payment

biller
string

Required with token

token
string

Required unless card_id is provided

card_id
string

Required unless token is provided

book_now
boolean

Allows to bypass availability checks

upgrade_booking
integer

Required upgrading a monthly booking to season ticket

voucher_id
integer
skip_availability
boolean

Allows to bypass availability checks. Doesn't seem to be currently doing anything more than book_now

awc
string

Awin checksum. Optional.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "reservation_id": 0,
  • "reservations": [
    ],
  • "skip": true,
  • "biller": "string",
  • "token": "string",
  • "card_id": "string",
  • "book_now": true,
  • "upgrade_booking": 0,
  • "voucher_id": 0,
  • "skip_availability": true,
  • "awc": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "confirmed": true,
  • "value": "4.28",
  • "price": 0,
  • "service_fee": 0,
  • "price_paid_with_service_fee": 0,
  • "currency": {
    },
  • "start": "2018-09-13T10:30:00+01:00",
  • "end": "2018-09-13T10:30:00+01:00",
  • "created_at": "2018-09-13T10:30:00+01:00",
  • "duration": {
    },
  • "has_review": true,
  • "review_required": true,
  • "post_booking_info": "string",
  • "access": {
    },
  • "show_landlord": true,
  • "commission": 0,
  • "barcode": "string",
  • "cancelled_at": "2018-09-13T10:30:00+01:00",
  • "term": "string",
  • "calendar_link": "string",
  • "billing_interval_count": 0,
  • "next_billing_date": "1st Jan 2020",
  • "horizon_barcode": "string",
  • "is_pay_by_mobile": true,
  • "qrCode": "string",
  • "group_booking_id": 0,
  • "states": {
    },
  • "products": {
    },
  • "totalProductsValue": 0.99,
  • "season_plan": "mon-sun",
  • "space": {},
  • "arrangement_fee": 5
}

Subscribe to space's waiting list

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
Request Body schema: application/json
email
string
number
string

Phone number

name
string
radius
number

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "number": "string",
  • "name": "string",
  • "radius": 0
}

Get all approved reviews for a space

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new review for a space

Authorizations:
application
path Parameters
space
required
integer
Example: 3798564
Request Body schema: application/json
booking_id
integer
comment
string
rating
integer

Responses

Request samples

Content type
application/json
{
  • "booking_id": 0,
  • "comment": "string",
  • "rating": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "rating": 0,
  • "comment": "string",
  • "created_at": "2010-01-01T09:00:00+00:00"
}

Get SO listings

Get all space owner's locations.

Authorizations:
user
query Parameters
exclude
string
Example: exclude=landlord,image_url

Optional - allows to exclude some data from results. Usage and possible values - URL?exclude=address,landlord,image_url

space_ids
string
Example: space_ids=123456,345678

Optional - comma separated list of space ids to allow filtering

order_direction
string
Example: order_direction=desc

Optional - order direction of updated date

per_page
integer
Example: per_page=30

Optional - number of items to return per page

paginate
boolean
Example: paginate=true

Optional - whether to return all results or use pagination

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Provides recommended pricing for a location

Authorizations:
application
Request Body schema: application/json
lat
number <double>
lng
number <double>
type
string

Responses

Request samples

Content type
application/json
{
  • "lat": 0.1,
  • "lng": 0.1,
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Provides pricing statistics for a given lat and lng

Provides space pricing statistics for daily and hour bookings for spaces in radius of the provided lat and lng

Authorizations:
application
query Parameters
lat
required
string

Latitude

lng
required
string

Longitude

Responses

Response samples

Content type
application/json
{
  • "daily": {
    },
  • "monthly": {
    }
}

Provides parking statistics for a given lat and lng

Provides basic space and review statistics spaces in radius of the provided lat and lng

Authorizations:
application
query Parameters
lat
required
string

Latitude

lng
required
string

Longitude

search_radius
integer
Default: 10

Radius in miles to use for space related statistics.

review_radius
integer
Default: 10

Radius in miles to use for review related statistics.

Responses

Response samples

Content type
application/json
{
  • "spaces_count": 0,
  • "reviews_count": 0.1,
  • "reviews_average_rating": 0.1
}

Provides reviews for spaces within a given lat and lng

Provides 20 most recent approved and Trustpilot eligible reviews for spaces within the given radius of the given lat and lng

Authorizations:
application
query Parameters
lat
required
string

Latitude

lng
required
string

Longitude

radius
integer
Default: 10

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Provides events for a given lat and lng

Provides event information from Ticketmaster for events in radius of the provided lat and lng

Authorizations:
application
query Parameters
lat
required
string

Latitude

lng
required
string

Longitude

amount
number

Amount of events to return (defaults to 5 if not provided)

radius
number

Radius in miles from lat and lng to cover (defaults to 7 if not provided)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Provides a summary of information for a given lat and lng

Provides pricing statistics, parking statistics, location reviews, and nearby events for spaces within the radius of the provided lat and lng

Authorizations:
application
query Parameters
lat
required
string

Latitude

lng
required
string

Longitude

search_radius
integer
Default: 10

Radius in miles to use for space related statistics. Used in parking statistics.

review_radius
integer
Default: 10

Radius in miles to use for review related statistics. Used in parking statistics.

radius
number

Radius in miles. (defaults to 7, for nearby events, and 10, for location reviews, if not provided) Used in location reviews and nearby events.

amount
number

Amount of events to return (defaults to 5 if not provided). Used in nearby events.

Responses

Response samples

Content type
application/json
[
  • null
]

Listings

Create a new space listing

Authorizations:
user
Request Body schema: application/json
object
available_spaces
integer

Minimum value of 1

features
Array of integers

Array of allowed space feature IDs

space_size
Array of integers

Array of allowed space size IDs

available_from
string <Y-m-d\TH:i:sP>
amount_of_notice_required
integer
price_hourly
number
price_daily
number

Required for space that allows short-term bookings

price_monthly
number

Required for space that allows long-term bookings

object

Either all properties or no properties required

listing_progress
object
show_generated_desc
boolean
show_generated_post_booking_desc
boolean
overnight_booking
boolean
access_method
string

security-fob or pincode

access_pin
string

Required if access_method=pincode

access_key_info
string
listing_completed_at
string <Y-m-d\TH:i:sP>
additional_information
string
additional_post_booking_info
string
max_access_height
string
permit
string
allocated
boolean
allocated_info
string
upper_period_limit
integer
dynamic_pricing
boolean
object
enabled
boolean
options
object
keep_bookings
boolean
object

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "available_spaces": 0,
  • "features": [
    ],
  • "space_size": [
    ],
  • "available_from": "2010-01-01T09:00:00+00:00",
  • "amount_of_notice_required": 0,
  • "price_hourly": 0,
  • "price_daily": 0,
  • "price_monthly": 0,
  • "streetview": {
    },
  • "listing_progress": { },
  • "show_generated_desc": true,
  • "show_generated_post_booking_desc": true,
  • "overnight_booking": true,
  • "access_method": "string",
  • "access_pin": "string",
  • "access_key_info": "string",
  • "listing_completed_at": "2010-01-01T09:00:00+00:00",
  • "additional_information": "string",
  • "additional_post_booking_info": "string",
  • "max_access_height": "string",
  • "permit": "string",
  • "allocated": true,
  • "allocated_info": "string",
  • "upper_period_limit": 0,
  • "dynamic_pricing": true,
  • "rental_types": {
    },
  • "enabled": true,
  • "options": { },
  • "keep_bookings": true,
  • "seo": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Display space information

Authorizations:
user
path Parameters
space
required
integer
Example: 12345

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "address": {
    },
  • "features": [
    ],
  • "additional_information": "string",
  • "additional_post_booking_info": "string",
  • "post_booking_info": "string",
  • "rental_terms": "string",
  • "image_url": "string",
  • "space_type": "string",
  • "space_size": "string",
  • "max_access_height": 0,
  • "access_pin": "string",
  • "access_key_info": "string",
  • "permit": "string",
  • "allocated": 0,
  • "allocated_info": "string",
  • "enabled": true,
  • "listing_completed_at": "2010-01-01T09:00:00+00:00",
  • "waiting_list": true,
  • "rewards": true,
  • "overnight_booking": true,
  • "schedule": "string",
  • "schedule_time_start": "09:00:00",
  • "schedule_time_end": "09:00:00",
  • "follow_up": 0,
  • "position": {
    },
  • "available_spaces": 0,
  • "amount_of_notice_required": 0,
  • "available_from": "2010-01-01T09:00:00+00:00",
  • "price_hourly": 0,
  • "price_daily": 0,
  • "price_monthly": 0,
  • "currency": {
    },
  • "upper_period_limit": 0,
  • "listing_progress": [
    ],
  • "dynamic_pricing": 0,
  • "access_method": "string",
  • "streetview": {
    },
  • "rental_types": {
    }
}

Update a given space's information

Authorizations:
user
path Parameters
space
required
integer
Example: 12345
Request Body schema: application/json
object
available_spaces
integer

Minimum value of 1

features
Array of integers

Array of allowed space feature IDs

space_size
Array of integers

Array of allowed space size IDs

available_from
string <Y-m-d\TH:i:sP>
amount_of_notice_required
integer
price_hourly
number
price_daily
number

Required for space that allows short-term bookings

price_monthly
number

Required for space that allows long-term bookings

object

Either all properties or no properties required

listing_progress
object
show_generated_desc
boolean
show_generated_post_booking_desc
boolean
overnight_booking
boolean
access_method
string

security-fob or pincode

access_pin
string

Required if access_method=pincode

access_key_info
string
listing_completed_at
string <Y-m-d\TH:i:sP>
additional_information
string
additional_post_booking_info
string
max_access_height
string
permit
string
allocated
boolean
allocated_info
string
upper_period_limit
integer
dynamic_pricing
boolean
object
enabled
boolean
options
object
keep_bookings
boolean
object

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "available_spaces": 0,
  • "features": [
    ],
  • "space_size": [
    ],
  • "available_from": "2010-01-01T09:00:00+00:00",
  • "amount_of_notice_required": 0,
  • "price_hourly": 0,
  • "price_daily": 0,
  • "price_monthly": 0,
  • "streetview": {
    },
  • "listing_progress": { },
  • "show_generated_desc": true,
  • "show_generated_post_booking_desc": true,
  • "overnight_booking": true,
  • "access_method": "string",
  • "access_pin": "string",
  • "access_key_info": "string",
  • "listing_completed_at": "2010-01-01T09:00:00+00:00",
  • "additional_information": "string",
  • "additional_post_booking_info": "string",
  • "max_access_height": "string",
  • "permit": "string",
  • "allocated": true,
  • "allocated_info": "string",
  • "upper_period_limit": 0,
  • "dynamic_pricing": true,
  • "rental_types": {
    },
  • "enabled": true,
  • "options": { },
  • "keep_bookings": true,
  • "seo": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "address": {
    },
  • "features": [
    ],
  • "additional_information": "string",
  • "additional_post_booking_info": "string",
  • "post_booking_info": "string",
  • "rental_terms": "string",
  • "image_url": "string",
  • "space_type": "string",
  • "space_size": "string",
  • "max_access_height": 0,
  • "access_pin": "string",
  • "access_key_info": "string",
  • "permit": "string",
  • "allocated": 0,
  • "allocated_info": "string",
  • "enabled": true,
  • "listing_completed_at": "2010-01-01T09:00:00+00:00",
  • "waiting_list": true,
  • "rewards": true,
  • "overnight_booking": true,
  • "schedule": "string",
  • "schedule_time_start": "09:00:00",
  • "schedule_time_end": "09:00:00",
  • "follow_up": 0,
  • "position": {
    },
  • "available_spaces": 0,
  • "amount_of_notice_required": 0,
  • "available_from": "2010-01-01T09:00:00+00:00",
  • "price_hourly": 0,
  • "price_daily": 0,
  • "price_monthly": 0,
  • "currency": {
    },
  • "upper_period_limit": 0,
  • "listing_progress": [
    ],
  • "dynamic_pricing": 0,
  • "access_method": "string",
  • "streetview": {
    },
  • "rental_types": {
    }
}

Get limited space information for provided space

Authorizations:
user
path Parameters
space
required
integer
Example: 12345

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "short_address": "string"
}

Get a list of countries in which space owners can create listings

Authorizations:
user

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listings - Availability

Update the space availability

Authorizations:
user
path Parameters
space
required
integer
Example: 12345
Request Body schema: application/json
from
string <Y-m-d>

Required without recurs_on

to
string <Y-m-d>

Required without recurs_on

recurs_on
string

monday, tuesday, wednesday, ..., sunday

available_spaces
integer
hourly_price
number
daily_price
number
schedule_time_start
string <H:i:s>
schedule_time_end
string <H:i:s>
available
boolean
notes
string

Responses

Request samples

Content type
application/json
{
  • "from": "2020-01-01",
  • "to": "2020-01-01",
  • "recurs_on": "string",
  • "available_spaces": 0,
  • "hourly_price": 0,
  • "daily_price": 0,
  • "schedule_time_start": "09:00:00",
  • "schedule_time_end": "09:00:00",
  • "available": true,
  • "notes": "string"
}

Returns spaces recurring granular availability

Authorizations:
application
path Parameters
space
required
integer
Example: 12345

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns space availability for the given or current month

Authorizations:
user
path Parameters
space
required
integer
Example: 12345
month
required
string <Y-m>
Example: 2020-01-01

Not required, will default to current month if not provided

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reset the availability calendar for a space

Authorizations:
user
path Parameters
space
required
integer
Example: 12345

Responses

Listings - Photo

Add a photo to a space

Authorizations:
user
path Parameters
space
required
integer
Example: 12345
Request Body schema: multipart/form-data
add_photo_request
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "default": true,
  • "small": "string",
  • "medium": "string",
  • "large": "string",
  • "thumbnail": "string",
  • "is_streetview": true,
  • "order": 0
}

Set the order of photos for a space

Authorizations:
user
path Parameters
space
required
integer
Example: 12345
Request Body schema: application/json
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Delete a photo

Authorizations:
user
path Parameters
space
required
integer
Example: 12345
photo
required
integer
Example: 12345

Responses

Set the given photo as the default for the space

Authorizations:
user
path Parameters
space
required
integer
Example: 12345
photo
required
integer
Example: 12345

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "default": true,
  • "small": "string",
  • "medium": "string",
  • "large": "string",
  • "thumbnail": "string",
  • "is_streetview": true,
  • "order": 0
}

Listings - Utility

Get the spaces listed for the authenticated user

Authorizations:
user

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the list of available space features

Authorizations:
user

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get the list of available space size values

Authorizations:
user

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Returns validation rules that will be applied to the additional information field

Authorizations:
user

Responses

Response samples

Content type
application/json
{
  • "pattern": "string",
  • "error": "string"
}

Returns list of addresses for the given postcode

Authorizations:
user
path Parameters
postcode
required
string
Example: e142be

Responses

Response samples

Content type
application/json
{
  • "address_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "postcode": "string",
  • "display_name": "string"
}

Features

Check enabled for user

Checks if a feature is enabled for a user

Authorizations:
user
query Parameters
feature
required
string
Example: feature=upgrade-booking

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Checks if an app update is required

Internally we check if 'App Update Modal' feature is enabled

Responses

Response samples

Content type
application/json
{
  • "update-required": true
}

Get the global service fee status

Checks if the service fees are enabled globally

Responses

Response samples

Content type
application/json
{
  • "service_fee_enabled": true
}

Parking Portal

Submit a vehicle validation request

Submit a vehicle validation request

Authorizations:
application
Request Body schema: application/json
vrn
required
string

Vehicle registration number

validate_for
required
string

Validation period

Responses

Request samples

Content type
application/json
{
  • "vrn": "YPS001",
  • "validate_for": "3 hours"
}

Cancel PCN

Cancel a customer PCN

Authorizations:
application
Request Body schema: application/json
pcn_number
required
string

PCN number

customer_name
required
string

Customer name

customer_email
required
string

Customer email address

staff_name
required
string

Name of the member of staff submitting the request

cancellation_reason
required
string

Reason for cancelling the customer's PCN

space_id
required
integer

ID of location (space) submitting the request

Responses

Request samples

Content type
application/json
{
  • "pcn_number": "AB12345",
  • "customer_name": "John Doe",
  • "customer_email": "john.doe@email.com",
  • "staff_name": "Jane Doe",
  • "cancellation_reason": "Vehicle registration was entered incorrectly",
  • "space_id": 1234
}

Whitelabel

Get all whitelabel instances for the current user

Authorizations:
user

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new whitelabel instance for the current user

Creates a new whitelabel instance with branding and five dummy spaces

Authorizations:
user
Request Body schema: application/json
brandable_id
integer
brandable_type
string
company_name
string
website_url
string
phone
string
email
string
facebook
string
twitter
string
intro
string
background_colour
string
dark_background_colour
string
icon_colour
string
foreground_colour
string
dark_foreground_colour
string
logo_id
integer
text_colour
string
privacy_policy_id
integer
menu_colour
string
subdomain
string

Responses

Request samples

Content type
application/json
{
  • "brandable_id": 0,
  • "brandable_type": "string",
  • "company_name": "string",
  • "website_url": "string",
  • "phone": "string",
  • "email": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "intro": "string",
  • "background_colour": "string",
  • "dark_background_colour": "string",
  • "icon_colour": "string",
  • "foreground_colour": "string",
  • "dark_foreground_colour": "string",
  • "logo_id": 0,
  • "text_colour": "string",
  • "privacy_policy_id": 0,
  • "menu_colour": "string",
  • "subdomain": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get details for a whitelabel instance

Authorizations:
user
path Parameters
instance
required
integer
Example: 12345

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "subdomain": "string",
  • "company_name": "string",
  • "website_url": "string",
  • "phone": "string",
  • "email": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "intro": "string",
  • "background_colour": "string",
  • "icon_colour": "string",
  • "foreground_colour": "string",
  • "menu_colour": "string",
  • "logo_url": "string"
}

Update a whitelabel instance's branding

Authorizations:
user
path Parameters
instance
required
integer
Example: 12345
Request Body schema: application/json
brandable_id
integer
brandable_type
string
company_name
string
website_url
string
phone
string
email
string
facebook
string
twitter
string
intro
string
background_colour
string
dark_background_colour
string
icon_colour
string
foreground_colour
string
dark_foreground_colour
string
logo_id
integer
text_colour
string
privacy_policy_id
integer
menu_colour
string
subdomain
string

Responses

Request samples

Content type
application/json
{
  • "brandable_id": 0,
  • "brandable_type": "string",
  • "company_name": "string",
  • "website_url": "string",
  • "phone": "string",
  • "email": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "intro": "string",
  • "background_colour": "string",
  • "dark_background_colour": "string",
  • "icon_colour": "string",
  • "foreground_colour": "string",
  • "dark_foreground_colour": "string",
  • "logo_id": 0,
  • "text_colour": "string",
  • "privacy_policy_id": 0,
  • "menu_colour": "string",
  • "subdomain": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "subdomain": "string",
  • "company_name": "string",
  • "website_url": "string",
  • "phone": "string",
  • "email": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "intro": "string",
  • "background_colour": "string",
  • "icon_colour": "string",
  • "foreground_colour": "string",
  • "menu_colour": "string",
  • "logo_url": "string"
}

Upload a logo for a whitelabel instance

Authorizations:
user
path Parameters
instance
required
integer
Example: 12345
Request Body schema: multipart/form-data
logo
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "subdomain": "string",
  • "company_name": "string",
  • "website_url": "string",
  • "phone": "string",
  • "email": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "intro": "string",
  • "background_colour": "string",
  • "icon_colour": "string",
  • "foreground_colour": "string",
  • "menu_colour": "string",
  • "logo_url": "string"
}

Delete a whitelabel's space

Authorizations:
user
path Parameters
instance
required
integer
Example: 12345
space
required
integer
Example: 12345

Responses

Enforcement

Get enforcement company locations

Returns all locations for an enforcement company via their OAuth client ID

Authorizations:
application

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Get active bookings for an enforcement company location

Returns all active bookings for the enforcement company location

Authorizations:
application
path Parameters
location
required
integer
Example: 12345
query Parameters
vrn
string
Example: vrn=AB1 2CD
from
string <Y-m-d H:i:s>
Example: from=2010-01-02 09:00:00

Start date for bookings. Will default to current time if not provided

to
string <Y-m-d H:i:s>
Example: to=2010-01-03 09:00:00

End date for bookings. Will default to current time if not provided

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Get upcoming bookings for an enforcement company location

Returns all upcoming bookings within next seven days for the enforcement company location

Authorizations:
application
path Parameters
location
required
integer
Example: 12345
query Parameters
vrn
string
Example: vrn=AB1 2CD

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Get booking information for a reserved booking

Get information for a booking for an enforcement company location, determined via OAuth client ID

Authorizations:
application
path Parameters
reservation
required
integer
Example: 12345

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Mobile Kiosk

Get space config for a given space

Returns mobile kiosk configuration items for a given space

Authorizations:
application
path Parameters
spaceId
required
integer
Example: 12345

Responses

Response samples

Content type
application/json
{
  • "post_pay": true,
  • "kiosk_enabled": true,
  • "tariffs": [
    ],
  • "site_id": 1000,
  • "anpr_present": true,
  • "vrn_suggest": true,
  • "discount_codes": true,
  • "web_theme": [
    ],
  • "currency": [
    ],
  • "discount_codes_enabled": true,
  • "post_payment_promotion": 0,
  • "language": "en",
  • "old_ui_displayed": true,
  • "old_ui_display_durations": [
    ],
  • "use_availability": true,
  • "is_horizon": true,
  • "is_horizon_pre_book": true,
  • "custom_text_enabled": true,
  • "custom_text": {
    }
}

Get pre-payment information

Authorizations:
application
path Parameters
spaceId
required
integer
Example: 12345
Request Body schema: application/json
vehicle_reg
required
string
length
required
integer

Responses

Request samples

Content type
application/json
{
  • "vehicle_reg": "string",
  • "length": 0
}

Response samples

Content type
application/json
{
  • "parking_duration_label": "2 Hours",
  • "start_time_display": "01/01/2020 09:00AM",
  • "end_time_display": "01/01/2020 11:00AM",
  • "start_time": "2020-01-01T09:00:00",
  • "end_time": "2020-01-01T11:00:00",
  • "total_amount_due": "5.00"
}

Pay for and book a space

Authorizations:
application
path Parameters
spaceId
required
integer
Example: 12345
Request Body schema: application/json
vehicle_reg
string
end_time
string
start_time
string
token
string
charity_product_id
string or null

The product id of the chosen charity product

charity_product_key
string or null

The product key of the chosen charity product

Responses

Request samples

Content type
application/json
{
  • "vehicle_reg": "string",
  • "end_time": "string",
  • "start_time": "string",
  • "token": "string",
  • "charity_product_id": "pd_ypsuk_01hw5frvwqjgyr5bajfqheqwga",
  • "charity_product_key": "gosh-charitable-donation-50"
}

Response samples

Content type
application/json
{
  • "booking_id": 0
}

Post pay no vrn found (honesty mode)

Returns booking duration and total cost information

Authorizations:
application
path Parameters
spaceId
required
integer
Example: 12345
Request Body schema: application/json
vehicle_reg
string
end_time
string
start_time
string

Responses

Request samples

Content type
application/json
{
  • "vehicle_reg": "string",
  • "end_time": "string",
  • "start_time": "string"
}

Response samples

Content type
application/json
{
  • "parking_duration": 2,
  • "parking_duration_label": "2 Hours",
  • "start_time_display": "01/01/2020 09:00AM",
  • "end_time_display": "01/01/2020 11:00AM",
  • "start_time": "2020-01-01T09:00:00",
  • "end_time": "2020-01-01T11:00:00",
  • "service_fee": 0.49,
  • "total_amount_due": "5.49",
  • "total_before_service_fee": "5.00",
  • "currency": {
    },
  • "registration_paid_recently": false
}

Quote on arrival using an end time

Returns booking duration and total cost information

Authorizations:
application
path Parameters
spaceId
required
integer
Example: 12345
Request Body schema: application/json
vehicle_reg
string
end_time
string

Responses

Request samples

Content type
application/json
{
  • "vehicle_reg": "NG52CXK",
  • "end_time": "2022-09-30T12:50:00"
}

Response samples

Content type
application/json
{
  • "parking_duration": 2,
  • "parking_duration_label": "2 Hours",
  • "start_time_display": "01/01/2020 09:00AM",
  • "end_time_display": "01/01/2020 11:00AM",
  • "start_time": "2020-01-01T09:00:00",
  • "end_time": "2020-01-01T11:00:00",
  • "service_fee": 0.49,
  • "total_amount_due": "5.49",
  • "total_before_service_fee": "5.00",
  • "currency": {
    },
  • "registration_paid_recently": false
}

Updates booking with user data

Links the booking and payment to either an existing or new user. Returns voucher code if new user was created, or if generate_promo is true

Authorizations:
application
Request Body schema: application/json
booking_id
required
integer
email
required
string
first_name
string
last_name
string
generate_promo
boolean

Responses

Request samples

Content type
application/json
{
  • "booking_id": 0,
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "generate_promo": true
}

Response samples

Content type
application/json
{
  • "new_user": true,
  • "voucher_code": "string"
}

Checks VRN

Checks VRN against ANPR records and returns post payment information if valid

Authorizations:
application
path Parameters
spaceId
required
integer
Example: 12345
Request Body schema: application/json
vehicle_reg
required
string

Responses

Request samples

Content type
application/json
{
  • "vehicle_reg": "string"
}

Response samples

Content type
application/json
{
  • "parking_duration": 2,
  • "parking_duration_label": "2 Hours",
  • "start_time_display": "01/01/2020 09:00AM",
  • "end_time_display": "01/01/2020 11:00AM",
  • "start_time": "2020-01-01T09:00:00",
  • "end_time": "2020-01-01T11:00:00",
  • "service_fee": 0.49,
  • "total_amount_due": "5.49",
  • "total_before_service_fee": "5.00",
  • "currency": {
    },
  • "registration_paid_recently": false
}

EV

Get EV connector types

Returns a list of EV connector types for the search filters

Authorizations:
application
query Parameters
image_size
string
Example: image_size=mdpi

Image size. One off mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi

Responses

Response samples

Content type
application/json
[]

Get details for a given charge point

Fetches charge point data from the database. Always returns connector status as unknown.

Authorizations:
application
query Parameters
device_id
required
string
Example: device_id=4fc7fd6e1cf252fb1a7403a8b1ce0476

Charge point device ID

Responses

Response samples

Content type
application/json
[]

Get live status data for all connectors of a given charge point

In the background, calls UK Charge Point Registry API and returns current data for given charge point

Authorizations:
application
query Parameters
device_id
required
string
Example: device_id=4fc7fd6e1cf252fb1a7403a8b1ce0476

Charge point device ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AutoPay

AutoPay set up - check email

Validates given email address and checks that it's not been taken yet

Authorizations:
application
Request Body schema: application/json
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "john.doe@email.con"
}

Response samples

Content type
application/json
{
  • "email": "john.doe@email.com"
}

AutoPay set up - register user

Creates user account and marks it as 'AutoPay enabled'

Authorizations:
application
Request Body schema: application/json
email
required
string
mobile
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "john.doe@email.com",
  • "mobile": 7711223344,
  • "password": "4Oyd6$Kx63a"
}

Response samples

Content type
application/json
{
  • "id": 321456,
  • "email": "john.doe@email.com",
  • "mobile": 7711223344
}

AutoPay set up - find vehicle

Searches for given VRN in UK Vehicle Data API and returns vehicle data, if found

Authorizations:
application
Request Body schema: application/json
vrn
required
string
include
string

Responses

Request samples

Content type
application/json
{
  • "vrn": "YPS123",
  • "include": "vehicle_data"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "reference": "M6 SOJ",
  • "registration_number": "M6SOJ",
  • "default": false,
  • "vehicle_data": {}
}

AutoPay set up - add vehicle

Enables AutoPay for given vehicle

Authorizations:
application
Request Body schema: application/json
vehicle_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "vehicle_id": 456321
}

AutoPay set up - enable latest vehicle

Enables AutoPay for the last added vehicle in user's account. Used in AutoPay signup flow.

Authorizations:
application

Responses

AutoPay set up - get user's AutoPay data

Returns some user's details, vehicles and payment cards

Authorizations:
application

Responses

Response samples

Content type
application/json
{
  • "id": 789987,
  • "first_name": "John",
  • "last_name": "Doe",
  • "email": "john.doe@email.com",
  • "vehicles": {
    },
  • "cards": {
    }
}

Get user's AutoPay settings

Returns AutoPay settings for authenticated user

Authorizations:
application

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save AutoPay settings

Saves AutoPay settings for the authenticated user

Authorizations:
application
Request Body schema: application/json
vehicle_id
required
integer
enabled
required
boolean
ignore_local_anpr
boolean

Local dev only - allows to test without having to set up ANPR service locally

Responses

Request samples

Content type
application/json
{
  • "vehicle_id": 456321,
  • "enabled": true,
  • "ignore_local_anpr": true
}

Miscellaneous

Sends contact us request which raises a zendesk ticket

Authorizations:
user
Request Body schema: multipart/form-data
required
name
required
string

Name of person submitting form.

subject
required
string

Subject to which enquiry relates. See _misc/contact/support-subjects.

email
required
string

Email address of person submitting form.

phone
string

Optional.

support_type
required
string
Enum: "Driver" "Space owner/Partner"
booking_id
integer

Required for these subjects

  • Amend a booking
  • Cancel a short-term booking
  • Cancel a long-term booking (30 days notice)
  • Request a refund
  • Parking Charge
  • Payment enquiry
  • Deposit return
  • Receipt request
company
string
text
required
string

Body of text containing enquiry.

booking_method
string
Enum: "Auto Pay" "Kiosk" "Website or App"

Required when subject is Driver - Request a refund.

refund_reason
string

Required when booking_method is selected.

Possible values when booking_method is Auto Pay:

  • I was charged twice
  • I was charged too much
  • Other

Possible values when booking_method is Kiosk:

  • I was charged twice
  • I was charged too much
  • Other

Possible values when booking_method is Website or App:

  • I was unable to park
  • I was charged the same amount twice
  • I was charged too much
  • I had to pay to exit the car park
  • Querying an existing refund
  • I booked the wrong space
  • Other
unable_to_park_sub_reason
string

Required when refund_reason is one of:

  • I was unable to park

Possible values:

  • No spaces were available
  • No access equipment was available
  • The Space Owner advised me the space was no longer available
  • The location did not exist
  • The location was closed
  • My vehicle did not fit in the space
  • Other
supporting_image
string <binary>

Optional. An array of files (jpg, png, pdf, jpeg) max 10MB.

pcn_reference_number
string

Only required when subject is Driver - Parking Charge.

enforcement_company
string

Only required when subject is Driver - Parking Charge.

vehicle_registration
string

Only required when subject is Driver - Parking Charge.

reason_for_appeal
string

Only required when subject is Driver - Parking Charge.

parking_location
string

Required when booking_method is Auto Pay or Kiosk and refund_reason is selected.

payment_time
string

Required when booking_method is Auto Pay or Kiosk and refund_reason is selected.

payment_amount
string

Required when booking_method is Kiosk and refund_reason is selected.

last_4_digits
string

Required when booking_method is Kiosk and refund_reason is selected.

card_expiration
string

Required when booking_method is Kiosk and refund_reason is selected.

Responses

Create a new location notification

Authorizations:
application
Request Body schema: application/json
email
required
string
lat
required
number
lng
required
number
radius
number

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "lat": 0,
  • "lng": 0,
  • "radius": 0
}

Create a new landlord lead

Authorizations:
application
Request Body schema: application/json
email
string
lat
number
lng
number
number_of_spaces
integer
name
string
phone
string
search_term
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "lat": 0,
  • "lng": 0,
  • "number_of_spaces": 0,
  • "name": "string",
  • "phone": "string",
  • "search_term": "string"
}

Unsubscribes a user from a particular type of notification

Authorizations:
application
Request Body schema: application/json
email
required
string
notification_type
required
string
unsubscribe_from
Array of strings

Responses

Request samples

Content type
application/json
{
  • "email": "john.doe@laravel.com",
  • "notification_type": "booking-reminder-tenant",
  • "unsubscribe_from": [
    ]
}

Unsubscribes a user from a particular location notification or all of them

Authorizations:
application
Request Body schema: application/json
email
required
string
all
required
boolean
lnId
integer

Responses

Request samples

Content type
application/json
{
  • "email": "john.doe@laravel.com",
  • "all": false,
  • "lnId": 182594
}

Search engine indexed spaces

Return IDs of spaces which should be indexed by external search engines

Authorizations:
application
query Parameters
country_code
string
Example: country_code=IRL

3 character ISO country code. Defaults to GBR if not provided.

Responses

Response samples

Content type
application/json
{
  • "space_ids": [
    ]
}

Search engine indexed space SEO paths

Returns SEO-ready paths of spaces which should be indexed by external search engines

Authorizations:
application
query Parameters
country_code
string
Example: country_code=IRL

3 character ISO country code. Defaults to GBR if not provided.

Responses

Response samples

Content type
application/json
{
  • "space_paths": [
    ]
}

Create a new Sentry event

Authorizations:
user
Request Body schema: application/json
message
required
string
level
required
string
logger
string
platform
string
breadcrumbs
Array of strings
request
Array of strings
tags
Array of strings
context
Array of strings
contexts
Array of strings

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "level": "string",
  • "logger": "string",
  • "platform": "string",
  • "breadcrumbs": [
    ],
  • "request": [
    ],
  • "tags": [
    ],
  • "context": [
    ],
  • "contexts": [
    ]
}

Send SMS with a link to the App

Authorizations:
application
Request Body schema: application/json
mobile
required
string

Responses

Request samples

Content type
application/json
{
  • "mobile": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string"
}

Confirm access equipment was returned

Authorizations:
application
path Parameters
bookingId
required
integer
Example: 12345

Booking ID

Request Body schema: application/json
hash
required
string

Driver's email address hash

Responses

Request samples

Content type
application/json
{
  • "hash": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Guest Validation

Get site config for guest validation

Authorizations:
application
path Parameters
companyId
required
integer
Example: 12345

ID of QR company

spaceId
required
integer
Example: 12345

ID of QR company's space

code
required
string

QR space code

Responses

Response samples

Content type
application/json
{
  • "valid": true,
  • "enabled": true,
  • "kiosk_enabled": true,
  • "config": {
    },
  • "fields": {
    },
  • "parkingOptions": [
    ],
  • "countryData": {
    }
}

Make a guest booking

Authorizations:
application
path Parameters
companyId
required
integer
Example: 12345

ID of QR company

spaceId
required
integer
Example: 12345

ID of QR company's space

code
required
string

QR space code

Request Body schema: application/json
vehicle_registration
string
first_name
string
last_name
string
full_name
string
mobile
string
email
string
duration
integer

Responses

Request samples

Content type
application/json
{
  • "vehicle_registration": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "full_name": "string",
  • "mobile": "string",
  • "email": "string",
  • "duration": 0
}

Internal

Get a list of all bookings active (in progress) at the given time for the given VRN

Only accessable from internal network

query Parameters
vrn
required
string

VRN of vehicle for bookings

datetime
required
string <YYYY-MM-DD HH:MM:SS>

Datetime to query for active bookings

space_ids
string

Comma separated list of space IDs to check for bookings

start_time_buffer
integer

Optional number of minutes to add before provided datetime to accept bookings for

end_time_buffer
integer

Optional number of minutes to add after provided datetime to accept bookings for

strict_vrn
boolean

Allows to perform a strict VRN search instead of the default fuzzy search

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Corporate Account

Get details of connected corporate account

Return details of the corporate account to which the user is connected.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "account_name": "YourParkingSpace",
  • "primary_contact_name": "John Smith",
  • "primary_contact_email": "john@example.com",
  • "primary_contact_number": 123456789,
  • "currency_code": "GBP",
  • "total_spend": {
    },
  • "users": {
    }
}

Update details of connected corporate account

Update details of the corporate account to which the user is connected.

Request Body schema: application/json

Comma separated list of space IDs to check for bookings

account_name
required
string
primary_contact_name
required
string
primary_contact_email
required
string
primary_contact_number
string

Optional.

company_registration_number
string

Optional

vat_number
string

Optional

total_spend_limit_last_30d
number

Optional.

total_spend_limit_last_1y
number

Optional.

total_spend_warn_last_30d
number

Optional.

total_spend_warn_last_1y
number

Optional.

Responses

Request samples

Content type
application/json
{
  • "account_name": "YourParkingSpace",
  • "primary_contact_name": "John Smith",
  • "primary_contact_email": "john@example.com",
  • "primary_contact_number": 1234567890,
  • "company_registration_number": "C12345678",
  • "vat_number": "V123456",
  • "total_spend_limit_last_30d": 100,
  • "total_spend_limit_last_1y": 200,
  • "total_spend_warn_last_30d": 300,
  • "total_spend_warn_last_1y": 400
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "account_name": "YourParkingSpace",
  • "primary_contact_name": "John Smith",
  • "primary_contact_email": "john@example.com",
  • "primary_contact_number": 123456789,
  • "currency_code": "GBP",
  • "total_spend": {
    },
  • "users": {
    }
}

Get user details of connected users

Return user details of members of the corporate account to which the user is connected.

query Parameters
search
string

Filter on user_id, name, email, phone number

filter[user_id]
string

Filter on user_id

filter[name]
string

Filter on name

filter[email]
string

Filter on email

filter[number]
string

Filter on phone number

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Connect a user account to the connected corporate account

Create (if applicable) and connect a user account to the corporate account to which the user is connected.

Request Body schema: application/json

User details

first_name
required
string
last_name
required
string
email
required
string
phone
string

Optional.

is_admin
boolean

Optional. Default is false.

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string",
  • "is_admin": true
}

Import CSV template

Responses

Import CSV file of user accounts to create/link to the connected corporate account

Create (if applicable) and connect a user account to the corporate account to which the user is connected.

Request Body schema: application/x-www-form-urlencoded
csv
string <binary>

CSV file containing user records

Responses

Export CSV of users

query Parameters
search
string

Filter on user_id, name, email, phone number

filter[user_id]
string

Filter on user_id

filter[name]
string

Filter on name

filter[email]
string

Filter on email

filter[number]
string

Filter on phone number

Responses

Get user details of a connected user

Return user details of this member of the corporate account to which the user is connected.

query Parameters
user
required
number

Corporate account user ID, not user id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Unlink user from connected corporate account

Unlink the user from the corporate account to which the user is connected.

query Parameters
user
required
number

Corporate account user ID, not user id.

Request Body schema: application/json
cancel_bookings
required
boolean

Whether unlinking the user should also cancel active and upcoming bookings which may exist

Responses

Request samples

Content type
application/json
{
  • "cancel_bookings": true
}