API Objects Reference

Comprehensive documentation of all API objects and their fields

OrderRequestObject

Used for creating new orders

Fields

Field	Type	Description
waypoints	Array of WaypointObject	Geodata of pickup, intermediate, and drop-off points like coordinates, addresses, etc. Up to 5 points can be mentioned.
extraOptions	Array of Enum	AIR_CONDITION NON_SMOKING SMOKING_ALLOWED EXTRA_LUGGAGE_SPACE CHILD_SEAT DISABLED_PEOPLE PETS_ALLOWED BIKE_MOUNT
client	CustomerObject	Customer info like name, UUID, image, etc.
notes	String	Text notes for an order.
unitOfLength	Enum	METER KILOMETER MILE
specialCost	Number	Special price for the order
tripDistance	Number	Trip distance in units specified in "unitOfLength" param for price estimation.
tripDuration	Integer	Trip duration in milliseconds for price estimation.
pickupTime	String	Pick up time for arrival according to RFC3339 standard
numberOfSeats	Integer	Number of seats needed
vehicleType	Enum	ECONOMY CLASSIC BUSINESS LUXURY RICKSHAW MOTO TESLA BLACK_CAR BLACK_CAB SUV MINIVAN VAN BUS LIMOUSINE HELICOPTER SPEED_BOAT YACHT TOW_TRUCK AMBULANCE PARATRANSIT DELIVERY_TRUCK MOTO_XL COURIER PEDICAB TOW_TRUCK_SMALL TOW_TRUCK_INDUSTRIAL ELECTRIC_VEHICLE HANDYMAN PLUMBER ELECTRICIAN LOCKSMITH DOCTOR NURSE MAID BABYSITTER LAWYER INSURANCE_INSPECTOR CLAIMS_ADJUSTER
tariffType	Enum	PRECISE HOURLY
paymentMethods	Enum	CASH TERMINAL THIRD_PARTY
prepaid	Boolean	If true - the trip was paid before it started (currently not supported)
tariffId	String	Service type UUID
manualAssignDriver	String	Driver Id that is used for manual assign
orderSource	Enum	PASSENGER_APP DISPATCH_PANEL DISPATCH_API

Code Sample

{
  "waypoints": [
    {
      "exactLatLng": {
        "lat": 37.5,
        "lng": -122.1
      },
      "premise": "Google Store",
      "houseNumber": "22",
      "street": "Avenue",
      "subLocality": "California",
      "locality": "California",
      "city": "Mountain view",
      "district": "California",
      "province": "California",
      "country": "United States",
      "postalCode": "94043",
      "countryCode": "US",
      "poiName": "Google Store",
      "placeLatLng": {
        "lat": 37.5192,
        "lng": -122.0574
      }
    }
  ],
  "extraOptions": [
    "CHILD_SEAT"
  ],
  "client": {
    "clientId": "12345678-1234-1234-1234-1234567890AB",
    "name": "John Smith",
    "phone": "+123121231212",
    "imageUrl": "https://image.com/"
  },
  "notes": "Some text",
  "unitOfLength": "KILOMETER",
  "specialCost": 33.34,
  "tripDistance": 0,
  "tripDuration": 0,
  "pickupTime": "2000-01-01T12:00:27.87+00:20",
  "numberOfSeats": 4,
  "vehicleType": "BUS",
  "tariffType": "PRECISE",
  "paymentMethods": [
    "CASH",
    "TERMINAL"
  ],
  "prepaid": false,
  "tariffId": "12345678-1234-1234-1234-1234567890AB",
  "manualAssignDriver": "12345678-1234-1234-1234-1234567890AB"
}

WaypointObject

Contains location information for a point in the trip

Fields

