Introduction
Client Identification
Deprecations
Errors
Localization
Accept-Language header
Determining available languages
Working with CDN images
Working with payment methods
How are payment methods configured?
Where to get payment methods that are available to a customer?
Authentication
General
Uploads
post
Upload Image
Utilities
get
Download Async Document
User Authentication
Signup
post
Signup with E-Mail
Session
post
Sign In with E-Mail
post
Refresh Access Token
post
Sign Out
Password Reset
post
Reset Password
post
Change Password
Push Tokens
post
Store push token
del
Remove push token
User Account
Account
get
User Account
get
User Config
get
Account Features Status
post
Verify Email
post
Request Email Verification Code
Profile
get
Show Profile
put
Update Profile
put
Update Profile as Admin/Org. Manager
Opt-Ins
get
View Opt-In Status
patch
Update Opt-Ins
Invoice Address
get
Show Invoice Address
patch
Update Invoice Address
patch
Update Invoice Address as Admin/Org. Manager
Customer's Vouchers
get
Vouchers attached to current user
post
Attach Voucher to current user.
del
Detach Voucher from current user.
Document Verification
get
Current Document Verification
post
Create Document Verification
del
Invalidate Document Verification
post
Submit Document Verification
User Management
Adding Users
post
Create user
post
Invite users
Managing Users
get
Account Features Status
get
List Users
get
Show a user
del
Anonymize User
put
Change User's metadata
post
Block user
del
Unblock user
get
Export Users as CSV
Managing Opt-Ins
get
View User Opt-Ins
Payment Methods
get
View payment methods
patch
Update payment methods
Document Verification Management
get
User's Document Verifications
post
Manual Document Verification
post
Invalidate Document Verification
Muting Driver Requests
put
Mute driver requests
del
Unmute driver requests
Payments
Stripe
get
List Credit Cards
get
List SEPA accounts
post
Create Pre-authorization
Organizations
Managing Organizations
get
List all Organizations
post
Create Organization
get
Show Organization
put
Update Organization
Changing Driver's Organization
put
Change Driver's Organization
Hailing
Feature Detection
get
Hailing Booking configuration
get
Hailing Driver configuration
get
Capabilities configuration
get
Hailing Services configuration
get
Failure Reasons Detection
get
Price Query
get
Service area scheduling configuration
Create & Update Bookings
post
Create a Hailing Booking
put
Update stop's content
put
Update Hailing Booking
put
Change booking's metadata
put
Perform a transition on a hailing booking
post
Force-assign driver
List Bookings
get
All Hailing Bookings
get
Active bookings
get
Delivered bookings
get
Cancelled bookings
get
Scheduled bookings
Unassigned Bookings
get
List of unassigned bookings
get
Show unassigned booking
post
Claim unassigned booking
Pickable Bookings
get
List pickable bookings
get
Show pickable booking
post
Pick a booking
Scan to Start
get
Find by package ID
post
Start from scanned package ID
Interact with Stops
post
Submit stop delivery proofs
Advanced Dispatching
post
Dispatch stops into a tour
post
Dispatch a booking
post
Undispatch tour's stops
Discounts
get
List All Discounts
put
Set a Discount
Hailing Driver
Driver's Capabilities
get
Current Capabilities
post
Set Capabilities
Driver's Location
put
Set Location - Deprecated
put
Set Location
Driver's Status
del
Go offline
post
Go Online
del
Go offline
del
Send Driver offline
Fleet
Fleet Configuration
get
Fleet Configuration
Vehicle Management
get
List all vehicles
post
Create new vehicle
get
Show a vehicle
patch
Update vehicle
post
Archive vehicle
put
Change vehicle's operational status
post
Refresh vehicle's status
get
List all vehicle configurations
post
Create new vehicle configuration
get
Show a vehicle configurations
patch
Update a vehicle configuration
del
Delete a vehicle configuration
Vehicle Interaction
post
Lock Engine
del
Unlock Engine
post
Lock Doors
del
Unlock Doors
del
Unlock Maintenance Compartment
post
Lock a Vehicle
del
Unlock a Vehicle
post
Unlock a Vehicle
get
Fetch Bluetooth credentials
Sharing
Booking Management
post
Create Sharing Booking
get
All Sharing Bookings
get
Export Sharing Bookings as CSV
get
Unifinshed Sharing Bookings
get
Show Sharing Booking
Booking Events
get
List Sharing Booking Events
get
Show Sharing Booking Event
Service Areas
Service Area Management
get
Service Area Configuration
Places
Place Management
get
List all places
get
Show a place
Zones
Zone Management
get
List all zones
post
Create new zone
get
Show a Zone
patch
Update a Zone
Packages
Feature Detection
get
Packages Configuration
get
List Package properties and their options
get
Price Query
Create Package
post
Create a Package
Package Management
get
List packages
post
Generate Label Sheet
get
Show package
get
Show package journey
get
Download PDF label
put
Perform a transition on a package
post
Recover failed package
post
Relocate a package
put
Change Package's metadata
patch
Update outcome of a package interaction
Package Dispatching
post
Create package pickup tour
put
Update existing pickup tour
post
Create package dropoff tour
put
Update existing dropoff tour
Custom Screens
Custom Screens
post
Custom Screen Data Endpoint
