Existing Endpoints

View all the available endpoints for Freight Visibility

Checkout the recipe that will allow you to configure the freight visibility:

1: Fetch a list of companies that allow vehicle tracking

• Endpoint: v1/freight_visibility/companies
• Description: Returns a list of companies that have granted permission for their vehicles to be tracked.

2: Fetch all the nearby vehicles (as per the specified location)

• Endpoint: v1/freight_visibility/vehicle_association
• Description: Retrieves a list of vehicles near a specified location, based on proximity data.

3: Subscribe to the location of a vehicle or an asset

• Endpoint: v1/freight_visibility/subscribe
• Description: Creates a subscription to start tracking the location of a specified vehicle or asset.

4: Fetch the location of all subscribed vehicles

• Endpoint: v1/freight_visibility/vehicle_locations
• Description: Retrieves the current locations of all vehicles that you have subscribed to.

5: Modify the duration of a subscription (if required)

• Endpoint: v1/freight_visibility/subscribe/{tracking_subscription_id}
• Description: Updates the duration or expiry time of an existing subscription using the subscription ID.

6: Fetch recent location details of a vehicle (within 24 hours)

• Endpoint: v1/freight_visibility/vehicle_locations/details
• Description: This endpoint is used to fetch the most recent location details of a vehicle, specifically for locations within the past 24 hours. It helps businesses track the movement of a vehicle, allowing them to assess its position, speed, and status within a recent timeframe.

7: Fetch location of company assets (based on proximity)

• Endpoint: v1/freight_visibility/asset_association
• Description: Retrieves location details for a specific vehicle over the past 24 hours.

8: Fetch the locations of all the subscribed assets

• Endpoint: v1/freight_visibility/asset_locations
• Description: Returns a list of company assets near a given location, based on proximity.