Sign in

v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Shipments

Manage a Shipment Share Link

Creates, updates, or toggles a shareable link for a shipment.

Behaviors based on parameters provided:

  • enabled + accessLevel — upserts the link for that access level with the given enabled state.
  • enabled=true only — enables all existing links created by the calling user.
  • enabled=false only — disables all shared links on the shipment, including links created by other users.

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
patch/public/v3/Shipments/{shipmentId}/share-links

Path parameters

shipmentIdstring required

shipmentId of the shipment.

Query parameters

enabledboolean required

Set to true to enable or false to disable the shared link.

accessLevel'LocationOnly' | 'ConditionOnly' | 'LocationAndCondition'

The access level of the shared link. Valid values are LocationOnly, ConditionOnly, LocationAndCondition.

The access level for the shared link. Values: LocationOnly, ConditionOnly, LocationAndCondition.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Response

The shipment share link settings including the enabled state, access level, and shareable link.

enabledboolean

Whether this share link is enabled. Each access level has its own share link with an independent enabled state.

accessLevel'LocationOnly' | 'ConditionOnly' | 'LocationAndCondition'

The access level of the shared link. Valid values are LocationOnly, ConditionOnly, LocationAndCondition.

sharedLinkstring nullable

The shareable link for this shipment.