GET api/v1/SeaSchedules?date={date}&fromPort={fromPort}&toPort={toPort}&weeksOut={weeksOut}&directOnly={directOnly}&vesselName={vesselName}&imoNumber={imoNumber}&carriers={carriers}
Get data from API
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| date | Date is Preferred date of shipment. Required format (YYYY-MM-DD). |
Define this parameter in the request URI. |
| fromPort | Origin Port code e.g. SGSIN |
Define this parameter in the request URI. |
| toPort | Destination Port code e.g. THBKK |
Define this parameter in the request URI. |
| weeksOut | Weeks after date that search will cover. |
Define this parameter in the request URI. |
| directOnly | direct, directPlusIndirect or directAll. |
Define this parameter in the request URI. |
| vesselName |
Define this parameter in the request URI. |
|
| imoNumber |
Define this parameter in the request URI. |
|
| carriers | Comma separated list of carriers to get schedules for, if blank then all schedules are returned. |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
[
{
"ShipmentId": "sample string 1",
"Carrier": "sample string 2",
"TransitTime": 3,
"FromCyClosing": "2025-04-24T13:06:11.5370332Z",
"ToCyClosing": "2025-04-24T13:06:11.5370332Z",
"FromPort": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ToPort": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"FromETA": "2025-04-24T13:06:11.5370332Z",
"FromETD": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 4",
"VesselName": "sample string 5",
"ImoNumber": 6,
"LoopName": "sample string 7",
"LoopAbbr": "sample string 8",
"VoyageNumber": "sample string 9",
"SCACCode": "sample string 10",
"ToETA": "2025-04-24T13:06:11.5370332Z",
"ToETD": "2025-04-24T13:06:11.5370332Z",
"Stops": 11,
"Transshipments": [
{
"Port": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ETA": "2025-04-24T13:06:11.5370332Z",
"ETD": "2025-04-24T13:06:11.5370332Z",
"CyClosing": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 1",
"VesselName": "sample string 2",
"ImoNumber": 3,
"LoopName": "sample string 4",
"LoopAbbr": "sample string 5",
"VoyageNumber": "sample string 6",
"SCACCode": "sample string 7"
},
{
"Port": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ETA": "2025-04-24T13:06:11.5370332Z",
"ETD": "2025-04-24T13:06:11.5370332Z",
"CyClosing": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 1",
"VesselName": "sample string 2",
"ImoNumber": 3,
"LoopName": "sample string 4",
"LoopAbbr": "sample string 5",
"VoyageNumber": "sample string 6",
"SCACCode": "sample string 7"
},
{
"Port": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ETA": "2025-04-24T13:06:11.5370332Z",
"ETD": "2025-04-24T13:06:11.5370332Z",
"CyClosing": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 1",
"VesselName": "sample string 2",
"ImoNumber": 3,
"LoopName": "sample string 4",
"LoopAbbr": "sample string 5",
"VoyageNumber": "sample string 6",
"SCACCode": "sample string 7"
}
]
},
{
"ShipmentId": "sample string 1",
"Carrier": "sample string 2",
"TransitTime": 3,
"FromCyClosing": "2025-04-24T13:06:11.5370332Z",
"ToCyClosing": "2025-04-24T13:06:11.5370332Z",
"FromPort": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ToPort": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"FromETA": "2025-04-24T13:06:11.5370332Z",
"FromETD": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 4",
"VesselName": "sample string 5",
"ImoNumber": 6,
"LoopName": "sample string 7",
"LoopAbbr": "sample string 8",
"VoyageNumber": "sample string 9",
"SCACCode": "sample string 10",
"ToETA": "2025-04-24T13:06:11.5370332Z",
"ToETD": "2025-04-24T13:06:11.5370332Z",
"Stops": 11,
"Transshipments": [
{
"Port": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ETA": "2025-04-24T13:06:11.5370332Z",
"ETD": "2025-04-24T13:06:11.5370332Z",
"CyClosing": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 1",
"VesselName": "sample string 2",
"ImoNumber": 3,
"LoopName": "sample string 4",
"LoopAbbr": "sample string 5",
"VoyageNumber": "sample string 6",
"SCACCode": "sample string 7"
},
{
"Port": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ETA": "2025-04-24T13:06:11.5370332Z",
"ETD": "2025-04-24T13:06:11.5370332Z",
"CyClosing": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 1",
"VesselName": "sample string 2",
"ImoNumber": 3,
"LoopName": "sample string 4",
"LoopAbbr": "sample string 5",
"VoyageNumber": "sample string 6",
"SCACCode": "sample string 7"
},
{
"Port": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ETA": "2025-04-24T13:06:11.5370332Z",
"ETD": "2025-04-24T13:06:11.5370332Z",
"CyClosing": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 1",
"VesselName": "sample string 2",
"ImoNumber": 3,
"LoopName": "sample string 4",
"LoopAbbr": "sample string 5",
"VoyageNumber": "sample string 6",
"SCACCode": "sample string 7"
}
]
},
{
"ShipmentId": "sample string 1",
"Carrier": "sample string 2",
"TransitTime": 3,
"FromCyClosing": "2025-04-24T13:06:11.5370332Z",
"ToCyClosing": "2025-04-24T13:06:11.5370332Z",
"FromPort": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ToPort": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"FromETA": "2025-04-24T13:06:11.5370332Z",
"FromETD": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 4",
"VesselName": "sample string 5",
"ImoNumber": 6,
"LoopName": "sample string 7",
"LoopAbbr": "sample string 8",
"VoyageNumber": "sample string 9",
"SCACCode": "sample string 10",
"ToETA": "2025-04-24T13:06:11.5370332Z",
"ToETD": "2025-04-24T13:06:11.5370332Z",
"Stops": 11,
"Transshipments": [
{
"Port": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ETA": "2025-04-24T13:06:11.5370332Z",
"ETD": "2025-04-24T13:06:11.5370332Z",
"CyClosing": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 1",
"VesselName": "sample string 2",
"ImoNumber": 3,
"LoopName": "sample string 4",
"LoopAbbr": "sample string 5",
"VoyageNumber": "sample string 6",
"SCACCode": "sample string 7"
},
{
"Port": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ETA": "2025-04-24T13:06:11.5370332Z",
"ETD": "2025-04-24T13:06:11.5370332Z",
"CyClosing": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 1",
"VesselName": "sample string 2",
"ImoNumber": 3,
"LoopName": "sample string 4",
"LoopAbbr": "sample string 5",
"VoyageNumber": "sample string 6",
"SCACCode": "sample string 7"
},
{
"Port": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"ETA": "2025-04-24T13:06:11.5370332Z",
"ETD": "2025-04-24T13:06:11.5370332Z",
"CyClosing": "2025-04-24T13:06:11.5370332Z",
"Operator": "sample string 1",
"VesselName": "sample string 2",
"ImoNumber": 3,
"LoopName": "sample string 4",
"LoopAbbr": "sample string 5",
"VoyageNumber": "sample string 6",
"SCACCode": "sample string 7"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfSeaScheduleDTO>
<SeaScheduleDTO>
<ShipmentId>sample string 1</ShipmentId>
<Carrier>sample string 2</Carrier>
<TransitTime>3</TransitTime>
<FromCyClosing>2025-04-24T13:06:11.5370332+00:00</FromCyClosing>
<ToCyClosing>2025-04-24T13:06:11.5370332+00:00</ToCyClosing>
<FromPort>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</FromPort>
<ToPort>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</ToPort>
<FromETA>2025-04-24T13:06:11.5370332+00:00</FromETA>
<FromETD>2025-04-24T13:06:11.5370332+00:00</FromETD>
<Operator>sample string 4</Operator>
<VesselName>sample string 5</VesselName>
<ImoNumber>6</ImoNumber>
<LoopName>sample string 7</LoopName>
<LoopAbbr>sample string 8</LoopAbbr>
<VoyageNumber>sample string 9</VoyageNumber>
<SCACCode>sample string 10</SCACCode>
<ToETA>2025-04-24T13:06:11.5370332+00:00</ToETA>
<ToETD>2025-04-24T13:06:11.5370332+00:00</ToETD>
<Stops>11</Stops>
<Transshipments>
<SeaScheduleTransshipmentDTO>
<Port>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Port>
<ETA>2025-04-24T13:06:11.5370332+00:00</ETA>
<ETD>2025-04-24T13:06:11.5370332+00:00</ETD>
<CyClosing>2025-04-24T13:06:11.5370332+00:00</CyClosing>
<Operator>sample string 1</Operator>
<VesselName>sample string 2</VesselName>
<ImoNumber>3</ImoNumber>
<LoopName>sample string 4</LoopName>
<LoopAbbr>sample string 5</LoopAbbr>
<VoyageNumber>sample string 6</VoyageNumber>
<SCACCode>sample string 7</SCACCode>
</SeaScheduleTransshipmentDTO>
<SeaScheduleTransshipmentDTO>
<Port>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Port>
<ETA>2025-04-24T13:06:11.5370332+00:00</ETA>
<ETD>2025-04-24T13:06:11.5370332+00:00</ETD>
<CyClosing>2025-04-24T13:06:11.5370332+00:00</CyClosing>
<Operator>sample string 1</Operator>
<VesselName>sample string 2</VesselName>
<ImoNumber>3</ImoNumber>
<LoopName>sample string 4</LoopName>
<LoopAbbr>sample string 5</LoopAbbr>
<VoyageNumber>sample string 6</VoyageNumber>
<SCACCode>sample string 7</SCACCode>
</SeaScheduleTransshipmentDTO>
<SeaScheduleTransshipmentDTO>
<Port>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Port>
<ETA>2025-04-24T13:06:11.5370332+00:00</ETA>
<ETD>2025-04-24T13:06:11.5370332+00:00</ETD>
<CyClosing>2025-04-24T13:06:11.5370332+00:00</CyClosing>
<Operator>sample string 1</Operator>
<VesselName>sample string 2</VesselName>
<ImoNumber>3</ImoNumber>
<LoopName>sample string 4</LoopName>
<LoopAbbr>sample string 5</LoopAbbr>
<VoyageNumber>sample string 6</VoyageNumber>
<SCACCode>sample string 7</SCACCode>
</SeaScheduleTransshipmentDTO>
</Transshipments>
</SeaScheduleDTO>
<SeaScheduleDTO>
<ShipmentId>sample string 1</ShipmentId>
<Carrier>sample string 2</Carrier>
<TransitTime>3</TransitTime>
<FromCyClosing>2025-04-24T13:06:11.5370332+00:00</FromCyClosing>
<ToCyClosing>2025-04-24T13:06:11.5370332+00:00</ToCyClosing>
<FromPort>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</FromPort>
<ToPort>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</ToPort>
<FromETA>2025-04-24T13:06:11.5370332+00:00</FromETA>
<FromETD>2025-04-24T13:06:11.5370332+00:00</FromETD>
<Operator>sample string 4</Operator>
<VesselName>sample string 5</VesselName>
<ImoNumber>6</ImoNumber>
<LoopName>sample string 7</LoopName>
<LoopAbbr>sample string 8</LoopAbbr>
<VoyageNumber>sample string 9</VoyageNumber>
<SCACCode>sample string 10</SCACCode>
<ToETA>2025-04-24T13:06:11.5370332+00:00</ToETA>
<ToETD>2025-04-24T13:06:11.5370332+00:00</ToETD>
<Stops>11</Stops>
<Transshipments>
<SeaScheduleTransshipmentDTO>
<Port>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Port>
<ETA>2025-04-24T13:06:11.5370332+00:00</ETA>
<ETD>2025-04-24T13:06:11.5370332+00:00</ETD>
<CyClosing>2025-04-24T13:06:11.5370332+00:00</CyClosing>
<Operator>sample string 1</Operator>
<VesselName>sample string 2</VesselName>
<ImoNumber>3</ImoNumber>
<LoopName>sample string 4</LoopName>
<LoopAbbr>sample string 5</LoopAbbr>
<VoyageNumber>sample string 6</VoyageNumber>
<SCACCode>sample string 7</SCACCode>
</SeaScheduleTransshipmentDTO>
<SeaScheduleTransshipmentDTO>
<Port>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Port>
<ETA>2025-04-24T13:06:11.5370332+00:00</ETA>
<ETD>2025-04-24T13:06:11.5370332+00:00</ETD>
<CyClosing>2025-04-24T13:06:11.5370332+00:00</CyClosing>
<Operator>sample string 1</Operator>
<VesselName>sample string 2</VesselName>
<ImoNumber>3</ImoNumber>
<LoopName>sample string 4</LoopName>
<LoopAbbr>sample string 5</LoopAbbr>
<VoyageNumber>sample string 6</VoyageNumber>
<SCACCode>sample string 7</SCACCode>
</SeaScheduleTransshipmentDTO>
<SeaScheduleTransshipmentDTO>
<Port>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Port>
<ETA>2025-04-24T13:06:11.5370332+00:00</ETA>
<ETD>2025-04-24T13:06:11.5370332+00:00</ETD>
<CyClosing>2025-04-24T13:06:11.5370332+00:00</CyClosing>
<Operator>sample string 1</Operator>
<VesselName>sample string 2</VesselName>
<ImoNumber>3</ImoNumber>
<LoopName>sample string 4</LoopName>
<LoopAbbr>sample string 5</LoopAbbr>
<VoyageNumber>sample string 6</VoyageNumber>
<SCACCode>sample string 7</SCACCode>
</SeaScheduleTransshipmentDTO>
</Transshipments>
</SeaScheduleDTO>
<SeaScheduleDTO>
<ShipmentId>sample string 1</ShipmentId>
<Carrier>sample string 2</Carrier>
<TransitTime>3</TransitTime>
<FromCyClosing>2025-04-24T13:06:11.5370332+00:00</FromCyClosing>
<ToCyClosing>2025-04-24T13:06:11.5370332+00:00</ToCyClosing>
<FromPort>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</FromPort>
<ToPort>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</ToPort>
<FromETA>2025-04-24T13:06:11.5370332+00:00</FromETA>
<FromETD>2025-04-24T13:06:11.5370332+00:00</FromETD>
<Operator>sample string 4</Operator>
<VesselName>sample string 5</VesselName>
<ImoNumber>6</ImoNumber>
<LoopName>sample string 7</LoopName>
<LoopAbbr>sample string 8</LoopAbbr>
<VoyageNumber>sample string 9</VoyageNumber>
<SCACCode>sample string 10</SCACCode>
<ToETA>2025-04-24T13:06:11.5370332+00:00</ToETA>
<ToETD>2025-04-24T13:06:11.5370332+00:00</ToETD>
<Stops>11</Stops>
<Transshipments>
<SeaScheduleTransshipmentDTO>
<Port>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Port>
<ETA>2025-04-24T13:06:11.5370332+00:00</ETA>
<ETD>2025-04-24T13:06:11.5370332+00:00</ETD>
<CyClosing>2025-04-24T13:06:11.5370332+00:00</CyClosing>
<Operator>sample string 1</Operator>
<VesselName>sample string 2</VesselName>
<ImoNumber>3</ImoNumber>
<LoopName>sample string 4</LoopName>
<LoopAbbr>sample string 5</LoopAbbr>
<VoyageNumber>sample string 6</VoyageNumber>
<SCACCode>sample string 7</SCACCode>
</SeaScheduleTransshipmentDTO>
<SeaScheduleTransshipmentDTO>
<Port>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Port>
<ETA>2025-04-24T13:06:11.5370332+00:00</ETA>
<ETD>2025-04-24T13:06:11.5370332+00:00</ETD>
<CyClosing>2025-04-24T13:06:11.5370332+00:00</CyClosing>
<Operator>sample string 1</Operator>
<VesselName>sample string 2</VesselName>
<ImoNumber>3</ImoNumber>
<LoopName>sample string 4</LoopName>
<LoopAbbr>sample string 5</LoopAbbr>
<VoyageNumber>sample string 6</VoyageNumber>
<SCACCode>sample string 7</SCACCode>
</SeaScheduleTransshipmentDTO>
<SeaScheduleTransshipmentDTO>
<Port>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</Port>
<ETA>2025-04-24T13:06:11.5370332+00:00</ETA>
<ETD>2025-04-24T13:06:11.5370332+00:00</ETD>
<CyClosing>2025-04-24T13:06:11.5370332+00:00</CyClosing>
<Operator>sample string 1</Operator>
<VesselName>sample string 2</VesselName>
<ImoNumber>3</ImoNumber>
<LoopName>sample string 4</LoopName>
<LoopAbbr>sample string 5</LoopAbbr>
<VoyageNumber>sample string 6</VoyageNumber>
<SCACCode>sample string 7</SCACCode>
</SeaScheduleTransshipmentDTO>
</Transshipments>
</SeaScheduleDTO>
</ArrayOfSeaScheduleDTO>