Loads
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.
Overview
Use the following information to write a client application to integrate your TMS or other system to the project44 platform through our Loads API.
More robust user guides are coming soon – stay tuned!
Workflow
Workflow Details
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.
Endpoint | /api/v4/loads |
Verb | POST |
Required Fields | masterShipmentId , at least one identifier (identifiers.type , identifiers.value ) |
A Load can only be created after a shipment exists in the p44 system. Use the master shipment ID from the shipment to create the load.
A unique project44 ID is returned in the response after shipment creation. You can store this ID to use in future API calls.
Get Load Information
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 |