--- title: "Search Point To Point Routes" method: GET path: "/services/advanced-sailing-schedules/v1/point-to-point-routes" tags: ["Ocean: Point-to-Point Schedules"] --- # Search Point To Point Routes `GET /services/advanced-sailing-schedules/v1/point-to-point-routes` ## Request - Base URL: `https://na12.api.project44.com` - URL: `https://na12.api.project44.com/services/advanced-sailing-schedules/v1/point-to-point-routes` - Auth: OAuth 2 - Client credentials - Token URL: `/api/v4/oauth2/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Query parameters - `origin` string, required: Origin UN/LOCODE, e.g. NLRTM - `destination` string, required: Destination UN/LOCODE, e.g. USLGB - `departureStartDate` string, date: Earliest departure date (inclusive), in the origin port's local zone. Must be paired with departureEndDate. At least one complete window (departure and/or arrival) is required; the two windows combine with AND when both are given. - `departureEndDate` string, date: Latest departure date (inclusive), in the origin port's local zone. Must be paired with departureStartDate. - `arrivalStartDate` string, date: Earliest arrival date (inclusive), in the destination port's local zone. Must be paired with arrivalEndDate. - `arrivalEndDate` string, date: Latest arrival date (inclusive), in the destination port's local zone. Must be paired with arrivalStartDate. - `carrierCodes` string: Comma-separated SCAC list, e.g. carrierCodes=ONEY,MAEU. Must be a single repeated-comma string, not a repeated query param — carrierCodes=ONEY&carrierCodes=MAEU silently keeps only the last value. - `transshipmentsMax` integer - `sort` 'DEPARTURE_DATE_TIME' | 'ARRIVAL_DATE_TIME' | 'TRANSIT_TIME': Sort key for point-to-point route search results. All orderings are ascending. - `pageNumber` integer - `pageSize` integer ## Response `200` Successful Response - SailingSchedulePointToPointRoutePage: A paginated response containing results and information about the current page. - `paginationInfo` PaginationInfo: Pagination information about a collection of resources. - `pageNumber` integer: Matching page number given the supplied PaginationParameters. - `pageSize` integer: Page size matching the PaginationParameters. - `total` integer: Total number of resource items matching the supplied criteria. - `results` SailingSchedulePointToPointRoute[]: List of resources contained on this page. - `carrierCode` string: Booking carrier for the route (the same value also appears per-leg in servicePartners). - `carrierCodeListProvider` 'NMFTA' | 'SMDG': Code-list provider for carrierCode. - `carrierName` string: Carrier display name. - `cutOffTimes` SailingScheduleCutOffTime[]: Origin cut-off times; an empty array when none apply. - `cutOffDateTimeCode` string: Cut-off type, e.g. VCO, DCO, FCO, PCO. - `cutOffDateTime` string, date-time: Cut-off time. - `deliveryTypeAtDestination` 'CY' | 'SD' | 'CFS': Haulage/delivery type at destination. - `extensions` SailingScheduleExtensions - `routeId` string: Deterministic route identity, stable across schedule refreshes. - `legs` SailingScheduleLeg[]: Ordered legs making up this route — one entry per vessel, barge, or inland movement. - `arrival` SailingSchedulePlace - `dateTime` string, date-time: Event time in the location's local time zone, with its UTC offset. - `facilityTypeCode` string: Facility type, e.g. POTE (port terminal), INTE (inland terminal). - `location` SailingScheduleLocation - `address` SailingScheduleAddress - `city` string: City. - `countryCode` string: ISO 3166-1 alpha-2 country code. - `floor` string: Floor. - `postCode` string: Postal code. - `street` string: Street name. - `streetNumber` string: Street number. - `stateRegion` string: State or region. - `facilityName` string: Terminal display name. - `facility` SailingScheduleFacility - `facilityCode` string: SMDG facility code. - `facilityCodeListProvider` 'BIC' | 'SMDG': Code-list provider for facilityCode. - `locationName` string: Resolved port name. - `UNLocationCode` string: UN/LOCODE identifying the location. - `departure` SailingSchedulePlace - `dateTime` string, date-time: Event time in the location's local time zone, with its UTC offset. - `facilityTypeCode` string: Facility type, e.g. POTE (port terminal), INTE (inland terminal). - `location` SailingScheduleLocation - `address` SailingScheduleAddress - `city` string: City. - `countryCode` string: ISO 3166-1 alpha-2 country code. - `floor` string: Floor. - `postCode` string: Postal code. - `street` string: Street name. - `streetNumber` string: Street number. - `stateRegion` string: State or region. - `facilityName` string: Terminal display name. - `facility` SailingScheduleFacility - `facilityCode` string: SMDG facility code. - `facilityCodeListProvider` 'BIC' | 'SMDG': Code-list provider for facilityCode. - `locationName` string: Resolved port name. - `UNLocationCode` string: UN/LOCODE identifying the location. - `sequenceNumber` integer: 1-based order of this leg within the route. - `transport` union: The vessel, barge, or inland transport performing this leg. - SailingScheduleVesselTransport - `modeOfTransport` 'VESSEL': Mode of transport for this leg. - `servicePartners` SailingScheduleServicePartner[]: Carrier(s) and the service/voyage operating this leg. - `carrierCode` string: SCAC of the carrier operating this leg. - `carrierCodeListProvider` 'NMFTA' | 'SMDG': Code-list provider for carrierCode. - `carrierServiceCode` string: Carrier service/loop code, e.g. AT1. - `carrierServiceName` string: Service/loop name, e.g. TRANSATLANTIC 1. - `carrierExportVoyageNumber` string: Export voyage number. - `carrierImportVoyageNumber` string: Import voyage number. - `transportCallReference` string: Carrier transport-call reference. - `universalServiceReference` string: DCSA universal service reference. - `universalExportVoyageReference` string: DCSA universal export voyage reference. - `vessel` SailingScheduleVessel - `callSign` string: Radio call sign. - `flag` string: Flag state of the vessel. - `name` string: Vessel name. - `operatorCarrierCode` string: SCAC of the vessel's hull operator, which may differ from the service carrier (slot charter). - `operatorCarrierCodeListProvider` 'NMFTA' | 'SMDG': Code-list provider for operatorCarrierCode. - `vesselIMONumber` string: IMO number of the vessel. - SailingScheduleBargeTransport - `barge` SailingScheduleBarge - `callSign` string: Radio call sign. - `flag` string: Flag state of the barge. - `name` string: Barge name. - `operatorCarrierCode` string: SCAC of the barge's hull operator, which may differ from the service carrier (slot charter). - `operatorCarrierCodeListProvider` 'NMFTA' | 'SMDG': Code-list provider for operatorCarrierCode. - `vesselIMONumber` string: IMO number of the barge. - `modeOfTransport` 'BARGE': Mode of transport for this leg. - `servicePartners` SailingScheduleServicePartner[]: Carrier(s) and the service/voyage operating this leg. - `carrierCode` string: SCAC of the carrier operating this leg. - `carrierCodeListProvider` 'NMFTA' | 'SMDG': Code-list provider for carrierCode. - `carrierServiceCode` string: Carrier service/loop code, e.g. AT1. - `carrierServiceName` string: Service/loop name, e.g. TRANSATLANTIC 1. - `carrierExportVoyageNumber` string: Export voyage number. - `carrierImportVoyageNumber` string: Import voyage number. - `transportCallReference` string: Carrier transport-call reference. - `universalServiceReference` string: DCSA universal service reference. - `universalExportVoyageReference` string: DCSA universal export voyage reference. - SailingScheduleOtherTransport - `modeOfTransport` 'RAIL' | 'TRUCK' | 'RAIL_TRUCK' | 'BARGE_TRUCK' | 'BARGE_RAIL' | 'MULTIMODAL': Inland mode of transport, e.g. RAIL or TRUCK. No other fields are permitted for inland legs. - `placeOfReceipt` SailingSchedulePlace - `dateTime` string, date-time: Event time in the location's local time zone, with its UTC offset. - `facilityTypeCode` string: Facility type, e.g. POTE (port terminal), INTE (inland terminal). - `location` SailingScheduleLocation - `address` SailingScheduleAddress - `city` string: City. - `countryCode` string: ISO 3166-1 alpha-2 country code. - `floor` string: Floor. - `postCode` string: Postal code. - `street` string: Street name. - `streetNumber` string: Street number. - `stateRegion` string: State or region. - `facilityName` string: Terminal display name. - `facility` SailingScheduleFacility - `facilityCode` string: SMDG facility code. - `facilityCodeListProvider` 'BIC' | 'SMDG': Code-list provider for facilityCode. - `locationName` string: Resolved port name. - `UNLocationCode` string: UN/LOCODE identifying the location. - `placeOfDelivery` SailingSchedulePlace - `dateTime` string, date-time: Event time in the location's local time zone, with its UTC offset. - `facilityTypeCode` string: Facility type, e.g. POTE (port terminal), INTE (inland terminal). - `location` SailingScheduleLocation - `address` SailingScheduleAddress - `city` string: City. - `countryCode` string: ISO 3166-1 alpha-2 country code. - `floor` string: Floor. - `postCode` string: Postal code. - `street` string: Street name. - `streetNumber` string: Street number. - `stateRegion` string: State or region. - `facilityName` string: Terminal display name. - `facility` SailingScheduleFacility - `facilityCode` string: SMDG facility code. - `facilityCodeListProvider` 'BIC' | 'SMDG': Code-list provider for facilityCode. - `locationName` string: Resolved port name. - `UNLocationCode` string: UN/LOCODE identifying the location. - `receiptTypeAtOrigin` 'CY' | 'SD' | 'CFS': Haulage/receipt type at origin. - `solutionNumber` integer: Index of this routing solution among the returned results. - `transshipmentCount` integer: Number of intermediate transfer points on this route. - `transitTime` integer: Total transit time, in whole days. ## Other responses - `400`: Invalid or missing query parameters. - `401`: Missing or invalid credentials. - `403`: Authenticated but lacking the required permission. --- [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)