Field	Type	Description
exactLatLng	LatLngObject	Coordinates of the customer
premise	String	A named location, usually a building or collection of buildings with a common name
houseNumber	String	House number
street	String	Street name
subLocality	String	A first-order civil entity below a locality
locality	String	An incorporated city or town political entity
city	String	City name
district	String	District (a subdivision of city)
province	String	Province name
country	String	Country name
postalCode	String	Postal code
countryCode	String	Two-letter country code ISO 3166-1 alpha-2
poiName	String	A named point of interest
placeLatLng	LatLngObject	Coordinates of the place which are used for further geocoding

Code Sample

{
  "exactLatLng": {
    "lat": 37.5,
    "lng": -122.1
  },
  "premise": "Google Store",
  "houseNumber": "22",
  "street": "Avenue",
  "subLocality": "California",
  "locality": "California",
  "city": "Mountain view",
  "district": "California",
  "province": "California",
  "country": "United States",
  "postalCode": "94043",
  "countryCode": "US",
  "poiName": "Google Store",
  "placeLatLng": {
    "lat": 37.4192,
    "lng": -122.0574
  }
}

LatLngObject

Geographic coordinates

Fields

Field	Type	Description
lat	Number	Latitude data
lng	Number	Longitude data

Code Sample

{
  "lat": 37.4192,
  "lng": -122.0574
}

CustomerObject

Customer information

Fields

Field	Type	Description
clientId	String	Customer UUID
name	String	Customer name
phone	String	Customer mobile phone number
imageUrl	String	Customer profile image
email	String	Customer email (from Customer app)

Code Sample

{
  "clientId": "12345678-1234-1234-1234-1234567890AB",
  "name": "John Smith",
  "phone": "+123121231212",
  "imageUrl": "https://image.com/",
  "email": "smith@mail.com"
}

OrderResponseObject

Response after creating an order

Fields

Field	Type	Description
orderId	String	Order UUID

Code Sample

{
  "orderId": "12345678-1234-1234-1234-1234567890AB"
}

CompanyObject

Fields

Field	Type	Description
name	String	Company name
logo	String	Company profile image

Code Sample

{
  "name": "My Company",
  "logo": "https://image.com/"
}

OrderOfferObject

Information about an accepted order

Fields

Field	Type	Description
eta	String	Estimated time of arrival according to RFC3339 standard
driver	DriverObject	Driver info like name, UUID, profile image, etc.
car	CarObject	Driver's car info like model, colour, year, etc.
tariff	TariffObject	Service type info like name, UUID, currency, etc.

DriverObject

Driver information

Fields

Field	Type	Description
driverId	String	Driver UUID
name	String	Driver name
phone	String	Driver mobile phone number
email	String	Driver email
imageUrl	String	Driver profile image

Code Sample

{
  "driverId": "12345678-1234-1234-1234-1234567890AB",
  "name": "John Smith",
  "phone": "+123121231212",
  "email": "smith@mail.com",
  "imageUrl": "https://image.com/"
}

CarObject

Vehicle information

Fields

Field	Type	Description
model	String	Car model
color	String	Car color
year	Integer	Car issue year
imageUrl	String	Car image
plateNumber	String	Car number
numberOfSeats	Integer	Number of seats
vehicleType	Enum	ECONOMY CLASSIC BUSINESS LUXURY RICKSHAW MOTO TESLA BLACK_CAR BLACK_CAB SUV MINIVAN VAN BUS LIMOUSINE HELICOPTER SPEED_BOAT YACHT TOW_TRUCK AMBULANCE PARATRANSIT DELIVERY_TRUCK MOTO_XL COURIER PEDICAB TOW_TRUCK_SMALL TOW_TRUCK_INDUSTRIAL ELECTRIC_VEHICLE HANDYMAN PLUMBER ELECTRICIAN LOCKSMITH DOCTOR NURSE MAID BABYSITTER LAWYER INSURANCE_INSPECTOR CLAIMS_ADJUSTER
options	Array of Enum	AIR_CONDITION NON_SMOKING SMOKING_ALLOWED EXTRA_LUGGAGE_SPACE CHILD_SEAT DISABLED_PEOPLE PETS_ALLOWED BIKE_MOUNT

Code Sample

