Creating a Shipment Note
Adding a Note to a Shipment
To POST a shipment ShipmentNote Object, you'll need to first provide the specific FreightProviderReferenceNumber or the TenFourLicensePlate.
To POST a ShipmentNote Object, the following fields are required:
1. FreightProviderReferenceNumber
2. TenFourLicensePlate
Parameter | Type | Description |
---|---|---|
FreightProviderReferenceNumber | String | The external reference number of the shipper's given shipment (BOL). |
TenFourLicensePlate | String | The uniquely generated 10-4 response when creating a shipment within Freight Portal. |
Here is an example JSON Object:
{
"FreightProviderReferenceNumber":"12345670",
"FreightHaulerProviderXID":"ABD3820AI"
}
{
"TenFourLicensePlate":"T9302NB"
}
Adding Note-Detail Data
To upload a note to a specific shipment, the following additional fields are required:
Parameter | Type | Description |
---|---|---|
Text | String | The shipment note's text. |
isShared | Boolean | |
SMSDriver | Boolean |
Here is an example of the JSON Object thus far:
{
"FreightProviderReferenceNumber": "RefBoom09876",
"Text": "Your Note here",
"isShared": true,
"SMSDriver": true
}
Completed Note Upload JSON Object
Here you can see an example of a completely ShipmentNote Object:
{
"FreightProviderReferenceNumber": "RefBoom09876",
"Text": "Your Note here",
"isShared": true,
"SMSDriver": true
}
Updated about 2 months ago