BlogContact Us

What's New?

In Summer 2022, Tive released a new version of public API endpoints (v3). This version can currently be used side by side with our legacy v2 version. The sunset date of our legacy v2 endpoints is expected in early January 2024. Tive will be providing reminders, but please make sure you give yourself enough time between now and then to make the switch over to v3 so you are still able to gain visibility and make sure your shipments arrive on time and in full.

What's New in this API Version?

Here are some of the highlights you can expect from our new API version:

  • Self-service authentication from the Tive application
  • Better platform parity. Some highlights include:
    • Shipments
      • Multi-leg shipment support
      • Shipment templates
      • Shipment collaboration
    • Alert Presets
      • No longer called Alert Profiles
      • Support to specify at origin, in transit, and/or at destination alerts
    • Carriers
      • Carrier and carrier contact information is more accessible and easier to use
      • Outlined how to use standardized carriers and their importance
    • Webhooks
      • Introduced ability to create and edit
    • Accounts
      • Edit account name
      • Change autocomplete delay
      • Enable/disable an account
      • Change device account
    • Geofences
      • Currently, creation or editing of geofences is not fully supported. Users can create simple radius geofences with our API, however, to create a simple radius or custom geofence Tive recommends using the Tive Platform.
  • Standard and consistent RESTful conventions

What Version Is Best For Me?

Tive is aware that many people are actively using our legacy API. We didn't want to introduce breaking changes so for the near future, you can use both v2 and v3 versions until early January 2024 when v2 will be sunset.

The benefit of using both API versions is that you can implement single endpoints at a time instead of needing to overhauling your entire integration as once.

Base URL

  • Legacy v2: https://api2.prod1.tive.co/api/v2/<endpoint>
  • v3: https://api.tive.com/public/v3/<endpoint>

Looking Forward

Tive highly encourages you to migrate to v3 of our public API if you are still using legacy v2 as we do have plans to deprecate v2. From new functionality to better documentation, there are numerous changes we believe will improve your integration experience.

Feedback

Have any feedback or questions? Please reach out to [email protected].

Updated 9 months ago