taxi130 ops

Taxi API

Rides, drivers, vehicles, dispatching, pricing rules, and live trip state.

Queries

QUERY

adminDriverMap

#

Get drivers in viewport with automatic clustering based on zoom level. Returns clusters for areas with many drivers and individual markers for areas below the clustering threshold. The clustering behavior adapts based on zoom level: - Street view (zoom >= 17): Always show individual drivers - City view (zoom <= 8): Cluster aggressively (> 2 drivers) - Standard zoom: Cluster when > 5 drivers in a cell # Arguments * input.bounds - Viewport bounds (sw/ne corners) * input.zoom - Map zoom level (1-20) * input.online_status - Optional filter by Online or Busy # Example

graphqlquery {
adminDriverMap(input: {
bounds: {
sw: { latitude: 40.70, longitude: -74.02 }
ne: { latitude: 40.75, longitude: -73.97 }
}
zoom: 14
}) {
clusters {
h3Index
count
centroid { latitude longitude }
onlineCount
busyCount
}
singles {
driverId
coordinates { latitude longitude heading }
onlineStatus
lastUpdatedAt
}
h3Resolution
totalCount
}
}

# Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
Returns!
QUERY

dispatchProfile

#

Arguments

  • id!
Returns
QUERY

dispatchProfileComparison

#

How each dispatch profile performed against the baseline between from and to.

Arguments

  • input!
Returns!
QUERY

dispatchProfiles

#

The workspace's dispatch profiles, oldest first.

Arguments

  • includeArchivedBoolean!

    Default

    false
Returns[!]!
QUERY

driver

#

Get a single driver by ID with all related data. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • id!
Returns
QUERY

driverLeaderboard

#

Get driver leaderboard. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
Returns!
QUERY

drivers

#

List drivers with filtering and pagination. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
Returns!
QUERY

driverServiceClassEligibility

#

Explain whether a driver is eligible for a given service class. Runs the same EligibilityEvaluator the dispatch path uses, so the answer is authoritative — no chance of admin and dispatch disagreeing. When the driver is ineligible, returns the structured reasons so support can pinpoint the failing dimension. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • driverId!
  • serviceClassId!
Returns!
QUERY

exportDrivers

#

The drivers drivers returns for the same input, as a CSV file: every page at once, up to 5,000 rows. input.pagination is ignored. truncated says when more matched than the file holds. Email and phone are masked exactly as the list masks them. # Authorization Requires TenantAdmin or PlatformAdmin role. A staff seat needs both Manage drivers and Export data; the owner needs no grant.

Arguments

  • input!
Returns!
QUERY

groupFlatFareAdmin

#

Arguments

  • id!
Returns
QUERY

groupFlatFaresAdmin

#

Group flat fares, newest start first unless sort asks otherwise. Requires an admin role.

Arguments

  • input!
Returns!
QUERY

myActiveTaxiRides

#

Get active taxi rides for the current user, scoped to the role they're acting under for this request. The same account can hold both Customer and Driver roles (common in dev and for tenants where drivers also ride as passengers). If we returned the union we'd leak the user's own passenger-side dispatching order into the driver app, which then renders it as an active trip and hides the actual ride-offer Accept UI. So we scope by request_ctx.role.

Returns[!]!
QUERY

myRideOffers

#

Get pending ride offers for the current driver. Returns only non-expired offers sorted by creation time (newest first).

Returns[!]!
QUERY

myRideTotals

#

The current driver's rides and earnings since since — for "today", pass the driver's local midnight. Covers the rides counted for the driver at or after since. A ride is counted the moment it is settled, so it shows here as soon as it ends, whichever day it was booked on.

Arguments

  • since!
Returns!
QUERY

nearbyDriversForMap

#

Get nearby driver coordinates for map display. Returns 5-20 nearby available drivers around a center point for UI visualization. This is a lightweight query - it only returns driver IDs, coordinates, and ratings. # Arguments * input.center - Center coordinates to search from * input.limit - Max drivers to return (5-20, default 10) * input.radius_meters - Search radius in meters (default 5000m) # Example

graphqlquery {
nearbyDriversForMap(input: {
center: { latitude: 40.7128, longitude: -74.0060 }
limit: 15
}) {
driverId
coordinates { latitude longitude }
rating
}
}

Arguments

  • input!
Returns[!]!
QUERY

recentTravelLocations

#