{
  "model": "Mercedes Benz",
  "color": "Black",
  "year": 2000,
  "imageUrl": "https://image.com/",
  "plateNumber": "1234AB",
  "numberOfSeats": 4,
  "vehicleType": "BUSINESS",
  "options": [
    "AIR_CONDITION",
    "CHILD_SEAT"
  ]
}

TariffObject

Service type and pricing information

Fields

Field	Type	Description
tariffId	String	Service type UUID
name	String	Service type name
companyName	String	Driver company name
vehicleType	Enum	ECONOMY CLASSIC BUSINESS LUXURY RICKSHAW MOTO TESLA BLACK_CAR BLACK_CAB SUV MINIVAN VAN BUS LIMOUSINE HELICOPTER SPEED_BOAT YACHT TOW_TRUCK AMBULANCE PARATRANSIT DELIVERY_TRUCK MOTO_XL COURIER PEDICAB TOW_TRUCK_SMALL TOW_TRUCK_INDUSTRIAL ELECTRIC_VEHICLE HANDYMAN PLUMBER ELECTRICIAN LOCKSMITH DOCTOR NURSE MAID BABYSITTER LAWYER INSURANCE_INSPECTOR CLAIMS_ADJUSTER
tariffType	Enum	PRECISE HOURLY
numberOfSeats	Integer	Number of passenger seats
paymentMethods	Array of Enum	CASH CREDIT_CARD TERMINAL THIRD_PARTY
currency	Enum	Currency code according to ISO 4217 standard
unitOfLength	Enum	METER KILOMETER MILE
minimumCharge	Number	Minimum trip cost
maximumCharge	Number	Maximum trip cost
flagDownFee	Number	Flag down fee (seat price)
perDistanceUnitFee	Number	Cost of a kilometer (mile) of a trip
perHourFee	Number	Cost of an hour of a trip
taximeterMode	Enum	TIME_AND_MILEAGE TIME_OR_MILEAGE TIME_HOURLY
speedBreakPoint	Number	Speed threshold (for taximeterMode = TIME_OR_MILEAGE)
tariffMode	Enum	DISABLED AUTO AUTO_FIXED_COST
driverCanSetCost	Boolean	Allow driver to add extra expenses
fixedFaresAvailable	Boolean	If true - prepared prices will be applied for fixed zones (this parameter is set on production only)
fixedFareName	String	Fixed fare name (this parameter is set on production only)
cost	Number	Estimated trip cost
fixedCost	Boolean	Fixed trip cost option
prepaidSupported	Boolean	If true - the trip was paid before it started (currently not supported)
asapBooking	Boolean	ASAP booking option
preBooking	Boolean	Pre-booking option
minimumPreBookingDelay	Integer	The minimum period for preorder (milliseconds)

Code Sample

{
  "tariffId": "12345678-1234-1234-1234-1234567890AB",
  "name": "Classic",
  "companyName": "My Company",
  "vehicleType": "CLASSIC",
  "tariffType": "PRECISE",
  "numberOfSeats": 4,
  "paymentMethods": [
    "CREDIT_CARD",
    "CASH"
  ],
  "currency": "USD",
  "unitOfLength": "KILOMETER",
  "minimumCharge": 1,
  "maximumCharge": 10,
  "flagDownFee": 1,
  "perDistanceUnitFee": 1,
  "perHourFee": 60,
  "taximeterMode": "TIME_AND_MILEAGE",
  "speedBreakPoint": 5,
  "tariffMode": "AUTO",
  "driverCanSetCost": true,
  "fixedFaresAvailable": false,
  "cost": 33.34,
  "fixedCost": true,
  "prepaidSupported": false,
  "asapBooking": true,
  "preBooking": true,
  "minimumPreBookingDelay": 900000
}

OrderUpdateObject

Order status and driver location update

Fields

