Version 4.0.0 of project44's API
License © 2024 project44 - Terms of Use
Version 4.0.0 of project44's API
shipmentEvent
The time when this event occurred. If relevant, the offset will be relative to where the event occurred, otherwise will be in UTC. Will only be populated for events that have already happened.
The estimated time that this event is likely to occur. Only populated if event has not occurred yet.
The time when project44 last calculated the estimate for this event. Only populated if event has not occurred yet.
The planned time when this event is scheduled to occur. If plannedEndDateTime is set, this is the start of the planned window of time for the event.
The time when project44 received or calculated this event. Will only be populated for events that have already happened.
If relevant, this will be populated with the id of a route segment on which this event occurred. This can be used to associate the event with a specific vehicle.
If relevant, this will be populated with the id of the stop to which this event relates.
The type of event that occurred. Will always be populated.
curl -i -X POST \ 'https://developers.project44.com/_mock/guides/carriers/visibility/ftl/api/api/v4/capacityproviders/tl/shipments/{shipmentLegId}/events' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "dateTime": "string", "dateTimes": [ { "type": "UNKNOWN", "dateTime": "2019-08-24T14:15:22Z", "endDateTime": "2019-08-24T14:15:22Z", "lastModifiedDateTime": "2019-08-24T14:15:22Z", "source": "UNKNOWN", "sourceIdentifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "selected": true, "sequence": 0 } ], "description": "string", "details": { "mobileTracking": { "code": "UNKNOWN" }, "ocean": { "code": "UNKNOWN" }, "qualityControl": { "code": "UNKNOWN" } }, "estimateDateTime": "string", "estimateLastCalculatedDateTime": "string", "plannedDateTime": "string", "plannedEndDateTime": "string", "receivedDateTime": "string", "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352", "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43", "type": "UNKNOWN" }'
OK
The time when this event occurred. If relevant, the offset will be relative to where the event occurred, otherwise will be in UTC. Will only be populated for events that have already happened.
The estimated time that this event is likely to occur. Only populated if event has not occurred yet.
The time when project44 last calculated the estimate for this event. Only populated if event has not occurred yet.
The planned time when this event is scheduled to occur. If plannedEndDateTime is set, this is the start of the planned window of time for the event.
The time when project44 received or calculated this event. Will only be populated for events that have already happened.
If relevant, this will be populated with the id of a route segment on which this event occurred. This can be used to associate the event with a specific vehicle.
If relevant, this will be populated with the id of the stop to which this event relates.
The type of event that occurred. Will always be populated.
{ "dateTime": "string", "dateTimes": [ { … } ], "description": "string", "details": { "mobileTracking": { … }, "ocean": { … }, "qualityControl": { … } }, "estimateDateTime": "string", "estimateLastCalculatedDateTime": "string", "plannedDateTime": "string", "plannedEndDateTime": "string", "receivedDateTime": "string", "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352", "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43", "type": "UNKNOWN" }
additionalAppointmentWindow
This is the state of the appointment as determined by the source appointment management system. This status is used to represent where the appointment is within its lifecycle, it does not represent the physical state of the asset fulfilling the appointment.
A date and time range, including a time zone, representing a window of availability.
A list of identifiers of the additional appointment windows to a shipment.
curl -i -X PUT \ 'https://developers.project44.com/_mock/guides/carriers/visibility/ftl/api/api/v4/capacityproviders/tl/shipments/{shipmentLegId}/stops/{stopId}/additional-appointment-windows' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "appointmentStatus": "PENDING", "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "identifiers": [ { "type": "DOCK", "value": "string" } ], "type": "STRATEGIC" }'
OK
This is the state of the appointment as determined by the source appointment management system. This status is used to represent where the appointment is within its lifecycle, it does not represent the physical state of the asset fulfilling the appointment.
A date and time range, including a time zone, representing a window of availability.
A list of identifiers of the additional appointment windows to a shipment.
{ "appointmentStatus": "PENDING", "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "identifiers": [ { … } ], "type": "STRATEGIC" }
curl -i -X POST \ https://developers.project44.com/_mock/guides/carriers/visibility/ftl/api/api/v4/capacityproviders/tl/shipments/intermediateStops \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerAccountNumber": "string", "shipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ], "shipmentStops": [ { "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "geoCoordinates": { "latitude": -90, "longitude": -180 }, "location": { "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" } }, "stopName": "string" } ] }'
{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerAccountNumber": "string", "shipmentIdentifiers": [ { … } ], "shipmentStops": [ { … } ] }
statusUpdate
curl -i -X POST \ https://developers.project44.com/_mock/guides/carriers/visibility/ftl/api/api/v4/capacityproviders/tl/shipments/statusUpdates \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerId": "string", "equipmentIdentifiers": [ { "shouldDelete": true, "type": "MOBILE_PHONE_NUMBER", "value": "string" } ], "eventStopNumber": 0, "eventType": "DELIVERED", "hoursOfServiceRemaining": 0, "latestTemperature": 0, "latestTemperatureUnit": "F", "latitude": 0, "longitude": 0, "shipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ], "shipmentStops": [ { "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "appointmentWindow": { "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string", "startDateTime": "2019-08-24T14:15:22Z" }, "arrivalDateTime": "2019-08-24T14:15:22Z", "carrierSuppliedEta": "string", "contact": { "companyName": "string", "contactName": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string", "phoneNumber": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "phoneNumberCountryCode": "string" }, "departureDateTime": "2019-08-24T14:15:22Z", "stopName": "string", "stopNumber": 0 } ], "utcTimestamp": "2019-08-24T14:15:22Z" }'
{ "carrierIdentifier": { "type": "SCAC", "value": "string" }, "customerId": "string", "equipmentIdentifiers": [ { … } ], "eventStopNumber": 0, "eventType": "DELIVERED", "hoursOfServiceRemaining": 0, "latestTemperature": 0, "latestTemperatureUnit": "F", "latitude": 0, "longitude": 0, "shipmentIdentifiers": [ { … } ], "shipmentStops": [ { … } ], "utcTimestamp": "2019-08-24T14:15:22Z" }