Get recent unique travel locations (pickup/dropoff addresses) from order history. Returns locations deduplicated by coordinates, ordered by most recent usage. Useful for showing users their frequently used addresses for quick selection. # Arguments * near - Where the passenger is now, or the pickup they chose. When given, only places within 100 km of it are returned, so a trip taken in another city is not offered here. Without it, every recent place. * limit - Maximum number of unique locations to return (default: 5, max: 20) # Example

graphqlquery {
recentTravelLocations(near: { latitude: 51.5, longitude: -0.12 }, limit: 5) {
id
coordinates { latitude longitude }
formattedAddress
label
kind
lastUsedAt
}
}

Arguments

  • near
  • limitInt!

    Default

    5
Returns[!]!
QUERY

regionZoneOrderUsage

#

Submitted taxi orders by pickup region and zone over the last 30 full UTC days. Region totals include orders with no pickup zone; zone totals include only orders assigned to that zone.

Returns[!]!
QUERY

rideOptionPricingAdmin

#

Get a single ride option pricing by ID. # Authorization Requires TenantAdmin role. # Arguments * id - Ride option pricing ID * currency - Currency to display fee in (defaults to USD)

Arguments

  • id!
  • currency!

    Default

    "USD"
Returns
QUERY

rideOptionPricingsAdmin

#

List ride option pricings with pagination and filtering. # Authorization Requires TenantAdmin role. # Arguments * input - Filter and pagination options * currency - Currency to display fees in (defaults to USD)

Arguments

  • input!
  • currency!

    Default

    "USD"
Returns!
QUERY

serviceClassAdmin

#

Get a single service class by ID for admin. # Authorization Requires TenantAdmin role.

Arguments

  • id!
Returns
QUERY

serviceClassesAdmin

#

List service classes for admin with pagination. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
QUERY

serviceClassVehicleCatalog

#

The vehicle catalog by style, for the service-class form: one tab per style, each vehicle with its map markers (white, black, amber) and its card image (white livery).

Returns[!]!
QUERY

serviceClassVehiclePreview

#

