--- title: "Fetch the position history for a shipment." method: GET path: "/api/v4/shipments/{shipmentId}/positionhistory" tags: ["Shipment: Tracking"] --- # Fetch the position history for a shipment. `GET /api/v4/shipments/{shipmentId}/positionhistory` ## Request - Base URL: `https://na12.api.project44.com` - URL: `https://na12.api.project44.com/api/v4/shipments/{shipmentId}/positionhistory` - Auth: OAuth 2 - Client credentials - Token URL: `/api/v4/oauth2/token` - TypeScript: (a function with typed inputs; its response is checked against the schema)

Required Fields

## Path parameters - `shipmentId` string, uuid, required ## Query parameters - `includeRouteInfo` boolean ## Response `200` OK - ShipmentPositionHistory: The history of where this shipment or parts of this shipment were located during tracking. - `positions` TrackedShipmentPosition[]: Locations where this shipment has been recorded. Data may be down-sampled. Will always be in ascending order by the date that the shipment was at that position. - `dateTime` string, date-time: The timestamp denoting when the shipment was detected at the given coordinates. - `latitude` number, float: The geographic latitude, using the WGS84 coordinate system. - `longitude` number, float: The geographic longitude, using the WGS84 coordinate system. - `receivedDateTime` string, date-time: The date and time that project44 received this position data. - `routeSegmentId` string, uuid: The route segment on which the shipment was traveling when it was at this position. - `shipment` TrackedShipment: Shipment tracking model used to initiate a shipment. - `attributes` CustomAttribute[]: An optional user-defined set of custom attributes to associate with this shipment. - `name` string: The key (name) for the custom attribute. Must be unique. - `value` string - `values` string[]: The values for the custom attribute. - `accessGroups` AccessGroup[]: This set is populated when a shipment is entitled to specific access groups, it denotes which group(s) are entitled visibility. - `id` string, uuid: The unique identifier of the access group - `createdDateTime` string, date-time: The date and time when this shipment was created. This value is read only and will be ignored during shipment creation. - `id` string, uuid: Master shipment id of the shipment. Will always be populated on the response. - `identifiers` LogisticsIdentifier[]: Used to identify a shipment.