Field	Type	Description
driverId	String	Driver UUID
driverLocation	LocationObject	Driver location info like coordinates, speed, etc.
status	String	CANCELLED_BY_DISPATCH CANCELLED_BY_DRIVER CANCELLED_NO_PASSENGER CANCELLED_DECIDED_NOT_TO_GO CANCELLED_NO_TAXI CANCELLED_DRIVER_OFFLINE CANCELLED_SEARCH_EXCEEDED SEARCH ASSIGNED STARTED ARRIVED TRANSFERRING REVIEW_SUMMARY PAYMENT FINISHED_PAID FINISHED_UNPAID

Code Sample

{
  "driverId": "12345678-1234-1234-1234-1234567890AB",
  "driverLocation": {
    "accuracy": 20,
    "time": "2000-01-01T12:00:27.87+00:20",
    "bearing": 180,
    "speed": 20,
    "lat": 37.4192,
    "lng": -122.0574
  },
  "status": "TRANSFERRING"
}

LocationObject

Location information

Fields

Field	Type	Description
accuracy	Number	Object estimated location radius, in meters
time	String	Time of location calculation according to RFC3339 standard
bearing	Number	The horizontal direction of the mobile device in degrees (0.0, 360.0]
speed	Number	Object speed (meters per second)
lat	Number	Object latitude
lng	Number	Object longitude

Code Sample

{
  "accuracy": 20,
  "time": "2000-01-01T12:00:27.87+00:20",
  "bearing": 180,
  "speed": 20,
  "lat": 37.4192,
  "lng": -122.0574
}

TripSummaryObject

Trip summary information

Fields

Field	Type	Description
createTime	String	Order creation time according to RFC3339 standard
pickupTime	String	Customer pickup time according to RFC3339 standard
dropoffTime	String	Customer dropoff time according to RFC3339 standard
currency	Enum	Currency code according to ISO 4217 standard
unitOfLength	Enum	METER KILOMETER MILE
tripDistance	Number	Trip distance in units specified in "unitOfLength" field
tripDuration	Integer	Trip duration in milliseconds
tripCost	Number	Estimated trip cost
extraCost	Number	Additional fees
finalCost	Number	Total trip cost with fees
payments	Array of PaymentObject	Trip payment info like payment method, amount, etc.
ratingByDriver	Integer	Customer's rating by the driver
pickupLocation	LatLngObject	Passenger pickup coordinates
dropoffLocation	LatLngObject	Passenger final dropoff coordinates
orderSource	Enum	PASSENGER_APP DISPATCH_PANEL DISPATCH_API

Code Sample

{
  "createTime": "2000-09-29T12:56:26.834+03:00",
  "pickupTime": "2000-09-29T12:57:05.214+03:00",
  "dropoffTime": "2000-09-29T12:57:12.975+03:00",
  "currency": "USD",
  "unitOfLength": "KILOMETER",
  "tripDistance": 55,
  "tripDuration": 775400,
  "tripCost": 1.13,
  "finalCost": 1.13,
  "payments": [
    {
      "time": "2000-09-29T12:57:12.975+03:00",
      "amount": 1.13,
      "method": "CREDIT_CARD"
    }
  ],
  "ratingByDriver": 5,
  "pickupLocation": {
    "lat": 56.8632431,
    "lng": 27.6422327
  },
  "dropoffLocation": {
    "lat": 56.8632431,
    "lng": 27.6422327
  }
}

PaymentObject

Payment information

Fields

Field	Type	Description
time	String	Time of payment according to RFC3339 standard
amount	Number	Amount of money paid
method	Enum	CASH CREDIT_CARD TERMINAL THIRD_PARTY

Code Sample

{
  "time": "2000-09-29T12:56:26.834+03:00",
  "amount": 1.13,
  "method": "CREDIT_CARD"
}

OrderStatusObject

Order status information

Fields

Field	Type	Description
status	String	CANCELLED_BY_DISPATCH CANCELLED_BY_DRIVER CANCELLED_NO_PASSENGER CANCELLED_DECIDED_NOT_TO_GO CANCELLED_NO_TAXI CANCELLED_DRIVER_OFFLINE CANCELLED_SEARCH_EXCEEDED SEARCH ASSIGNED STARTED ARRIVED TRANSFERRING REVIEW_SUMMARY PAYMENT FINISHED_PAID FINISHED_UNPAID

