Skip to content
English - United States
Contact us
  • There are no suggestions because the search field is empty.

Referencing Saved Locations via API

Why Use Saved Location Referencing?

Many integrated Tive customers use the platform to create saved locations with precise geofences. However, referencing these saved locations via API has often been a challenge, leading to duplicate entries, incomplete shipments, and unnecessary alert noise.

Saved Location Referencing solves these issues by allowing users to reference pre-created locations using unique Tive-generated IDs, rather than manually entering coordinates and addresses each time.

Key Benefits:

  • Eliminates location duplication – No need to create the same location multiple times.
  • Reduces errors – Prevents issues that lead to incomplete shipments and alert noise.
  • Streamlines shipment creation – Use saved identifiers for faster, more reliable API interactions.
  • Improves consistency – Maintains centralized, accurate location data across your organization.

Note: This feature is available for customers on the Premium tier or any account with the API flag enabled.

How It Works

Follow the steps below to ensure your saved locations are referenced correctly via the API.

Step 1: Verify That the Locations Are Saved

  • Navigate to Configure > Locations in the Tive Platform.
  • Click on the Saved tab and ensure your desired locations appear there.
  • Use the search bar to locate a specific address or location name.

If a location isn’t under the Saved tab:

  • Go to the Suggested tab.
  • Find the location and click Save Location.
  • Add any required information to officially save it.

Step 2: Fetch Location IDs

You can retrieve the unique Tive IDs (used for referencing via API) in two ways:

Option 1: Via API (Recommended)
  • Call the List Locations endpoint: /public/v3/Locations.
  • This will return a paginated list of your saved locations.
  • Each location object will include an id field that can be used in shipment creation.

Note: View the Tive API Documentation here.

Option 2: Via the Tive Platform
  • Go to Configure > Locations.
  • Each saved location includes a visible ID field that can be copied and used in the API.

Step 3: Create a Shipment Using Location IDs

  • Use the Create Shipment endpoint.
  • Instead of entering an address and coordinates for each leg:
    • Use the fromLocationId for the origin.
    • Use the toLocationId for the destination.

This references your saved locations directly, simplifying shipment creation and ensuring data accuracy.

Key Points to Know

Requirements:

  • Only available to Premium-tier customers or those with the API feature enabled.

Avoid Common Mistakes:

  • Don’t skip saving a location before referencing it—this ensures you’re using high-quality geofences in all of your API-generated shipments. 
  • Always verify that you’re using the correct location id.

Integration Tip:

  • Works seamlessly with other Tive API tools and shipment management workflows.

Best Practices

  • Always Use API for ID Fetching - Automating the fetch process via API helps reduce human error and streamlines the workflow.
  • Audit Your Saved Locations Regularly - Ensure your location data is clean, up to date, and correctly labeled to avoid confusion during API calls.
  • Centralize Location Creation - Limit location creation to a designated admin or automated system to maintain data consistency and avoid duplicates.
  • Security Tip - Avoid exposing sensitive location IDs in client-side code or unsecured environments.