Only the following identifier types are accepted when creating or updating a shipment: - `type` 'AIR_WAYBILL' | 'BILL_OF_LADING' | 'HOUSE_BILL_OF_LADING' | 'BOOKING_NUMBER' | 'CARRIER_IATA' | 'CARRIER_ICAO' | 'CARRIER_NAME' | 'CARRIER_SCAC' | 'FFW_SCAC' | 'NVOCC_SCAC' | 'NVOCC_NAME' | 'FFW_NAME' | 'FFW_MASTER_ID' | 'NVOCC_MASTER_ID' | 'CONTAINER_ID' | 'CUSTOMER_REFERENCE' | 'DELIVERY_NUMBER' | 'EXTERNAL' | 'FLIGHT_NUMBER' | 'ORDER' | 'PICKUP' | 'PRO' | 'PURCHASE_ORDER' | 'RAIL_CAR_ID' | 'RAIL_WAYBILL' | 'TRACKING_NUMBER' | 'TRAILER_ID' | 'UNKNOWN' | 'VESSEL_IMO' | 'VESSEL_NAME' | 'WAYBILL' | 'VESSEL_CALL_SIGN' | 'VESSEL_MMSI' | 'CARRIER_US_DOT_NUMBER' | 'CARRIER_MC_NUMBER' | 'SUBSCRIPTION_ID' | 'HOUSE_AIR_WAYBILL' | 'SALES_ORDER' | 'WAREHOUSE_MOVEMENT_ORDER' | 'ADVANCED_SHIPMENT_NOTICE' | 'DRIVER_MOBILE_PHONE_NUMBER' | 'VEHICLE_ID' | 'LICENSE_PLATE' | 'TRAILER_LICENSE_PLATE' | 'SENSITECH_DEVICE_ID' | 'EMERSON_DEVICE_ID' | 'TIVE_DEVICE_ID' | 'ZILLION_DEVICE_ID' | 'VOYAGE_NUMBER' | 'CARRIER_MASTER_ID' | 'CARRIER_NMC_ID' | 'CONTAINER_TYPE' | 'TRAIN_NUMBER' | 'WAGON_ID' | 'TRAIN_ID' | 'CAPACITY_PROVIDER_ACCOUNT_GROUP' | 'CAPACITY_PROVIDER_ACCOUNT_CODE' | 'SERIAL_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER' | 'REFERENCE_NUMBER' | 'CONTAINER_PIN' | 'VESSEL_P44_ID' | 'EXPORT_CUSTOMS_BROKER' | 'IMPORT_CUSTOMS_BROKER' | 'POL_QUALITY_CONTROL_PROVIDER' | 'POD_QUALITY_CONTROL_PROVIDER' | 'AIRCRAFT_ICAO' | 'AIRLINE_NAME' | 'SEAL_NUMBER' | 'DRAYAGE_CARRIER_SCAC' | 'EXPORT_DRAYAGE_CARRIER_SCAC' | 'IMPORT_DRAYAGE_CARRIER_SCAC' | 'INBOUND_VOYAGE_NUMBER': The standard which defines who assigns the identifier and what it identifies. Required field. - `value` string: The value of this identifier. Required field. - `lastModifiedDateTime` string, date-time: The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification. - `plan` ShipmentPlan: ${ShipmentPlan.apiModel.class.value} - `expectedTransportationModes` string[]: ${ShipmentPlan.apiModel.expectedTransportationModes.value} - `exclusions` Exclusion[]: ${ShipmentPlan.apiModel.exclusions.value} - `vesselTracking` VesselTrackingConfig: Configuration for vessel tracking on a shipment. - `enabled` boolean: Indicates whether vessel tracking is enabled for this shipment. - `plannedVesselRouteSegments` PlannedVesselRouteSegment[]: Planned vessel route segments with identifiers for this shipment. This is used to determine whether the shipment is on a planned route. - `fromStopId` string, uuid - `toStopId` string, uuid - `transportationMode` 'AIR' | 'OCEAN' | 'RAIL' | 'UNKNOWN' | 'TRUCKLOAD' | 'PARCEL' | 'LTL' | 'BARGE' - `vesselName` string - `vesselImo` string - `vesselMmsi` string - `routeInfo` ShipmentRouteInfo: Route info model that contains the stops and route for the shipment. - `routeSegments` TrackedShipmentRouteSegment[]: Contain information about how the shipment moved from each stop to the next. There will always be 1 fewer route segment than number of stops. - `emissions` EmissionData: Describes emission data. - `cargoWeight` WeightMeasurement: A measure of weight with a value and unit - `unit` 'LB' | 'KG', enum: Weight measurement units (default: 'LB'). - `value` number: Numeric value of a measurement - `co2EmissionIntensity` WeightPerDistanceMeasurement: A measure of weight per distance with a value and unit - `unit` 'KG_PER_KM', enum: Weight per distance measurement units (linear density) - `value` number: Numeric value of a measurement - `distance` DistanceMeasurement: A measure of distance with a value and unit - `unit` 'FT' | 'M' | 'MI' | 'KM', enum: Physical unit of measurement - `value` number: Numeric value of a measurement - `loadFactor` number, float: Ratio of weight or volume of cargo in the shipment to the vehicle's capacity. - `totalCO2Emissions` WeightMeasurement: A measure of weight with a value and unit - `unit` 'LB' | 'KG', enum: Weight measurement units (default: 'LB'). - `value` number: Numeric value of a measurement - `vehicleInfo` VehicleInfo: Describes vehicle information used to compute emissions. - `type` VehicleType - … - `weight` WeightMeasurement: A measure of weight with a value and unit - … - `fromStopId` string, uuid: The starting stop of this route segment. Will always be populated on response. - `id` string, uuid: The id of this route segment. Will always be populated on response. - `identifiers` LogisticsIdentifier[]: Identifiers that are not part of the overall shipment but are relevant to this route segment. - `type` 'AIR_WAYBILL' | 'BILL_OF_LADING' | 'HOUSE_BILL_OF_LADING' | 'BOOKING_NUMBER' | 'CARRIER_IATA' | 'CARRIER_ICAO' | 'CARRIER_NAME' | 'CARRIER_SCAC' | 'FFW_SCAC' | 'NVOCC_SCAC' | 'NVOCC_NAME' | 'FFW_NAME' | 'FFW_MASTER_ID' | 'NVOCC_MASTER_ID' | 'CONTAINER_ID' | 'CUSTOMER_REFERENCE' | 'DELIVERY_NUMBER' | 'EXTERNAL' | 'FLIGHT_NUMBER' | 'ORDER' | 'PICKUP' | 'PRO' | 'PURCHASE_ORDER' | 'RAIL_CAR_ID' | 'RAIL_WAYBILL' | 'TRACKING_NUMBER' | 'TRAILER_ID' | 'UNKNOWN' | 'VESSEL_IMO' | 'VESSEL_NAME' | 'WAYBILL' | 'VESSEL_CALL_SIGN' | 'VESSEL_MMSI' | 'CARRIER_US_DOT_NUMBER' | 'CARRIER_MC_NUMBER' | 'SUBSCRIPTION_ID' | 'HOUSE_AIR_WAYBILL' | 'SALES_ORDER' | 'WAREHOUSE_MOVEMENT_ORDER' | 'ADVANCED_SHIPMENT_NOTICE' | 'DRIVER_MOBILE_PHONE_NUMBER' | 'VEHICLE_ID' | 'LICENSE_PLATE' | 'TRAILER_LICENSE_PLATE' | 'SENSITECH_DEVICE_ID' | 'EMERSON_DEVICE_ID' | 'TIVE_DEVICE_ID' | 'ZILLION_DEVICE_ID' | 'VOYAGE_NUMBER' | 'CARRIER_MASTER_ID' | 'CARRIER_NMC_ID' | 'CONTAINER_TYPE' | 'TRAIN_NUMBER' | 'WAGON_ID' | 'TRAIN_ID' | 'CAPACITY_PROVIDER_ACCOUNT_GROUP' | 'CAPACITY_PROVIDER_ACCOUNT_CODE' | 'SERIAL_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER' | 'REFERENCE_NUMBER' | 'CONTAINER_PIN' | 'VESSEL_P44_ID' | 'EXPORT_CUSTOMS_BROKER' | 'IMPORT_CUSTOMS_BROKER' | 'POL_QUALITY_CONTROL_PROVIDER' | 'POD_QUALITY_CONTROL_PROVIDER' | 'AIRCRAFT_ICAO' | 'AIRLINE_NAME' | 'SEAL_NUMBER' | 'DRAYAGE_CARRIER_SCAC' | 'EXPORT_DRAYAGE_CARRIER_SCAC' | 'IMPORT_DRAYAGE_CARRIER_SCAC' | 'INBOUND_VOYAGE_NUMBER': The standard which defines who assigns the identifier and what it identifies. Required field. - `value` string: The value of this identifier. Required field. - `toStopId` string, uuid: The ending stop of this route segment. Will always be populated on response. - `transportationMode` 'AIR' | 'OCEAN' | 'RAIL' | 'UNKNOWN' | 'TRUCKLOAD' | 'PARCEL' | 'LTL' | 'BARGE': The mode of transportation on which the shipment was traveling. Will always be populated on response. - `stops` TrackedShipmentStop[]: All stops associated with this shipment. There may be 0 stops while we are still acquiring data for this shipment. - `id` string, uuid: The id of this stop. Will always be populated on response. - `location` TrackedShipmentStopLocation: The location of the stop. - `address` Address: A postal address. - `addressLines` string[]: Street name, number, direction, PO box, etc. Only three address lines are currently permitted. - `city` string: Name of city, town, etc. - `country` 'US' | 'CA' | 'MX' | 'AG' | 'BB' | 'BS' | 'BZ' | 'CR' | 'CU' | 'DM' | 'DO' | 'GD' | 'GT' | 'HN' | 'HT' | 'JM' | 'KN' | 'LC' | 'NI' | 'PA' | 'SV' | 'TT' | 'VC' | 'AI' | 'AW' | 'BL' | 'BM' | 'BQ' | 'CW' | 'GL' | 'GP' | 'KY' | 'MF' | 'MQ' | 'MS' | 'PM' | 'PR' | 'SX' | 'TC' | 'UM' | 'VG' | 'VI' | 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'DE' | 'EE' | 'ES' | 'FI' | 'FR' | 'GB' | 'GR' | 'HR' | 'HU' | 'IE' | 'IT' | 'LT' | 'LU' | 'LV' | 'MT' | 'NL' | 'PL' | 'PT' | 'RO' | 'SE' | 'SK' | 'SI' | 'CH' | 'IS' | 'LI' | 'NO' | 'AL' | 'ME' | 'MK' | 'RS' | 'TR' | 'AD' | 'AX' | 'BA' | 'BV' | 'BY' | 'FO' | 'GG' | 'GI' | 'IM' | 'IO' | 'JE' | 'MC' | 'MD' | 'SJ' | 'SM' | 'TF' | 'UA' | 'VA' | 'AE' | 'AF' | 'AM' | 'AZ' | 'BD' | 'BH' | 'BN' | 'BT' | 'CN' | 'GE' | 'HK' | 'ID' | 'IL' | 'IN' | 'IQ' | 'IR' | 'JO' | 'JP' | 'KG' | 'KH' | 'KP' | 'KR' | 'KW' | 'KZ' | 'LA' | 'LB' | 'LK' | 'MM' | 'MN' | 'MO' | 'MV' | 'MY' | 'NP' | 'OM' | 'PH' | 'PK' | 'PS' | 'QA' | 'RU' | 'SA' | 'SG' | 'SY' | 'TH' | 'TJ' | 'TL' | 'TM' | 'TW' | 'UZ' | 'VN' | 'YE' | 'AO' | 'BF' | 'BI' | 'BJ' | 'BW' | 'CD' | 'CF' | 'CG' | 'CI' | 'CM' | 'CV' | 'DJ' | 'DZ' | 'EG' | 'EH' | 'ER' | 'ET' | 'GA' | 'GH' | 'GM' | 'GN' | 'GQ' | 'GW' | 'HM' | 'KE' | 'KM' | 'LR' | 'LS' | 'LY' | 'MA' | 'MG' | 'ML' | 'MR' | 'MU' | 'MW' | 'MZ' | 'NA' | 'NE' | 'NG' | 'RE' | 'RW' | 'SC' | 'SD' | 'SH' | 'SL' | 'SN' | 'SO' | 'SS' | 'ST' | 'SZ' | 'TD' | 'TG' | 'TN' | 'TZ' | 'UG' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'EC' | 'FK' | 'GF' | 'GS' | 'GY' | 'PE' | 'PY' | 'SR' | 'UY' | 'VE' | 'AS' | 'AU' | 'CC' | 'CK' | 'CX' | 'FJ' | 'FM' | 'GU' | 'KI' | 'MH' | 'MP' | 'NC' | 'NF' | 'NR' | 'NU' | 'NZ' | 'PF' | 'PG' | 'PN' | 'PW' | 'SB' | 'TK' | 'TO' | 'TV' | 'VU' | 'WF' | 'WS' | 'AQ' | 'EL' | 'UK' | 'XK' | 'XS' | 'XI', enum: Abbreviation of country (using ISO 3166 standards). (default: 'US') - `postalCode` string: The ZIP or postal code. - `state` string: Abbreviation of state, province, district, etc. - `coordinates` GeoCoordinates - `latitude` number, float: The approximate geographic latitude of a location, using the WGS84 coordinate system. - `longitude` number, float: The approximate geographic longitude of a location, using the WGS84 coordinate system. - `id` string, uuid: The id of the location. - `identifiers` TrackedShipmentStopLocationIdentifier[]: List of standard identifiers associated with this location. - `type` 'AIRPORT_IATA' | 'AIRPORT_ICAO' | 'EXTERNAL' | 'LOCODE' | 'NAME' | 'PORT_UN_LOCODE' | 'FACILITY_ID' | 'RAIL_SPLC' | 'RAIL_UIC' | 'RAIL_EU_PLC' | 'UNKNOWN': The type of identifier and authority who assigns these identifiers. - `value` string: The value of the identifier. - `masterLocationId` string, uuid: The master location id of the location. - `name` string: The name of the location. - `timeZone` string: TZ database identifier of the time zone at the stop (https://www.iana.org/time-zones) - `type` 'UNKNOWN' | 'ORIGIN' | 'DESTINATION' | 'TRANSFER' | 'OTHER' | 'PORT_OF_LOADING' | 'TRANSSHIPMENT_PORT' | 'PORT_OF_DISCHARGE' | 'PICKUP' | 'DELIVERY' | 'RETURN' | 'WAREHOUSE' | 'HUB' | 'AIRPORT' | 'ORIGIN_CFS' | 'DESTINATION_CFS': The type of stop. - `relatedShipments` SimpleTrackedShipment[]: List of related shipments of the parent shipment. This is optional. - `attributes` CustomAttribute[]: An optional user-defined set of custom attributes to associate with this shipment. - `name` string: The key (name) for the custom attribute. Must be unique. - `value` string - `values` string[]: The values for the custom attribute. - `accessGroups` AccessGroup[]: This set is populated when a shipment is entitled to specific access groups, it denotes which group(s) are entitled visibility. - `id` string, uuid: The unique identifier of the access group - `createdDateTime` string, date-time: The date and time when this shipment was created. This value is read only and will be ignored during shipment creation. - `id` string, uuid: Master shipment id of the shipment. Will always be populated on the response. - `identifiers` LogisticsIdentifier[]: Used to identify a shipment.

