Version 4.0.0 of project44's API
License © 2024 project44 - Terms of Use
Version 4.0.0 of project44's API
If the shipment is initialized by using geoCoordinates instead of an address, it may be possible that a street address will not be returned in the response.
shipment
A user-defined list of equipment identifiers identifying rail equipment to be tracked as part of this shipment. This includes container ids and rail car ids. A rail shipment may only have 1 equipment identifier
DEPRECATED: The project44-generated id for the rail shipment. This may not be provided when creating a shipment, but will always be returned in the shipment confirmation. This id may be used in subsequent API calls to reference a shipment. This field is deprecated, use railLegId instead.
This id links 1 or more legs as part of the same overall shipment. For intermodal shipments, pass an existing masterShipmentId to link this rail 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.
Identifies the leg of the journey. Each piece of equipment has a unique id for each mode that it travels on.This id may be used in subsequent API calls to reference this shipment leg.
A user-defined list of shipment identifiers that are unique to this shipment. You must pass in either a shipment identifier or a tracking start date time.
Tracking for this shipment will begin at this time. This should be set to the time when your shipment has been loaded into the container or rail car. Cannot be more than 90 days in the past or 90 days in the future. You must pass in either a shipment identifier or a tracking start date time.
curl -i -X POST \ https://developers.project44.com/_mock/guides/shippers/visibility/rail/api/api/v4/rail/shipments/ \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "equipmentIdentifiers": [ { "type": "CONTAINER_ID", "value": "string" } ], "id": 0, "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "railLegId": "e076b925-ff0c-4137-8d6a-f8f1b6739588", "shipmentIdentifiers": [ { "type": "BILL_OF_LADING", "value": "string" } ], "shipmentStops": [ { "appointmentWindow": { "startDateTime": "2019-08-24T14:15:22Z", "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string" }, "geoCoordinates": { "latitude": -90, "longitude": -180 }, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "location": { "address": { "pointName": "string", "state": "string" }, "id": "string" }, "stopName": "string", "stopNumber": 0, "type": "UNKNOWN" } ], "trackingStartDateTime": "string" }'
{ "infoMessages": [ { … } ], "shipment": { "equipmentIdentifiers": [ … ], "id": 0, "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "railLegId": "e076b925-ff0c-4137-8d6a-f8f1b6739588", "shipmentIdentifiers": [ … ], "shipmentStops": [ … ], "trackingStartDateTime": "string" } }
curl -i -X DELETE \ 'https://developers.project44.com/_mock/guides/shippers/visibility/rail/api/api/v4/rail/shipments/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "httpStatusCode": 0, "httpMessage": "string", "errorMessage": "string", "errors": [ { … } ], "supportReferenceId": "string" }
curl -i -X GET \ 'https://developers.project44.com/_mock/guides/shippers/visibility/rail/api/api/v4/rail/shipments/{id}/statuses?includeStatusHistory=false' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "equipmentStatuses": [ { … } ], "infoMessages": [ { … } ], "shipment": { "equipmentIdentifiers": [ … ], "id": 0, "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "railLegId": "e076b925-ff0c-4137-8d6a-f8f1b6739588", "shipmentIdentifiers": [ … ], "shipmentStops": [ … ], "trackingStartDateTime": "string" } }