Tive API endpoints all use HTTP request methods. Detailed information regarding the endpoints can be found in the API Guides, but common operations include:

• POST: Creates new objects.
• GET: Retrieves a single object or a list of objects.
• PUT: Updates an object. Note, PUT requests replace the data of an object with new data that you provide. This is typically done with the same structure as a POST request, but the object will retain its original ID.
• PATCH: Updates an object. PATCH requests differ from PUT requests as they only partially update an existing object based on the field(s) provided within the request.
• DELETE: Deletes an object.

Base URL

All endpoints can be accessed via the URL format below:

https://api.tive.com/public/v3/{endpoint}

Best Practices

When building your requests and parsing responses bear in mind:

• Treat Omitted Fields as Null: At times our data models may include many fields which are not applicable for a data scenario. To keep payloads small and manageable we may omit properties with "null" values, consumers should treat these omitted values the same as a "null" value. Most programming languages have serialization options to handle this.
• Ignore Unknown Fields: As we improve our APIs we may add additional fields to responses. When deserializing responses consumers should ignore unknown fields to ensure that the addition of new fields does not cause issues for them.

API Resources

Accounts

Accounts are primarily used for differentiating branches or clients of your Organization. Users within accounts will only be able to view information within the account(s) assigned to them by the organization admin.

Alert Presets

Location and condition alerts for Shipments are configured with Alert Presets. To receive alerts regarding your shipment, create an alert preset and add it to a shipment.

Carriers

If you have a repeat transport provider, adding them as a carrier in the Tive ecosystem can be helpful. By associating carriers to shipments you can gain insights into their performance and efficiency over time.

Collaborators

Users can share real-time shipment location and condition data with any user they chose, in or outside of their organization. This also includes sharing shipments with people who don’t already have a Tive account. Custom shipment user roles unlock granular control of your real-time shipment visibility data with users to enable secure, efficient collaboration so that shipments arrive on time and in full.

Devices

Devices or "Trackers" are the main method for data collection within the Tive Platform. The data collected will provide clarity into geographic location and environmental conditions such as:

• Location
• Temperature
• Shock
• Light
• Humidity
• Connectivity
• Battery

Locations

Locations are a great way to save commonly used locations for your shipments. Once a location is created, you no longer have to manually enter the address when creating new shipments, routes, or geofences when creating a shipment via the Tive platform.

Shipments

Tive provides the ability to create and track shipments. The shipment endpoints will allow you to easily sync with your existing applications. Additionally, you can also use the API and webhooks to track active shipment sensor information, view alerts, or share a live view to your customers.

Shipment Templates

Shipment Templates are a core part of the Tive Shipment workflow that make it easier to create shipments for commonly used shipping lanes. Templates can provide a standardized way to specify shipping details and alert preset(s) that are used across many shipments.

Users

The Tive Platform includes two main types of users: Internal users (which can be regular or Admin users), and External users.

Internal Users

Only Admin users can view all existing users, add new users, and configure Admin privileges for other users. Regular internal users cannot view the "Organization" menu in the platform where organizational configuration is controlled.

Aside from the admin privileges, users can configure their own trackers, create and start shipments and access data within the accounts they belong to.

External Users

External users are users who are not members of your team, such as a partner, customer, or receiver. External users cannot interact with the Platform at all, instead, they can be configured to receive email alert notifications. These alerts must be configured by an internal user. Currently, endpoints involving external users are not supported on the public API. As an alternative, Tive recommends utilizing our shipment collaboration functionality.

Note, all users must be invited from within the Tive Platform.

Webhooks

To learn more about Tive webhook offerings, please see our documentation here.