Shipments

Get shipment tracking history

This endpoint provides detailed tracking history for a given shipmentId.

get/v2.0/shipments/{shipmentId}/tracking

Request

  • Base URL: https://api.freightview.dev
  • URL: https://api.freightview.dev/v2.0/shipments/{shipmentId}/tracking
  • Auth: OAuth 2 (client credentials, token URL /v2.0/auth/token)

Path parameters

shipmentIdstring required

The unique identifier in Freightview for the shipment.

Query parameters

itemIdstring

The identifier of the item in Freightview you wish to track. Required if an index is specified.

itemIndexstring

The zero-based index for a given itemId in Freightview you wish to track. For example, if you want to track the second entity of an item with a quantity of 2 in the group of items, specify the number 1.

Response

Success

createdDatestring date-time

The full timestamp of when the event was entered into the Freightview system.

eventDatestring date

The date at which the event occurred.

eventTimestring time

The time (in 24-hr format) the event ocurred in the current location timezone.

eventType'origin-arrived' | 'picked-up' | 'in-transit' | 'terminal-arrived' | 'terminal-departed' | 'terminal-unloaded' | 'terminal-loaded' | 'terminal-other' | 'out-for-delivery' | 'destination-arrived' | 'destination-unloaded' | 'delivered' | 'cartage-handoff' | 'interline-handoff' | 'other' | 'exception' | 'information' | 'update' | 'stop-completed' | 'stop-incomplete'

The type of event. Defaults to update if more specific eventType is not available.

summarystring

The carrier's event description.

exceptionCode'awaiting-customs-clearance' | 'canceled' | 'consolidation-hold' | 'damaged' | 'delayed' | 'delivery-appointment-needed' | 'delivery-re-attempt-tomorrow' | 'delivery-unsuccessful' | 'freight-refused' | 'freight-refused-damaged' | 'freight-refused-short' | 'freight-unavailable' | 'lost' | 'no-receiving-personnel' | 'on-hand' | 'other' | 'overage' | 'reconsigned' | 'returned-to-dock' | 'returned-to-shipper' | 'service-exemption' | 'short' | 'special-equipment-required' | 'terminal-pickup' | 'unable-to-locate-consignee' | 'weight-correction'

The exception code associated with an exception tracking event.

exceptionDescriptionstring

The exception message or details provided by the carrier.

Changes

No recorded changes to this operation across all 1 revision of this API.