Code Sample

{
  "status": "CANCELLED_BY_DISPATCH"
}

VehicleObject

Vehicle information with location

Fields

Field	Type	Description
location	LocationObject	Driver location info like coordinates, accuracy, etc.
vehicleType	Enum	ECONOMY CLASSIC BUSINESS LUXURY RICKSHAW MOTO TESLA BLACK_CAR BLACK_CAB SUV MINIVAN VAN BUS LIMOUSINE HELICOPTER SPEED_BOAT YACHT TOW_TRUCK AMBULANCE PARATRANSIT DELIVERY_TRUCK MOTO_XL COURIER PEDICAB TOW_TRUCK_SMALL TOW_TRUCK_INDUSTRIAL ELECTRIC_VEHICLE HANDYMAN PLUMBER ELECTRICIAN LOCKSMITH DOCTOR NURSE MAID BABYSITTER LAWYER INSURANCE_INSPECTOR CLAIMS_ADJUSTER

Code Sample

{
  "location": {
    "accuracy": 20,
    "time": "2000-01-01T12:00:27.87+00:20",
    "bearing": 180,
    "speed": 20,
    "lat": 37.4192,
    "lng": -122.0574
  },
  "vehicleType": "CLASSIC"
}

OrderPrepareRequestObject

Request to prepare a new order

Fields

Field	Type	Description
waypoints	Array of WaypointObject	Geodata of pickup, intermediate, and drop-off points like coordinates, addresses, etc. Up to 5 points can be mentioned.
unitOfLength	Enum	METER KILOMETER MILE
pickupTime	String	Pick up time for arrival according to RFC3339 standard
currency	Enum	Currency code according to ISO 4217 standard
specialCost	Number	Special price for the order
includedDistance	Number	Included in special price distance (special cost applied for the whole trip if not specified)
includedDuration	Integer	Included in special price duration in millis (special cost applied for the whole trip if not specified)

Code Sample

{
  "waypoints": [
    {
      "exactLatLng": {
        "lat": 37.5,
        "lng": -122.1
      },
      "premise": "Google Store",
      "houseNumber": "22",
      "street": "Avenue",
      "subLocality": "California",
      "locality": "California",
      "city": "Mountain view",
      "district": "California",
      "province": "California",
      "country": "United States",
      "postalCode": "94043",
      "countryCode": "US",
      "poiName": "Google Store",
      "placeLatLng": {
        "lat": 37.5192,
        "lng": -122.0574
      }
    }
  ],
  "unitOfLength": "METER",
  "pickupTime": "2000-01-01T12:00:27.87+00:20",
  "currency": "USD",
  "specialCost": 33.34,
  "includedDistance": 1500,
  "includedDuration": 60000
}

OrderPrepareResponseObject

Response from preparing a new order

Fields

Field	Type	Description
orderId	String	Order UUID
confirmationId	String	Identifier of the operation
orderPreparationData	OrderPreparationDataObject	Prepared data for order creation

Code Sample

{
  "orderId": "12345678-1234-1234-1234-1234567890AB",
  "confirmationId": "12345678-1234-1234-1234-1234567890AB",
  "orderPreparationData": {
    "allTariffsTripEstimations": [
      {
        "cost": 33.34,
        "fixedCost": true,
        "priceMultiplier": 2.1,
        "tariffId": "12345678-1234-1234-1234-1234567890AB"
      }
    ]
  }
}

OrderPreparationDataObject

Prepared data for order creation

Fields

Field	Type	Description
allTariffsTripEstimations	Array of TripEstimationObject	Trip estimations for different tariffs

Code Sample

