---
title: "Fetch the shipment information including the stops and route segments."
method: GET
path: "/api/v4/shipments/{shipmentId}/tracking"
tags: ["Shipment: Tracking"]
---

# Fetch the shipment information including the stops and route segments.

`GET /api/v4/shipments/{shipmentId}/tracking`

## Request

- Base URL: `https://na12.api.project44.com`
- URL: `https://na12.api.project44.com/api/v4/shipments/{shipmentId}/tracking`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/v4/oauth2/token`
- TypeScript: <https://skmtc.dev/project44/apis/project44-rest-api/docs/api/v4/shipments/:shipmentId/tracking/get.ts> (a function with typed inputs; its response is checked against the schema)

<h4><b>Required Fields</h4></b>
<ul><li> shipmentId </li></ul>

## Path parameters

- `shipmentId` string, uuid, required

## Response `200`

OK

- 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.</br></br>Only the following identifier types are accepted when creating or updating a shipment:<ul><li>Air</li><ul><li>AIR_WAYBILL</li><li>HOUSE_AIR_WAYBILL</li></ul><li>European Rail</li><ul><li>WAGON_ID</li><li>TRAIN_NUMBER</li></ul><li>North American Rail</li><ul><li>CONTAINER_ID</li><li>TRAILER_ID</li><li>RAIL_CAR_ID</li><li>BILL_OF_LADING</li><li>WAYBILL</li></ul><li>Ocean</li><ul><li>BILL_OF_LADING</li><li>BOOKING_NUMBER</li><li>CARRIER_SCAC</li><li>CONTAINER_ID</li></ul><li>Parcel</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>TRACKING_NUMBER</li><li>CARRIER_SCAC</li><li>REFERENCE_NUMBER</li></ul><li>LTL</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>PRO</li><li>BILL_OF_LADING</li><li>PICKUP</li><li>PURCHASE_ORDER</li></ul><li>Ocean Door-to-Door</li><ul><li>HOUSE_BILL_OF_LADING</li><li>FFW_SCAC</li><li>BOOKING_NUMBER</li><li>TRACKING_NUMBER</li></ul></ul>
    - `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
            - `enumValue` 'UNKNOWN' | 'AIR_FREIGHTER' | 'AIR_BELLY_FREIGHT' | 'AIR_UNKNOWN' | 'INLAND_WATERWAY_MOTOR_VESSEL_LT_650T' | 'INLAND_WATERWAY_MOTOR_VESSEL_650T_TO_1000T' | 'INLAND_WATERWAY_MOTOR_VESSEL_1000T_TO_2000T' | 'INLAND_WATERWAY_MOTOR_VESSEL_2000T_TO_3000T' | 'INLAND_WATERWAY_COUPLED_CONVOY' | 'INLAND_WATERWAY_PUSHED_CONVOY_2_TO_3_BARGES' | 'INLAND_WATERWAY_PUSHED_CONVOY_4_TO_5_BARGES' | 'INLAND_WATERWAY_PUSHED_CONVOY_6_BARGES' | 'INLAND_WATERWAY_TANKER_VESSELS' | 'INLAND_WATERWAY_CONTAINER_VESSELS_110M' | 'INLAND_WATERWAY_CONTAINER_VESSELS_135M' | 'INLAND_WATERWAY_CONTAINER_VESSELS_COUPLED_CONVOY' | 'RAIL_AVERAGE_MIXED' | 'RAIL_CONTAINER' | 'RAIL_CARS' | 'RAIL_CHEMICALS' | 'RAIL_COAL_STEEL' | 'RAIL_BUILDING_MATERIALS' | 'RAIL_MANUFACTURED_PRODUCTS' | 'RAIL_CEREALS' | 'RAIL_TRUCK_AND_TRAILER' | 'RAIL_TRAILER_ONLY' | 'ROAD_NA_VAN' | 'ROAD_NA_GENERAL' | 'ROAD_NA_AUTO_CARRIER' | 'ROAD_NA_DRAY' | 'ROAD_NA_EXPEDITED' | 'ROAD_NA_FLATBED' | 'ROAD_NA_HEAVY_BULK' | 'ROAD_NA_LTL_DRY_VAN' | 'ROAD_NA_MIXED' | 'ROAD_NA_MOVING' | 'ROAD_NA_PACKAGE' | 'ROAD_NA_REFRIGERATED' | 'ROAD_NA_SPECIALIZED' | 'ROAD_NA_TANKER' | 'ROAD_NA_TL_DRY_VAN' | 'ROAD_GLOBAL_VAN_LT_3500KG' | 'ROAD_GLOBAL_RIGID_TRUCK_3500KG_TO_7500KG' | 'ROAD_GLOBAL_RIGID_TRUCK_7500KG_TO_12T_GVW' | 'ROAD_GLOBAL_RIGID_TRUCK_12T_20T_GVW' | 'ROAD_GLOBAL_RIGID_TRUCK_20T_TO_26T_GVW' | 'ROAD_GLOBAL_RIGID_TRUCK_26T_TO_32T_GVW' | 'ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_34T_GVW' | 'ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_40T_GVW' | 'ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_40T_GVW_SI_ENGINE' | 'ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_40T_GVW_HPDI' | 'ROAD_GLOBAL_ARTIC_TRUCK_40T_GVW_LIGHTWEIGHT_TRAILER' | 'ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_44T_GVW' | 'ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_60T_GVW' | 'ROAD_GLOBAL_ARTIC_TRUCK_UP_TO_72T_GVW' | 'OCEAN_BULK_CARRIER_0_TO_9999_DWT' | 'OCEAN_BULK_CARRIER_10000_TO_34999_DWT' | 'OCEAN_BULK_CARRIER_35000_TO_59999_DWT' | 'OCEAN_BULK_CARRIER_60000_TO_99999_DWT' | 'OCEAN_BULK_CARRIER_100000_TO_199999_DWT' | 'OCEAN_BULK_CARRIER_200000_AND_UP_DWT' | 'OCEAN_CHEMICAL_TANKER_0_TO_4999_DWT' | 'OCEAN_CHEMICAL_TANKER_5000_TO_9999_DWT' | 'OCEAN_CHEMICAL_TANKER_10000_TO_19999_DWT' | 'OCEAN_CHEMICAL_TANKER_20000_TO_39999_DWT' | 'OCEAN_CHEMICAL_TANKER_40000_AND_UP_DWT' | 'OCEAN_GENERAL_CARGO_0_TO_4999_DWT' | 'OCEAN_GENERAL_CARGO_5000_TO_9999_DWT' | 'OCEAN_GENERAL_CARGO_10000_TO_19999_DWT' | 'OCEAN_GENERAL_CARGO_20000_AND_UP_DWT' | 'OCEAN_LNG_TANKER_0_TO_49999_CBM' | 'OCEAN_LNG_TANKER_50000_TO_99999_CBM' | 'OCEAN_LNG_TANKER_100000_TO_199999_CBM' | 'OCEAN_LNG_TANKER_200000_AND_UP_CBM' | 'OCEAN_OIL_TANKER_0_TO_4999_DWT' | 'OCEAN_OIL_TANKER_5000_TO_9999_DWT' | 'OCEAN_OIL_TANKER_10000_TO_19999_DWT' | 'OCEAN_OIL_TANKER_20000_TO_59999_DWT' | 'OCEAN_OIL_TANKER_60000_TO_79999_DWT' | 'OCEAN_OIL_TANKER_80000_TO_119999_DWT' | 'OCEAN_OIL_TANKER_120000_TO_199999_DWT' | 'OCEAN_OIL_TANKER_200000_AND_UP_DWT' | 'OCEAN_OTHER_LIQUIDS_TANKER_0_TO_999_DWT' | 'OCEAN_OTHER_LIQUIDS_TANKER_1000_AND_UP_DWT' | 'OCEAN_FERRY_ROPAX_0_TO_1999_GT' | 'OCEAN_FERRY_ROPAX_2000_TO_4999_GT' | 'OCEAN_FERRY_ROPAX_5000_TO_9999_GT' | 'OCEAN_FERRY_ROPAX_10000_TO_19999_GT' | 'OCEAN_FERRY_ROPAX_20000_AND_UP_GT' | 'OCEAN_REFRIGERATED_BULK_0_TO_1999_DWT' | 'OCEAN_REFRIGERATED_BULK_2000_TO_5999_DWT' | 'OCEAN_REFRIGERATED_BULK_6000_TO_9999_DWT' | 'OCEAN_REFRIGERATED_BULK_10000_AND_UP_DWT' | 'OCEAN_CONTAINER_AVERAGE'
          - `weight` 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
      - `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.</br></br>Only the following identifier types are accepted when creating or updating a shipment:<ul><li>Air</li><ul><li>AIR_WAYBILL</li><li>HOUSE_AIR_WAYBILL</li></ul><li>European Rail</li><ul><li>WAGON_ID</li><li>TRAIN_NUMBER</li></ul><li>North American Rail</li><ul><li>CONTAINER_ID</li><li>TRAILER_ID</li><li>RAIL_CAR_ID</li><li>BILL_OF_LADING</li><li>WAYBILL</li></ul><li>Ocean</li><ul><li>BILL_OF_LADING</li><li>BOOKING_NUMBER</li><li>CARRIER_SCAC</li><li>CONTAINER_ID</li></ul><li>Parcel</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>TRACKING_NUMBER</li><li>CARRIER_SCAC</li><li>REFERENCE_NUMBER</li></ul><li>LTL</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>PRO</li><li>BILL_OF_LADING</li><li>PICKUP</li><li>PURCHASE_ORDER</li></ul><li>Ocean Door-to-Door</li><ul><li>HOUSE_BILL_OF_LADING</li><li>FFW_SCAC</li><li>BOOKING_NUMBER</li><li>TRACKING_NUMBER</li></ul></ul>
      - `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)
