Overview
Load represents the actual movement of items on an order via a shipment.
The Loads API provides visibility into order details as it travels between two stops. Loads can be visible across any mode of tracking, including Ocean, Air, Rail, TL, LTL, and Parcel. Use these endpoints to create (POST), track (GET), update (PUT), or delete(DELETE) loads. You can return load information by either unique shipment ID or by unique load ID.
Use the following information to write a client application to integrate your TMS or other system to the project44 platform through our Loads API.
Workflow
Get Credentials
You must be provisioned with a tenant to have a client application within that tenant with the appropriate permissions to use any API within project44.
See here for more information on Authentication and Authorization.
Create a Load
Use the POST endpoint to create a Load. Load can and preferably should be created with masterShipmentId
as shipment reference, but it is possible to create load with other shipment identifiers like BOL, AWB etc.
Important fields:
items
pickupStopReference.stopId - Essential for accurate ETA computation.
deliveryStopReference.stopId- Essential for accurate ETA computation.
Endpoint | /api/v4/loads |
Verb | POST |
Required Fields | masterShipmentId , at least one identifier (identifiers.type , identifiers.value ) |
Get Load Information by Master Shipment ID
Use the GET endpoint to retrieve information about a Load by master shipment ID.
Endpoint | /api/v4/shipments/{masterShipmentId}/loads |
Verb | GET |
Required Fields | masterShipmentId |
Get Load Information by Load ID
Use the GET endpoint to retrieve information about a Load by Load id.
Endpoint | /api/v4/shipments/{masterShipmentId}/loads |
Verb | GET |
Required Fields | loadId |
Update a Load
Use the PUT endpoint to update a Load.
Endpoint | /api/v4/loads/{loadId} |
Verb | PUT |
Required Fields | loadId , masterShipmentId , at least one identifier (identifiers.type , identifiers.value ) |
Delete a Load
Use the DELETE endpoint to delete a Load.
Endpoint | /api/v4/loads/{loadId} |
Verb | DELETE |
Required Fields | loadId |