A catalog vehicle painted in paint (#rrggbb), as a PNG data URL, so the service-class form can show a colour before it is saved. Rendered on demand and never stored; saving the class is what stores its images. A style that cannot be painted comes back in its own livery.

Arguments

  • style!
  • vehicle!
  • view!
  • paintString!
ReturnsString!
QUERY

taxiOperationsConfig

#

Read the calling tenant's taxi-operations toggles. Returns the "all-on" default when no row exists yet.

Returns!
QUERY

timeBandAdmin

#

Arguments

  • id!
Returns
QUERY

timeBandsAdmin

#

Time bands, by name unless sort asks otherwise. Requires an admin role.

Arguments

  • input!
Returns!
QUERY

tripShare

#

Public, unauthenticated live view of a shared trip, addressed by its share token. Returns null for unknown, expired, or revoked tokens alike (no enumeration signal). Intended to be polled by a logged-out "follow my ride" web page. The gateway must allow this query through without authentication and rate-limit it by token/IP (tracked as the pre-prod gateway carve-out).

Arguments

  • tokenString!
Returns
QUERY

vehicleCatalogConfig

#

Get the current tenant's vehicle catalog config. Returns the "show everything" defaults when no row exists yet — so callers always get a non-null payload they can render straight into the settings UI.

Returns!
QUERY

vehicleColorAdmin

#

One vehicle colour, as the admin list shows it: the workspace's own or a platform global, active or not. null when no such colour is visible to the workspace. # Authorization Requires TenantAdmin role.

Arguments

  • id!
Returns
QUERY

vehicleColors

#

Get paginated list of active vehicle colors Returns colors available for the tenant (tenant overrides + global colors). Results are ordered by position.

Arguments

  • pagination!

    Default

    {
      "limit": 10,
      "page": 1,
      "after": null
    }
  • searchString

    Search by name (case-insensitive)

Returns!
QUERY

vehicleColorsAdmin

#

List vehicle colors for admin with pagination. # Authorization Requires TenantAdmin role.

Arguments

  • input
  • details
Returns!
QUERY

vehicleMakeAdmin

#

One vehicle make, as the admin list shows it: the workspace's own or a platform global, active or not. null when no such make is visible to the workspace. # Authorization Requires TenantAdmin role.

Arguments

  • id!
Returns
QUERY

vehicleMakes

#

Get paginated list of active vehicle makes Returns makes available for the tenant (tenant overrides + global makes). Results are ordered by position.

Arguments

  • pagination!

    Default

    {
      "limit": 10,
      "page": 1,
      "after": null
    }
  • searchString

    Search by name (case-insensitive)

Returns!
QUERY

vehicleMakesAdmin

#

List vehicle makes for admin with pagination. # Authorization Requires TenantAdmin role.

Arguments

  • input
  • details
Returns!
QUERY

vehicleModelAdmin

#

One vehicle model, as the admin list shows it: the workspace's own or a platform global, active or not. null when no such model is visible to the workspace. # Authorization Requires TenantAdmin role.

Arguments

  • id!
Returns
QUERY

vehicleModels

#

Get paginated list of active vehicle models Returns models available for the tenant (tenant overrides + global models). Optionally filter by make_id. Results are ordered by position.

Arguments

  • pagination!

    Default

    {
      "limit": 10,
      "page": 1,
      "after": null
    }
  • searchString

    Search by name (case-insensitive)

  • makeId

    Filter by make ID

Returns!
QUERY

vehicleModelsAdmin

#

List vehicle models for admin with pagination. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
QUERY

vehicleModelsByIds

#

The vehicle models among ids the workspace can see (its own and platform globals, active or not), in catalog order. Ids that match no visible model are left out. At most 500 ids per call. # Authorization Requires TenantAdmin role.

Arguments

  • ids[!]!
Returns[!]!
QUERY

zoneFlatFareAdmin

#

Arguments

  • id!
Returns
QUERY

zoneFlatFaresAdmin

#

Zone flat fares, newest start first unless sort asks otherwise. Requires an admin role.

Arguments

  • input!
Returns!
QUERY

zoneSurchargeAdmin

#

Arguments

  • id!
Returns
QUERY

zoneSurchargesAdmin

#

Zone surcharges, newest start first unless sort asks otherwise. Requires an admin role.

Arguments

  • input!
Returns!

Mutations

MUTATION

acceptTaxiOrder

#

Driver accepts a dispatched taxi order

Arguments

  • input!
Returns!
MUTATION

adminParseRideRequest

#

Read a booking request written in plain language and return the trip it asks for: who, from where, to where, when and in what kind of vehicle. Places are returned in the request's own words, to be looked up with address search. Nothing is booked, quoted or stored. For workspace admins, with the dispatcher copilot switched on under Settings → AI. A mutation because each call spends on the workspace's AI provider. Errors carry a code: AI_NOT_ENABLED when the feature is off, AI_CALL_FAILED when the provider could not be reached or refused, AI_PARSE_FAILED when its answer could not be used, INVALID_INPUT for an empty or over-long request or an unknown time zone, and UNAUTHORIZED for a caller who is not an admin.

Arguments

  • input!
Returns!
MUTATION

approveDriver

#

Approve a driver (approves their KYC application). # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • id!
Returns!
MUTATION

archiveDispatchProfile

#

Hide a paused, non-baseline profile. Its past orders still resolve.

Arguments

  • id!
Returns!
MUTATION

arriveAtWaypoint

#

Driver marks arrival at a specific waypoint (pickup, intermediate stop, or dropoff)

Arguments

  • input!
Returns!
MUTATION

arrivedToDestination

#

Driver marks arrival at destination (ride complete)

Arguments

  • input!
Returns!
MUTATION

arrivedToPickup

#

Driver marks arrival at pickup location

Arguments

  • input!
Returns!
MUTATION

assignDriverToOrder

#

Manually assign a driver to an order. # Authorization Requires TenantAdmin or PlatformAdmin role. # Arguments * input - The driver assignment input containing orderId, driverId, and optional force flag # Returns The assignment response containing success status, updated order, and optional message. # Errors - Unauthorized: If caller is not an admin - NotFound: If order or driver does not exist - InvalidState: If order is not in a dispatchable state or driver is not approved - InvalidState: If order already has a driver and force=false

Arguments

  • input!
Returns!
MUTATION

changeOrderPaymentMethod

#

Swap the payment method used for an active taxi order. Allowed any time before the payment for the order is captured (i.e. from booking through end-of-ride payment confirmation). The new method is authorized / debited first; only on success is the previous method voided or refunded. # Errors - INVALID_INPUT — missing/extra payment_method_id for the chosen type. - INVALID_STATE — order is in a terminal state, already captured, or the new method needs 3DS verification (not supported in swap flow today). - PAYMENT_FAILED — PSP declined the new method. - UNAUTHORIZED — caller is not the order owner.

Arguments

  • input!
Returns!
MUTATION

confirmMeteredFee

#

Confirm the metered fare submitted by driver. Called by passenger after reviewing the driver-submitted fare. Once confirmed, payment is captured and the ride is completed.

Arguments

  • input!
Returns!
MUTATION

createDispatchProfile

#

Create a dispatch profile. It starts paused (0% of traffic) with a copy of another profile's settings — the baseline's unless named.

Arguments

  • input!
Returns!
MUTATION

createDriver

#

Create a new driver. Creates an account (if needed) and a driver record with all provided details including vehicle information, profile photo, and address. # Authorization Requires TenantAdmin or PlatformAdmin role. # Input Fields - Account: email, phone, first_name, last_name, gender, country_code, profile_photo_upload_id - Address: address_line1, address_line2, city, state, postal_code, address_country_code - License: license_number, license_expiry - Vehicle: vehicle_model_id, vehicle_color_id, vehicle_year, plate_number - Assignment: zone_id

Arguments

  • input!
Returns!
MUTATION

createGroupFlatFare

#

Create a flat fare between two zone groups. Requires an admin role.

Arguments

  • input!
Returns!
MUTATION

createRideOptionPricing

#

Create a new ride option pricing. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

createServiceClass

#

Create a new service class. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

createTaxiQuote

#

Arguments

  • input!
Returns!
MUTATION

createTimeBand

#

Create a time band. Its code is derived from the name.

Arguments

  • input!
Returns!
MUTATION

createTripShare

#

Mint (or re-fetch) a public "follow my ride" link for one of the caller's own active trips. Returns a stable link if one is already active for the trip.

Arguments

  • orderId!
Returns!
MUTATION

createVehicleColor

#

Create a new vehicle color. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

createVehicleMake

#

Create a new vehicle make. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

createVehicleModel

#

Create a new vehicle model. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

createZoneFlatFare

#

Create a flat fare between two zones. Requires an admin role.

Arguments

  • input!
Returns!
MUTATION

createZoneSurcharge

#

Create a pickup/drop-off surcharge for a zone. Requires an admin role.

Arguments

  • input!
Returns!
MUTATION

deleteGroupFlatFare

#

Delete a group flat fare. Use active: false to pause one instead.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteRideOptionPricing

#

Delete a ride option pricing (soft delete). # Authorization Requires TenantAdmin role.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteServiceClass

#

Delete a service class. # Authorization Requires TenantAdmin role.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteTimeBand

#

Delete a time band no pricing rule uses.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteVehicleColor

#

Delete a vehicle color. # Authorization Requires TenantAdmin role.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteVehicleMake

#

Delete a vehicle make. # Authorization Requires TenantAdmin role.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteVehicleModel

#

Delete a vehicle model. # Authorization Requires TenantAdmin role.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteZoneFlatFare

#

Delete a zone flat fare. Use active: false to pause one instead.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteZoneSurcharge

#

Delete a zone surcharge. Use active: false to pause one instead.

Arguments

  • id!
ReturnsBoolean!
MUTATION

departFromWaypoint

#

Driver departs from a waypoint (advances to next destination)

Arguments

  • input!
Returns!
MUTATION

grantDriverKycWaiver

#

Let this driver work without KYC, deliberately and on the record. Before waivers existed an operator achieved the same thing by flipping the driver to Approved, which left nothing saying who allowed it, why, or for how long. expires_at of None means indefinite. # Authorization Requires TenantAdmin, TenantOwner or PlatformAdmin.

Arguments

  • driverId!
  • reasonString!
  • expiresAt
Returns!
MUTATION

hideGlobalVehicleColor

Deprecated#

Deployed web clients still call this; retire through BET-204's web gate.

Deprecation reason: Use setGlobalVehicleCatalogItemHidden; retirement tracked in BET-204

Arguments

  • colorId!
Returns!
MUTATION

hideGlobalVehicleMake

Deprecated#

Deployed web clients still call this; retire through BET-204's web gate.

Deprecation reason: Use setGlobalVehicleCatalogItemHidden; retirement tracked in BET-204

Arguments

  • makeId!
Returns!
MUTATION

hideGlobalVehicleModel

Deprecated#

Deployed web clients still call this; retire through BET-204's web gate.

Deprecation reason: Use setGlobalVehicleCatalogItemHidden; retirement tracked in BET-204

Arguments

  • modelId!
Returns!
MUTATION

initiateRide

#

Driver initiates ride (passenger picked up)

Arguments

  • input!
Returns!
MUTATION

parseRideRequest

#

Read what a rider typed or said ("to the airport at 6 tomorrow, a big car") and return the trip it asks for. Places are returned in the rider's own words, to be looked up with address search. Nothing is booked, quoted or stored. For a signed-in account, with the ride booking assistant switched on under Settings → AI. Each account may ask 10 times in 10 minutes, and a request may be 500 characters long. Errors carry a code: UNAUTHENTICATED without a session, AI_NOT_ENABLED when the feature is off, RATE_LIMITED (with retryAfterSecs) when the account has asked too often, AI_CALL_FAILED or AI_PARSE_FAILED when the request could not be read, and INVALID_INPUT for an empty or over-long request or an unknown time zone. The message never names the provider or says why it failed.

Arguments

  • input!
Returns!
MUTATION

raiseSos

#

Raise an SOS during an active trip. Emits a realtime safety alert and opens a maximum-priority support ticket for ops triage. Returns the ticket reference so the rider sees confirmation help is on the way.

Arguments

  • input!
Returns!
MUTATION

rejectDriver

#

Reject a driver (rejects their KYC application). # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • id!
  • reasonString!
Returns!
MUTATION

rejectTaxiOrder

#

Driver rejects a dispatched taxi order

Arguments

  • input!
Returns!
MUTATION

rerouteMyRide

#

The driver's app asks for a new route after the driver has left the one they were following. The app follows the route on the phone and knows first when a turn was missed. Whether a route is then asked of a routing provider is decided here, against the ride's reroute budget, so a refusal is an ordinary answer and not an error: the app keeps the route it has and, when told to, asks again later.

Arguments

  • input!
Returns!
MUTATION

restoreDispatchProfile

#

Bring an archived profile back, paused.

Arguments

  • id!
Returns!
MUTATION

retractMeteredFee

#

Driver retracts a previously submitted metered fee so they can re-enter it. Rolls the order back from PendingFeeConfirmation to PendingMeteredFee.

Arguments

  • input!
Returns!
MUTATION

revokeDriverKycWaiver

#

Withdraw a waiver. The driver falls back to needing real KYC to go online; they are not forced offline mid-shift, but cannot come back on without it. # Authorization Requires TenantAdmin, TenantOwner or PlatformAdmin.

Arguments

  • driverId!
ReturnsBoolean!
MUTATION

revokeTripShare

#

Revoke a share link the caller previously created. Returns true if a link was revoked, false if there was nothing to revoke.

Arguments

  • shareId!
ReturnsBoolean!
MUTATION

riderPaidInCash

#

Driver confirms rider paid in cash

Arguments

  • input!
Returns!
MUTATION

rollbackDispatchProfile

#

Make an earlier version of a profile's settings current again, as a new version.

Arguments

  • id!
  • versionInt!
Returns!
MUTATION

setBaselineDispatchProfile

#

Make a live profile the one every other is compared against.

Arguments

  • id!
Returns[!]!
MUTATION

setDispatchTrafficSplit

#

Replace the traffic split. Name every non-archived profile once; the shares must total 10000 basis points.

Arguments

  • input!
Returns[!]!
MUTATION

setDriverOffline

Deprecated#

Deprecation reason: Use setDriverOfflineResult; BET-205

Returns!
MUTATION

setDriverOfflineResult

#

Set driver status to offline (unavailable for orders) This mutation: - Sets the driver as unavailable - Removes driver info from Redis cache (demotes from online pool)

Returns!
MUTATION

setDriverOnline

Deprecated#

Deprecation reason: Use setDriverOnlineResult; BET-205

Arguments

  • input!
Returns!
MUTATION

setDriverOnlineResult

#

Set driver status to online (available for orders) This mutation: - Validates that the driver is approved - Infers the zone from the provided coordinates - Updates the driver's location - Sets the driver as available - Promotes driver info to Redis cache for quick dispatch

Arguments

  • input!
Returns!
MUTATION

setDriverServiceClassEnabled

#

Enable or disable one of the service classes the driver qualifies for. Disabling a class removes the driver from dispatch for it end-to-end: they stop receiving offers for it immediately while online, and are not indexed for it on their next go-online. Re-enabling restores it (subject to the driver still qualifying). In-flight offers/trips are unaffected. Returns the driver's refreshed manageable classes, each with its current on/off state.

Arguments

  • serviceClassId!
  • enabledBoolean!
Returns[!]!
MUTATION

setDriverServiceClasses

#

Set the service classes for a driver. Replaces all existing service class assignments with the provided list. Pass an empty array to remove all service class assignments. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
Returns[!]!
MUTATION

setDriverServiceClassOverride

#

Set or clear a single (driver, service class) eligibility override. INCLUDE forces the driver eligible regardless of dynamic criteria. EXCLUDE forces the driver ineligible regardless of dynamic criteria. CLEAR removes any existing override; eligibility falls back to pure criteria evaluation (or to manual-roster check on Manual classes). Note: this only persists the override row. The driver's currently cached eligible-set updates next time they go online; for an immediate effect, an admin can also force-offline the driver. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
ReturnsBoolean!
MUTATION

setDriverVipEligible

#

Toggle a driver's VIP-class eligibility. Default is true for all drivers; admins flip to false to exclude a specific driver from VIP-tier dispatch (without revoking the qualifying ratings/vehicle). Requires TenantAdmin or PlatformAdmin role.

Arguments

  • driverId!
  • eligibleBoolean!
ReturnsBoolean!
MUTATION

setGlobalVehicleCatalogItemHidden

#

Set a global catalog row's visibility in this workspace. Idempotent.

Arguments

  • kind!
  • id!
  • hiddenBoolean!
Returns!
MUTATION

setTaxiOperationsConfig

#

Toggle one or more taxi-operations availability flags for the calling tenant. Requires TenantOwner, TenantAdmin or PlatformAdmin.

Arguments

  • input!
Returns!
MUTATION

skipDeliveryPickup

#

A courier on a delivery round leaves a shop without its order: the shop is shut, or has nothing to hand over. The round goes on for the other shops; this one and the customer are told nobody is coming for that part. Only at the stop the courier has arrived at, and not for the last shop left on the round — with nothing to carry, cancel the delivery.

Arguments

  • input!
Returns!
MUTATION

submitMeteredFee

#

Driver submits metered fee at end of ride

Arguments

  • input!
Returns!
MUTATION

submitVehicleDetails

Deprecated#

Deprecation reason: Use submitVehicleDetailsResult; BET-205

Arguments

  • input!
Returns!
MUTATION

submitVehicleDetailsResult

#

Submit vehicle details during driver onboarding This mutation: - Validates that the driver is in Pending status - Validates that the vehicle model and color exist - Updates the driver's vehicle information - Changes driver status to PendingReview for admin approval After calling this mutation, the driver must wait for admin approval before they can start accepting rides.

Arguments

  • input!
Returns!
MUTATION

suggestDispatchSettings

#

Propose changes to how ride requests are offered to drivers, from a short description of the situation. Nothing is saved: the answer is the baseline profile's settings, the same settings with the proposed changes, and a reason for each. An accepted proposal becomes a new profile (createDispatchProfile, which starts with no traffic) holding proposed (updateDispatchProfile). Only a fixed list of settings can be proposed (DispatchSettingKey), each inside a range; per-tier policy and anything else is carried over untouched. For the admins who may edit dispatch settings, with the setup assistant switched on under Settings → AI. Errors carry the same codes as suggestServiceClasses, and NOT_FOUND for a workspace with no dispatch settings to start from.

Arguments

  • input
  • details
Returns!
MUTATION

suggestServiceClasses

#

Propose service classes the workspace is missing, from a short description of the operation. Nothing is created: each suggestion is a name, a capacity and a fare for an admin to accept, and an accepted one is created with createServiceClass, inactive. For the admins who may edit pricing, with the setup assistant switched on under Settings → AI. A mutation because each call spends on the workspace's AI provider. Errors carry a code: AI_NOT_ENABLED when the feature is off, AI_CALL_FAILED when the provider could not be reached or refused, AI_PARSE_FAILED when its answer could not be used, and INVALID_INPUT for an empty or over-long description.

Arguments

  • input
  • details
Returns!
MUTATION

unhideGlobalVehicleColor

Deprecated#

Deployed web clients still call this; retire through BET-204's web gate.

Deprecation reason: Use setGlobalVehicleCatalogItemHidden; retirement tracked in BET-204

Arguments

  • colorId!
Returns!
MUTATION

unhideGlobalVehicleMake

Deprecated#

Deployed web clients still call this; retire through BET-204's web gate.

Deprecation reason: Use setGlobalVehicleCatalogItemHidden; retirement tracked in BET-204

Arguments

  • makeId!
Returns!
MUTATION

unhideGlobalVehicleModel

Deprecated#

Deployed web clients still call this; retire through BET-204's web gate.

Deprecation reason: Use setGlobalVehicleCatalogItemHidden; retirement tracked in BET-204

Arguments

  • modelId!
Returns!
MUTATION

updateDispatchProfile

#

Rename a profile or change its settings. Saving settings starts a new version: orders already searching keep the version they started on.

Arguments

  • id!
  • input!
Returns!
MUTATION

updateDriver

#

Update an existing driver. Updates driver profile, license, vehicle, and photo information. Vehicle and photo updates trigger a pending review status. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
Returns!
MUTATION

updateDriverLocation

Deprecated#

Deprecation reason: Use updateDriverLocationResult; BET-205

Arguments

  • input!
Returns!
MUTATION

updateDriverLocationResult

#

Update driver's GPS location while online This mutation: - Updates driver's GPS coordinates in Redis cache - Recalculates H3 geospatial indexes if location changed significantly - Updates zone in PostgreSQL if driver moved to a different zone - Does NOT update PostgreSQL on every location ping (only Redis for performance)

Arguments

  • input!
Returns!
MUTATION

updateGroupFlatFare

#

Arguments

  • input
  • details
Returns!
MUTATION

updateOrderWaitTime

#

Update the wait/stopover time for an active taxi order. Recalculates the stopover fee based on the service class per-minute rate and updates the order total accordingly. Only the order's rider or an admin-tier session may; anyone else gets NOT_FOUND.

Arguments

  • input!
Returns!
MUTATION

updateRideOptionPricing

#

Update an existing ride option pricing. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

updateSearchRadius

Deprecated#

Retired. Drivers no longer set a personal search radius — the tenant's dispatch config alone decides how far an order reaches. Kept as a no-op so published driver apps that still call it get a success back.

Deprecation reason: No-op. Drivers no longer have a personal search radius; the dispatch config alone decides reach. Retire after published app release floors permit it; BET-222.

Arguments

  • input!
Returns!
MUTATION

updateServiceClass

#

Update an existing service class. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

updateTimeBand

#

Update a time band. Its region cannot change.

Arguments

  • input!
Returns!
MUTATION

updateVehicleCatalogToggles

#

Update the three include-globals toggles. Preserves any per-row hidden globals already set — switching the toggle off doesn't erase the cherry-picked suppressions.

Arguments

  • input!
Returns!
MUTATION

updateVehicleColor

#

Update an existing vehicle color. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

updateVehicleMake

#

Update an existing vehicle make. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

updateVehicleModel

#

Update an existing vehicle model. # Authorization Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

updateZoneFlatFare

#

Arguments

  • input
  • details
Returns!
MUTATION

updateZoneSurcharge

#

Arguments

  • input!
Returns!

Subscriptions

SUBSCRIPTION

driverEvents

#

Subscribe to driver events (Taxi service) Receive real-time events relevant to taxi drivers: - New ride offers dispatched to you - Ride acceptance confirmations - Trip lifecycle events (start, complete, cancel) - Chat messages from passengers - Earnings updates - Notifications **Requirements:** - Must be authenticated - Must have Driver role - Must be using Taxi app Example:

graphqlsubscription {
driverEvents {
__typename
... on RideOfferEvent {
orderId
pickupAddress
fare
expiresAt
}
... on TripStartedEvent {
orderId
startedAt
}
}
}
Returns!
SUBSCRIPTION

passengerEvents

#

Subscribe to passenger events (Taxi service) Receive real-time events relevant to taxi passengers: - Driver assignment notifications - Driver real-time location updates - Driver arrival notifications - Trip lifecycle events (start, complete, cancel) - Chat messages from driver - Notifications **Requirements:** - Must be authenticated - Must have Customer role - Must be using Taxi app Example:

graphqlsubscription {
passengerEvents {
__typename
... on DriverLocationUpdateEvent {
driverId
location {
lat
lng
}
eta
}
... on DriverArrivedEvent {
driverId
arrivedAt
}
}
}
Returns!