Skip to main content

Update a booking

PATCH 
/v1/bookings/:bookId

Update a booking

Supported roles

  • Partner
  • Fleet manager

Request​

Path Parameters

    bookId stringrequired

    ID of booking

Body

required
    pickupDateTime date-time

    Pickup time. Supports multiple formats:

      • Simple format (local time): YYYY-MM-DD HH:mm (e.g., "2024-02-19 16:46")
      • ISO 8601 with timezone (e.g., "2024-02-19T16:46:45.000+07:00")
      • UTC format (e.g., "2024-02-19T09:46:45.000Z")
    comment string
    internalComment string

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

    flightNumber string
    price object

    Only support on custom fare booking

    value numberrequired
    currency stringrequired
    passenger object
    title string
    firstName string
    lastName string
    phone string

    Phone number in E.164 format

    email string
    luggage integer

    Number of luggage items. No fare recalculation.

    passengers integer

    Possible values: >= 1

    Number of passengers. No fare recalculation.

    pickup object

    Pickup location. No fare recalculation.

    latitude numberrequired

    Possible values: >= -90 and <= 90

    longitude numberrequired

    Possible values: >= -180 and <= 180

    address string
    city string
    country string
    postcode string
    destination object

    Destination location. No fare recalculation.

    latitude numberrequired

    Possible values: >= -90 and <= 90

    longitude numberrequired

    Possible values: >= -180 and <= 180

    address string
    city string
    country string
    postcode string

Responses​

Successful operation

Schema
    bookId stringrequired
    groupId string
    type string

    Possible values: [booking, quote]

    Type of record:

    • booking - A confirmed booking
    • quote - A quote that can be converted to booking
    source string

    Booking source:

    • Command Center
    • Car-hailing
    • Street sharing
    • Partner
    • Passenger app
    • API
    • PWA
    • Booking.com
    • HolidayTaxis
    • Hoppa
    status string

    Booking status:

    • accepted - Provider accepted
    • driverAssigned - Booking has been assigned to driver
    • driverOnTheWay - Driver has started job and on the way to the pickup point
    • driverArrived - Driver has arrived at the pickup point
    • passengerOnBoard - Passenger has been picked up
    • droppedOff - Dropped off
    • canceled - Canceled
    • passengerNoShow - Passenger was a no-show
    • incident - Booking has been marked as incident by the provider
    • completed - Completed
    quoteStatus string

    Possible values: [pending, accepted, rejected, expired]

    Quote status (only present when type is quote):

    • pending - Quote is awaiting customer decision
    • accepted - Quote has been accepted and converted to booking
    • rejected - Quote has been rejected by customer
    • expired - Quote has expired
    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. Required if email is not provided.

    email string

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

    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

    supplierId string

    Supplier ID

Loading...