Only the following identifier types are accepted when creating or updating a shipment: - `type` 'AIR_WAYBILL' | 'BILL_OF_LADING' | 'HOUSE_BILL_OF_LADING' | 'BOOKING_NUMBER' | 'CARRIER_IATA' | 'CARRIER_ICAO' | 'CARRIER_NAME' | 'CARRIER_SCAC' | 'FFW_SCAC' | 'NVOCC_SCAC' | 'NVOCC_NAME' | 'FFW_NAME' | 'FFW_MASTER_ID' | 'NVOCC_MASTER_ID' | 'CONTAINER_ID' | 'CUSTOMER_REFERENCE' | 'DELIVERY_NUMBER' | 'EXTERNAL' | 'FLIGHT_NUMBER' | 'ORDER' | 'PICKUP' | 'PRO' | 'PURCHASE_ORDER' | 'RAIL_CAR_ID' | 'RAIL_WAYBILL' | 'TRACKING_NUMBER' | 'TRAILER_ID' | 'UNKNOWN' | 'VESSEL_IMO' | 'VESSEL_NAME' | 'WAYBILL' | 'VESSEL_CALL_SIGN' | 'VESSEL_MMSI' | 'CARRIER_US_DOT_NUMBER' | 'CARRIER_MC_NUMBER' | 'SUBSCRIPTION_ID' | 'HOUSE_AIR_WAYBILL' | 'SALES_ORDER' | 'WAREHOUSE_MOVEMENT_ORDER' | 'ADVANCED_SHIPMENT_NOTICE' | 'DRIVER_MOBILE_PHONE_NUMBER' | 'VEHICLE_ID' | 'LICENSE_PLATE' | 'TRAILER_LICENSE_PLATE' | 'SENSITECH_DEVICE_ID' | 'EMERSON_DEVICE_ID' | 'TIVE_DEVICE_ID' | 'ZILLION_DEVICE_ID' | 'VOYAGE_NUMBER' | 'CARRIER_MASTER_ID' | 'CARRIER_NMC_ID' | 'CONTAINER_TYPE' | 'TRAIN_NUMBER' | 'WAGON_ID' | 'TRAIN_ID' | 'CAPACITY_PROVIDER_ACCOUNT_GROUP' | 'CAPACITY_PROVIDER_ACCOUNT_CODE' | 'SERIAL_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER' | 'REFERENCE_NUMBER' | 'CONTAINER_PIN' | 'VESSEL_P44_ID' | 'EXPORT_CUSTOMS_BROKER' | 'IMPORT_CUSTOMS_BROKER' | 'POL_QUALITY_CONTROL_PROVIDER' | 'POD_QUALITY_CONTROL_PROVIDER' | 'AIRCRAFT_ICAO' | 'AIRLINE_NAME' | 'SEAL_NUMBER' | 'DRAYAGE_CARRIER_SCAC' | 'EXPORT_DRAYAGE_CARRIER_SCAC' | 'IMPORT_DRAYAGE_CARRIER_SCAC' | 'INBOUND_VOYAGE_NUMBER': The standard which defines who assigns the identifier and what it identifies. Required field. - `value` string: The value of this identifier. Required field. - `lastModifiedDateTime` string, date-time: The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification. - `plan` ShipmentPlan: ${ShipmentPlan.apiModel.class.value} - `expectedTransportationModes` string[]: ${ShipmentPlan.apiModel.expectedTransportationModes.value} - `exclusions` Exclusion[]: ${ShipmentPlan.apiModel.exclusions.value} - `vesselTracking` VesselTrackingConfig: Configuration for vessel tracking on a shipment. - `enabled` boolean: Indicates whether vessel tracking is enabled for this shipment. - `plannedVesselRouteSegments` PlannedVesselRouteSegment[]: Planned vessel route segments with identifiers for this shipment. This is used to determine whether the shipment is on a planned route. - `fromStopId` string, uuid - `toStopId` string, uuid - `transportationMode` 'AIR' | 'OCEAN' | 'RAIL' | 'UNKNOWN' | 'TRUCKLOAD' | 'PARCEL' | 'LTL' | 'BARGE' - `vesselName` string - `vesselImo` string - `vesselMmsi` string - `shipmentShareLink` string: Public link to view the shipment in the VOC. - `shipmentShareLink` string: Public link to view the shipment in the VOC. ## Other responses - `400`: Missing or invalid user context headers. - `404`: Not Found --- [API](https://skmtc.dev/project44/apis/project44-rest-api.md) - [All operations](https://skmtc.dev/project44/apis/project44-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/project44/apis/project44-rest-api/revisions/cdf9675e2294?raw)