{
  "allTariffsTripEstimations": [
    {
      "cost": 33.34,
      "fixedCost": true,
      "priceMultiplier": 2.1,
      "tariffId": "12345678-1234-1234-1234-1234567890AB"
    }
  ]
}

TripEstimationObject

Trip estimation information

Fields

Field	Type	Description
cost	Number	Estimated trip cost
fixedCost	Boolean	Fixed trip cost option
priceMultiplier	Number	Price multiplier
tariffId	String	Service type UUID

Code Sample

{
  "cost": 33.34,
  "fixedCost": true,
  "priceMultiplier": 2.1,
  "tariffId": "12345678-1234-1234-1234-1234567890AB"
}

TopupRequestObject

Request object for driver account topup

Fields

Field	Type	Description
money	Object	Money amount details
comment	String	Additional information about the topup transaction

WithdrawRequestObject

Request object for driver account withdrawal

Fields

Field	Type	Description
money	Object	Money amount details
comment	String	Reason for the withdrawal

CommitInvoiceRequestObject

Request object for committing a pending invoice

Fields

Field	Type	Description
invoiceId	String	Unique identifier of the invoice to commit

InvoiceObject

Invoice information

Fields

Field	Type	Description
invoiceId	String	Unique identifier for the invoice
status	String	Current status of the invoice (e.g. pending, committed)
type	String	Type of invoice (topup or withdraw)
amount	Number	Invoice amount
currency	String	Currency code (e.g. EUR)
comment	String	Additional information or reason for the invoice
createdAt	String	Invoice creation timestamp in RFC3339 format
updatedAt	String	Last update timestamp in RFC3339 format

OrderConfirmRequestObject

Request object for confirming an order

Fields

Field	Type	Description
confirmationId	String	Identifier of the operation
extraOptions	Array of Enum	AIR_CONDITION NON_SMOKING SMOKING_ALLOWED EXTRA_LUGGAGE_SPACE CHILD_SEAT DISABLED_PEOPLE PETS_ALLOWED BIKE_MOUNT
client	CustomerObject	Customer info like name, UUID, image, etc.
notes	String	Text notes for an order
numberOfSeats	Integer	Number of seats needed
vehicleType	Enum	ECONOMY CLASSIC BUSINESS LUXURY RICKSHAW MOTO TESLA BLACK_CAR BLACK_CAB SUV MINIVAN VAN BUS LIMOUSINE HELICOPTER SPEED_BOAT YACHT TOW_TRUCK AMBULANCE PARATRANSIT DELIVERY_TRUCK MOTO_XL COURIER PEDICAB TOW_TRUCK_SMALL TOW_TRUCK_INDUSTRIAL ELECTRIC_VEHICLE HANDYMAN PLUMBER ELECTRICIAN LOCKSMITH DOCTOR NURSE MAID BABYSITTER LAWYER INSURANCE_INSPECTOR CLAIMS_ADJUSTER
tariffType	Enum	PRECISE HOURLY
paymentMethods	Enum	CASH TERMINAL THIRD_PARTY
prepaid	Boolean	If true - the trip was paid before it started (currently not supported)
manualAssignDriver	String	Driver Id that is used for manual assign

Code Sample

{
  "confirmationId": "12345678-1234-1234-1234-1234567890AB",
  "extraOptions": [
    "CHILD_SEAT"
  ],
  "client": {
    "clientId": "12345678-1234-1234-1234-1234567890AB",
    "name": "John Smith",
    "phone": "+123121231212",
    "imageUrl": "https://image.com/"
  },
  "notes": "Some text",
  "numberOfSeats": 4,
  "vehicleType": "BUS",
  "tariffType": "PRECISE",
  "paymentMethods": [
    "CASH",
    "TERMINAL"
  ],
  "prepaid": false,
  "manualAssignDriver": "12345678-1234-1234-1234-1234567890AB"
}

OrderConfirmResponseObject

Response object for confirming an order

Fields

Field	Type	Description
orderId	String	Order UUID

Code Sample

{
  "orderId": "12345678-1234-1234-1234-1234567890AB"
}