--- title: "Get shipment statuses by project44 id." method: GET path: "/api/v4/ocean/shipments/{id}/statuses" tags: ["Ocean: Tracking"] --- # Get shipment statuses by project44 id. `GET /api/v4/ocean/shipments/{id}/statuses` ## Request - Base URL: `https://na12.api.project44.com` - URL: `https://na12.api.project44.com/api/v4/ocean/shipments/{id}/statuses` - 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 - `id` string, uuid, required ## Query parameters - `includeCustomAttributes` boolean - `includeMapUrl` boolean - `includePositionData` boolean ## Response `200` OK - OceanTrackedShipmentConfirmation - `infoMessages` Message[]: System messages and messages from the capacity provider. - `diagnostic` string: Diagnostic information, often originating from the capacity provider. - `message` string: Message informational text. - `severity` 'ERROR' | 'WARNING' | 'INFO': The severity of this message. - `source` 'SYSTEM' | 'CAPACITY_PROVIDER': The originator of this message -- either project44 (the system) or the capacity provider. - `trackedShipment` OceanTrackedShipment - `attributes` OceanAttribute[]: 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. - `carrierSCACCode` string: The SCAC code identifying the carrier transporting the given container. This field is required. - `containerDetails` OceanTrackedContainer - `containerId` string: The ISO 6346 compliant number of this container. - `currency` 'USD' | 'CAD' | 'MXN' | 'EUR': The currency in which the demurrage value is represented. - `demurrage` number: The total reported demurrage charge. This field is set by project44 in the API response. - `lastFreeDay` string: The last day of free storage in which a container can be picked up without paying demurrage. This field is set by project44 in the API response. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T00:00:00+0000). - `equipmentIdentifier` OceanEquipmentIdentifier - `type` 'CONTAINER_ID': The type of the identifier. - `value` string: The value of the identifier. - `events` OceanEvent[]: A list of container events in chronological order, with possible references to the stop and vessel where they occurred. - `eventCode` 'TRACKING_STARTED' | 'TRACKING_STOPPED' | 'UNKNOWN' | 'GATE_IN_FULL' | 'GATE_IN_EMPTY' | 'GATE_OUT_EMPTY' | 'GATE_OUT' | 'LOADED' | 'EMBARKED' | 'BERTHING' | 'ARRIVED' | 'DISCHARGED' | 'DEPARTED_TERMINAL' | 'BECAME_AVAILABLE' | 'CUSTOMS_HOLD_INITIATED' | 'LINE_HOLD_INITIATED' | 'OTHER_HOLD_INITIATED' | 'CUSTOMS_HOLD_RELEASED' | 'LINE_HOLD_RELEASED' | 'OTHER_HOLD_RELEASED': The code describing this event. - `stopNumber` integer: The number of the stop from the stop array where this state occurred, if applicable. - `timeStamp` string: The date and time when this event occurred. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T18:55:47+0500). - `vesselNumber` integer: The number of the vessel from the vessel array where this state occurred, if applicable. - `mapUrl` string: Public link to view the shipment in the VOC. - `masterShipmentId` string, uuid: This id links 1 or more legs as part of the same overall shipment. For intermodal shipments, pass an existing masterShipmentId to link this ocean leg to the overall master shipment. Otherwise pass any valid new UUID to create a new shipment. If no masterShipmentId is passed on POST request a new UUID will be generated. This value will always be returned on all responses. - `oceanLegId` string, uuid: The project44-generated id for the ocean shipment. This id may be used in subsequent API calls to reference a shipment. - `positions` OceanPosition[]: A list of geoCoordinates and timestamps describing the container's location on the water, with reference to the vessel which carried it. - `geoCoordinates` 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. - `timeStamp` string: The date and time at which this position data was recorded. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T18:55:47+0500). - `vesselNumber` integer: The number of the vessel from the vessel array which was carrying the container at this position. - `shipmentId` string, uuid: DEPRECATED: The project44-generated id for tracking an intermodal shipment. This id may be used in subsequent API calls to reference a shipment. This field is deprecated, use masterShipmentId instead. - `shipmentIdentifiers` OceanShipmentIdentifier[]: A list of optional identifiers to associate with this shipment. - `type` 'BILL_OF_LADING' | 'BOOKING_NUMBER': The type of the identifier. - `value` string: The value of the identifier. - `states` OceanState[]: A list of container states in chronological order, with possible references to the stop and vessel where they occurred. - `endTime` string: The date and time when the container left this state. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T18:55:47+0500). - `startTime` string: The date and time when the container entered this state. This will be expressed in the ISO-8601 standard with zero timezone offset (UTC) (Format: yyyy-MM-dd'T'HH:mm:ssZ) (Example: 2019-04-16T18:55:47+0500). - `stateCode` 'AT_STOP' | 'IN_TRANSIT' | 'ON_WATER' | 'LINE_HOLD' | 'CUSTOMS_HOLD' | 'OTHER_HOLD' | 'AT_TERMINAL' | 'UNKNOWN': The code describing this state. - `stopNumber` integer: The number of the stop from the stop array where this state occurred, if applicable. - `vesselNumber` integer: The number of the vessel from the vessel array where this state occurred, if applicable. - `stops` OceanStop[]: The list of stops (origin port, destination port, or transhipment ports) in this shipment. - `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. - `arrivalTiming` Timing - `actual` TimingActual - `dateTime` string: The actual date and time of arrival or departure.(format: yyyy-MM-dd'T'HH:mm:ssZ) - `timelinessCode` 'UNKNOWN' | 'EARLY' | 'ON_TIME' | 'LATE': The actual arrival or departure status, as calculated. - `estimate` TimingEstimate - `estimatedTimeWindow` OffsetDateTimeWindow: A date and time range, with time zone offset. - `endDateTime` string: End time of this window with timezone offset. (format: yyyy-MM-dd'T'HH:mm:ssZ) - `startDateTime` string: Start time of this window with timezone offset. (format: yyyy-MM-dd'T'HH:mm:ssZ) - `lastCalculatedDateTime` string: When this estimate was last computed. (format: yyyy-MM-dd'T'HH:mm:ssZ) - `timelinessCode` 'UNKNOWN' | 'EARLY' | 'ON_TIME' | 'LATE': The estimated arrival or departure status. - `scheduled` TimingScheduled - `dateTime` string: The scheduled date and time of arrival or departure.(format: yyyy-MM-dd'T'HH:mm:ssZ) - `timelinessCode` 'UNKNOWN' | 'EARLY' | 'ON_TIME' | 'LATE': The scheduled arrival or departure status, as calculated. - `departureTiming` Timing - `actual` TimingActual - `dateTime` string: The actual date and time of arrival or departure.(format: yyyy-MM-dd'T'HH:mm:ssZ) - `timelinessCode` 'UNKNOWN' | 'EARLY' | 'ON_TIME' | 'LATE': The actual arrival or departure status, as calculated. - `estimate` TimingEstimate - `estimatedTimeWindow` OffsetDateTimeWindow: A date and time range, with time zone offset. - `endDateTime` string: End time of this window with timezone offset. (format: yyyy-MM-dd'T'HH:mm:ssZ) - `startDateTime` string: Start time of this window with timezone offset. (format: yyyy-MM-dd'T'HH:mm:ssZ) - `lastCalculatedDateTime` string: When this estimate was last computed. (format: yyyy-MM-dd'T'HH:mm:ssZ) - `timelinessCode` 'UNKNOWN' | 'EARLY' | 'ON_TIME' | 'LATE': The estimated arrival or departure status. - `scheduled` TimingScheduled - `dateTime` string: The scheduled date and time of arrival or departure.(format: yyyy-MM-dd'T'HH:mm:ssZ) - `timelinessCode` 'UNKNOWN' | 'EARLY' | 'ON_TIME' | 'LATE': The scheduled arrival or departure status, as calculated. - `geoCoordinates` 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 this stop. - `name` string: The name of this port. - `portCBPCode` string: The Customs and Border Protection code of this port. - `portLocode` string: The UN/LOCODE of this port. 2 char country code + 3 char location code. - `stopNumber` integer: The project44-assigned number for this stop. The stop is referenced by this number in the lists of events and states. - `stopType` 'PLACE_OF_ORIGIN' | 'PORT_OF_ORIGIN' | 'PORT_OF_LOADING' | 'TRANSSHIPMENT_PORT' | 'PORT_OF_DISCHARGE' | 'DESTINATION': The type of the stop. - `vessels` OceanVessel[]: A list of vessels being tracked within this shipment. - `callSign` string: The alphanumeric value that uniquely identifies the vessel being tracked. This field is set by project44 in the API response. - `draught` number: The draught of the vessel being tracked. This determines the minimum depth of water the vessel can safely navigate. This field is set by project44 in the API response. - `imo` integer: The IMO (International Maritime Organization) number representing the vessel being tracked. - `length` number: The length of the vessel being tracked. This field is set by project44 in the API response. - `lengthUnit` 'IN' | 'CM' | 'FT' | 'M': The unit of measure for length, width, and draught. - `mmsi` integer: The MMSI (Maritime Mobile Service Identity) value that uniquely identifies the vessel being tracked. This field is set by project44 in the API response. - `name` string: The name of the vessel being tracked. This field is set by project44 in the API response. - `shipType` string: The type of the vessel being tracked. This field is set by project44 in the API response. - `vesselNumber` integer: The project44-assigned number for this vessel. The vessel is referenced by this number in the lists of events, states and positions. - `width` number: The width of the vessel being tracked. This field is set by project44 in the API response. ## Other responses - `400`: Invalid request - `401`: Invalid or missing credentials - `403`: User not authorized to perform this operation --- [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)