6. Transflo Mobile API

Mobile APIs allow you to perform typical SQL-type operations such as selecting, creating, updating, and deleting items in the mobile application.

To view the available APIs:

Open the Pegasus Transtech API Documentation web page at http://147.202.82.196/Integration/sdk/index.

(same link with https appears below)

https://svc.transflomobile.com/integration/sdk/index#/
In the drop-down list at the top of the page, select Transflo Mobile+ Integration API V2 and click the Explore button.
Scroll down to the API you want to view and click List Operations to view a list of methods.
Click the method (GET, PUT, POST, DELETE) to view parameters, response messages, and samples.

The following tables present the available APIs in alphabetical order.

Tip: Subject to change with or without notice. For the latest API documentation, see https://svc.transflomobile.com/integration/sdk.

Batches

Operation	Description
GET	/api/v2/ondemand/batches/{recipientId}/{confirmationNumber}	Returns a batch file

Events

Operation	Description	Result
GET	/api/v2/events/{recipientId}/driver/{email}/type/{eventType}/{commandType}	Returns the events for a specified Recipient
GET	/api/v2/events/{recipientId}/driver/{email}/type/{eventType}	Returns the events for a specified Recipient
GET	/api/v2/events/{recipientId}/type/{eventType}/{commandType}	Returns the events for a specified Recipient
GET	/api/v2/events/{recipientId}/type/{eventType}	Returns the events for a specified Recipient
GET	/api/v2/events/{recipientId}/driver/{email}	Returns the events for a specified Recipient
GET	/api/v2/events/{recipientId}	Returns the events for a specified Recipient

ExtendedSearch

Operation	Description	Result
GET	/api/v2/ondemand/request/{divisionId}	Returns the list of pending Transflo OnDemand Batches
PUT	/api/v2/ondemand/request/{divisionId}/{requestId}	Updates a processed Transflo OnDemand Batch

FormSubmit

Operation	Description	Result
POST	/api/v2/form/submit/{recipientId}/{emailAddress}	Sends an email with a custom Name-Value list of fields for a specified recipient and email
POST	/api/v2/form/submit/referral/{recipientId}/{emailAddress}	Sends an email with a custom Name-Value list of fields for a specified recipient and email

FreeformLoad

Operation	Description	Result
POST	/api/v2/loads/freeform	Creates a free form load

FullLoads

Operation	Description	Result
DELETE	/api/v2/loads	Deletes a Load
GET	/api/v2/loads	Returns a Load
POST	/api/v2/loads	Creates a Load under a specific Recipient
PUT	/api/v2/loads	Updates a Load information
POST	/api/v2/stops/{recipientId}/{loadNumber}	Adds a stop to an existent load

LoadAssign

Operation	Description	Result
DELETE	/api/v2/loads/assign	Removes the assignment information between a load and drivers
PUT	/api/v2/loads/assign	Adds or modify the assignment information between a load and drivers

LoadMessages

Operation	Description	Result
POST	/api/v2/loads/message	Sends a load message to a specific driver

Loads

Operation	Description	Result
DELETE	/api/v2/loads/simple	Deletes a Load
GET	/api/v2/loads/simple	Returns a SimpleLoad
POST	/api/v2/loads/simple	Creates a Simple Load under a specific Recipient
PUT	/api/v2/loads/simple	Updates a Simple load information
DELETE	/api/v2/loads/tender	Removes the tendering information between a load and drivers
PUT	/api/v2/loads/tender	Adds or modify the tendering information between a load and drivers
DELETE	/api/v2/loads/assign	Removes the assignment information between a load and drivers
PUT	/api/v2/loads/assign	Adds or modify the assignment information between a load and drivers
DELETE	/api/v2/loads	Deletes a Load
GET	/api/v2/loads	Returns a Load
POST	/api/v2/loads	Creates a Load under a specific Recipient
PUT	/api/v2/loads	Updates a Load information
POST	/api/v2/loads/freeform	Creates a free form load
POST	/api/v2/loads/message	Sends a load message to a specific driver
POST	/api/v2/stops/{recipientId}/{loadNumber}	Adds a stop to an existent load
PUT	/api/v2/loads/state	Updates a load to another state
PUT	/api/v2/load/metadata/{loadNumber}/{recipientId}	Updates a Load metadata information

LoadsMetadata

Operation	Description	Result
PUT	/api/v2/load/metadata/{loadNumber}/{recipientId}	Updates a Load metadata information

LoadState

Operation	Description	Result
PUT	/api/v2/loads/state	Updates a load to another state

LoadTender

Operation	Description	Result
DELETE	/api/v2/loads/tender	Removes the tendering information between a load and drivers
PUT	/api/v2/loads/tender	Adds or modify the tendering information between a load and drivers

Lock/Unlock App

Operation	Description	Result
PUT	/api/v2/lock	Sends a command to lock the TFM+ app to a specific driver
PUT	/api/v2/unlock	Sends a command to unlock the TFM+ app to a specific driver

Notifications

Operation	Description	Result
POST	/api/v2/notifications	Sends a one-way message to a specific driver
POST	/api/v2/broadcastNotifications	Sends a fleet-wide one-way message

OnDemand

Operation	Description	Result
GET	/api/v2/ondemand/batches/{recipientId}/{confirmationNumber}	Returns a batch file
GET	/api/v2/ondemand/request/{divisionId}	Returns the list of pending Transflo OnDemand Batches
PUT	/api/v2/ondemand/request/{divisionId}/{requestId}	Updates a processed Transflo OnDemand Batch

Simple Load

Operation	Description	Result
DELETE	/api/v2/loads/simple	Deletes a Load
GET	/api/v2/loads/simple	Returns a SimpleLoad
POST	/api/v2/loads/simple	Creates a Simple Load under a specific Recipient
PUT	/api/v2/loads/simple	Updates a Simple load information

Stop

Operation	Description	Result
POST	/api/v2/stops/{recipientId}/{loadNumber}	Adds a stop to an existent load
PUT	/api/v2/stop/state	Update the state of a stop

Tracking

Operation	Description	Result
PUT	/api/v2/starttracking	Sends a StartTracking command to a specific driver
PUT	/api/v2/stoptracking	Sends a StopTracking command to a specific driver

Operation

Description

Result

PUT

/api/v2/starttracking

Sends a StartTracking command to a specific driver

PUT

/api/v2/stoptracking

Sends a StopTracking command to a specific driver

Two-Way Messages

Operation	Description	Result
POST	/api/v2/messages	Sends a two-way message to a specific driver

Validation

Operation	Description	Result
POST	/api/v2/validate/driver	Validates that the Driver Token matches the DriverId provided for a given fleet

Transflo would love your feedback on our solutions and the support we provide to you!

All rights reserved. Transflo believes the information in this publication is accurate as published; however, information is subject to change without notice. Use, copying, and distribution of any TRANSFLO software described in this publication requires an applicable software license. THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” TRANSFLO, LLC MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Transflo content appearing in third-party AI chat bots and other third-party sites might not be accurate. For the latest updates about Transflo products, visit transflo.com and knowledge.transflo.com.