Skip to main content

Create custom booking

POST 
/v2/bookings

Create custom booking

Supported roles

  • Fleet manager

Request​

Body

    vehicleTypeId stringrequired

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Vehicle Type ID: Get vehicle types

    corporateId string

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Corporate ID

    duration integer

    Possible values: >= 1

    Duration in hours. Required when destination is not provided.

    bookingReference string
    vehicleIdentifier integer

    Optional number to identify multiple vehicles for the same booking reference. Allows creating multiple bookings with the same bookingReference by providing different vehicleIdentifier values.

    comment string
    internalComment string

    Internal notes visible only to dispatchers and operations staff. Used for internal coordination or operator instructions.

    flightNumber string
    pickupDateTime stringrequired

    Pickup time can either be a specific date-time in ISO 8601 format for reservation or the string ASAP for on-demand booking.

    pickupTimezone string

    Pickup timezone. Default is based on the pickup location

    luggage integer
    passengers integer
    price objectrequired
    value numberrequired
    currency stringrequired
    pickup objectrequired

    Pick up point

    latitude numberrequired

    Possible values: >= -90 and <= 90

    longitude numberrequired

    Possible values: >= -180 and <= 180

    address string
    city string
    country string
    postcode string
    destination object

    Drop off point. Required when duration is not provided.

    latitude numberrequired

    Possible values: >= -90 and <= 90

    longitude numberrequired

    Possible values: >= -180 and <= 180

    address string
    city string
    country string
    postcode string
    booker object

    Booker information. Required when passenger is not provided.

    title string
    firstName string
    lastName string
    phone string

    Phone number in E.164 format. Required if email is not provided.

    email string

    Booker’s email address. Required if phone is not provided.

    passenger object

    Passenger information. Required when booker is not provided.

    title string
    firstName string
    lastName string
    phone string

    Phone number in E.164 format

    email string
    extraFees object[]
  • Array [
    • key stringrequired
    description stringrequired
    value numberrequired
    currency stringrequired
  • ]

Responses​

Create booking successfully

Schema
    bookId stringrequired
    groupId string
    source string

    Booking source:

    • API
    status string

    Booking status:

    • accepted - Provider accepted
    bookingReference string
    vehicleIdentifier integer

    Vehicle identifier number for multiple vehicles with the same booking reference

    booker object
    title string
    firstName string
    lastName string
    phone string

    Phone number in E.164 format

    email string
    passenger object
    title string
    firstName string
    lastName string
    phone string

    Phone number in E.164 format

    email string
    driver object
    phone string

    Phone number in E.164 format

    firstName string
    lastName string
    avatar string
    vehicle object
    plateNumber string

    Vehicle license plate number

    make string

    Vehicle manufacturer/brand

    model string

    Vehicle model name

    color string

    Vehicle color

    pickup object
    latitude numberrequired

    Possible values: >= -90 and <= 90

    longitude numberrequired

    Possible values: >= -180 and <= 180

    address string
    city string
    country string
    postcode string
    destination object
    latitude numberrequired

    Possible values: >= -90 and <= 90

    longitude numberrequired

    Possible values: >= -180 and <= 180

    address string
    city string
    country string
    postcode string
    pickupDateTime date-time

    Pickup time in UTC timezone

    vehicleType string
    flightNumber string

    Passenger's flight number, if applicable. Useful for airport pickup coordination and flight tracking.

    corporate object

    Corporate account information. If empty, the booking is considered an individual booking.

    id string
    name string
    internalComment string

    Internal notes visible only to dispatchers and operations staff. Used for internal coordination or operator instructions.

    comment string

    Driver note. Additional notes or instructions visible to both the driver and passenger (e.g., passenger preferences, pickup details, or contact instructions).

    noPassengers integer

    Number of passengers

    noLuggage integer

    Number of luggage

    price object
    value numberrequired
    currency stringrequired
    duration integer

    Total trip duration in seconds from pickup to drop-off

    trackLink string

    Tracking URL of booking

Loading...