Jump to Content
Client Console
Development Console
Home
Guides
Recipes
API Reference
v1.0-dev
v1.0
v2.0-dev
v2.0
Client Console
Development Console
Log In
API Reference
Log In
Development
Home
Guides
Recipes
API Reference
How to Use Interactive API Reference
All
Pages
Start typing to search…
JUMP TO
Interplai
Introduction
How to Use Interactive API Reference
Authentication
API Key
Create new API key.
post
Retrieve all API keys for account.
get
Retrieve API key by ID.
get
Update API key by ID.
patch
Delete API key by ID.
del
Webhook Subscription
Create new webhook subscription.
post
Retrieve all webhook subscriptions for an account.
get
Retrieve webhook subscription by ID.
get
Update webhook subscription by ID.
patch
Delete webhook subscription by ID.
del
Zone
Create new zone(s).
post
Retrieve all zones for account.
get
Update zones.
patch
Delete zones.
del
Retrieve zone by ID.
get
Update zone by ID.
patch
Delete zone by ID.
del
Perform action on a zone.
post
Location
Create new location(s).
post
Retrieve all locations in a zone.
get
Update locations.
patch
Delete locations.
del
Retrieve location by ID.
get
Update location by ID.
patch
Delete location by ID.
del
Service
Create new service(s).
post
Retrieve all services in a zone.
get
Update services.
patch
Delete services.
del
Retrieve service by ID.
get
Update service by ID.
patch
Delete service by ID.
del
Vehicle
Create new vehicle(s).
post
Retrieve all vehicles in a zone.
get
Update vehicles.
patch
Delete vehicles.
del
Retrieve vehicle by ID.
get
Update vehicle by ID.
patch
Delete vehicle by ID.
del
Update vehicle action.
post
Trip
Create new trip(s).
post
Retrieve all trips in a zone.
get
Update trips.
patch
Update trip by ID.
patch
Retrieve trip by ID.
get
Update trip action.
post
Request for Quotes
Create request for quote(s).
post
Retrieve all request for quotes in a zone.
get
Retrieve request for quotes by ID.
get
Quotes
Create new quote.
post
Retrieve all quotes by request for quotes ID.
get
Retrieve all quotes by trip ID.
get
Retrieve all quotes available in a zone.
get
Retrieve quotes by ID.
get
Update quote action.
post
Optimization Solution
Retrieve all optimization solutions in a zone.
get
Retrieve optimization solution by ID.
get
Route
Retrieve all routes in a zone.
get
Retrieve all routes in a optimization solution.
get
Retrieve route by ID.
get
Accept and/or reject routes by optimization solution ID.
post
Remove trip from route.
post
Segment
Retrieve all segments in a route.
get
Retrieve segment by ID.
get
Accept and/or reject segments by route ID.
post
Remove trip from segment.
post
Waypoint
Retrieve all waypoints in a trip.
get
Update waypoints.
patch
Retrieve waypoint by ID and trip ID.
get
Update waypoint by ID.
patch
Update waypoint action.
post
Costmatrix
Calculate cost matrices.
post
Preference Settings
Retrieve all preference settings.
get
Update preference settings.
patch
User
Create new user(s).
post
Retrieve all users.
get
Delete users.
del
Retrieve user by ID.
get
Update user by ID.
patch
Delete user by ID.
del
Upload profile picture.
post
Retrieve profile picture by ID.
get
Retrieve total delivery count.
get
Driver App
Mobile Device
Retrieve all mobile devices.
get
Mobile App LogIn
Retrieve all mobile app logIns.
get
Mobile Device Verification
Retrieve all mobile device verifications.
get
Mobile App Connection
Retrieve all mobile app connections.
get
Terms and Conditions
Create new terms and conditions.
post
Retrieve all terms and conditions.
get
Terms and Conditions Status
Retrieve all terms and conditions statuses.
get
Chat Message
Add message to chat.
post
Retrieve all chat messages.
get
Retrieve chat messages by ID.
get
Powered by
How to Use Interactive API Reference
Ask AI
