Step 2. Sync your vehicles.

In Steps 1-4, you set up TMS integration by synchronizing TMS entities. In this step, use a GET call and then a PUT call to sync your vehicles between the two systems.

KeepTruckin supports bidirectional synchronization of all available entities on both platforms (users, vehicles, and assets). Begin your complete TMS integration by synchronizing all the entities. In this step, we continue setup with vehicles.

List Vehicles: GET https://api.keeptruckin.com/v1/vehicles

To ensure that all your available vehicle IDs and other details are stored (and correct) on the KeepTruckin platform, begin by retrieving a list of vehicles by calling GET https://api.keeptruckin.com/v1/vehicles. Your call returns a list of vehicles associated with your company on the KeepTruckin platform, and details about the vehicles (these are numerous and include the vehicles’ makes, models, and VINs, license information, fuel type, and various details of their current status including the driver with whom they’re currently associated).

Update Vehicles: PUT https://api.keeptruckin.com/v1/vehicles/:id

Cross-reference the list with the data stored in your system, and synchronize the two by updating KeepTruckin’s data with a PUT request to https://api.keeptruckin.com/v1/vehicles/:id in which you update the external_id field. This is the field where we store your internal TMS ID for the vehicle. This way, any updates you make to our system will include your own internal IDs in addition to those KeepTruckin assigns to vehicles.

In your update, provide one or more external_ids for each vehicle by providing with each external_id an associated integration_name, as follows:

"external_ids":[
      {
        "external_id":"201",
        "integration_name":"generic_tms"
      },
      {
        "external_id":"Truck123",
        "integration_name":"generic_maintenance_system"
      }

Update any other necessary parameters to synchronize the two systems.

📘

Learn more

Read our reference documentation for the GET call and for the PUT call for details.

Language
Authentication
Header
Click Try It! to start a request and see the response here!