v1
latestOpenAPI 3.0.12026-07-2487135176.5 KBShipments
Get Shipment Share Links
Retrieves existing shareable links for a shipment.
When accessLevel is provided, returns only the link for that access level (0 or 1 results). When omitted, returns all links for the shipment across all access levels.
accessLevel values:
- LocationOnly — viewers can see shipment location only
- ConditionOnly — viewers can see sensor/condition data only
- LocationAndCondition — viewers can see both location and sensor data
get/public/v3/Shipments/{shipmentId}/share-links
Path parameters
shipmentIdstring required
shipmentId of the shipment.
Query parameters
accessLevel'LocationOnly' | 'ConditionOnly' | 'LocationAndCondition'
The access level of the shared link. Valid values are LocationOnly, ConditionOnly, LocationAndCondition.
Optional. Filter by access level. Values: LocationOnly, ConditionOnly, LocationAndCondition. If omitted, all links are returned.
Headers
x-tive-account-idinteger required
ID of the account the request will be made in.
Response
A list of shipment share link settings. Each entry includes the enabled state, access level, and shareable link.