Stop Doc/File Upload

2 min

When a file is uploaded for a stop from the CarrierLink mobile app or the FourKites web app, the following notification will be POSTed to the callback URL.

Note: If the Base64 feature Flag is Enabled for your company, the Base64 image will be added to the callback payload. If you want the StopReferenceNumbers & EncryptedURL to be sent in callbacks, you need to have the Stop Reference Numbers & Encrypted URL feature flags enabled.

{
"MessageType": "STOP_FILE_UPLOAD",
"FileExtension": "tiff",
"StopName": "StopTest",
"StopSequence": 1,
"Shipper": "gsshipper",
"SignerName": "rrr",
"dataSource": "fourkites-x",
"LoadNumber": "EDI_0402",
"StopReferenceNumbers": [
"DO:994891893",
"CO:57348",
],
"ProNumber": null,
"Timestamp": "2019-02-05T02:09:01-08:00",
"Scac": "SCACTL",
"Tags": [],
"StopReferenceId": null,
"StopType": "pickup",
"TimezoneShortName": "PST",
"FourKitesLoadId": 376736,
"Timezone": "America/Los_Angeles",
"FileUrl": "https://uat-stop-files.s3.amazonaws.com/gsshipper/load_25187229_stop_1202681_LocationUpdate_TruckUpdate.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJLZAZSHYCQ%2F20190205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190205T100901Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=6212ae329af88a5929f8bfd62d515bdcab14ac775d19a",
"ReferenceNumbers": [],
"Filetype": "Return Receipt",
"TimezoneOffset": -28800
}

Note: FourKites system accepts file uploads up to 10 MB in size. Refer to the Document Upload API documentation for more information.

MessageType	Field Name	Description	Key Always Present?	Value Always Present?	Condition for Key to be Present	Data Type	Max Length
STOP_FILE_UPLOAD	DocumentType	Type of file that was uploaded. Possible values are "Proof Of Delivery" for POD and "Return Receipt" for Return Orders.	Yes	No	N/A	String	50
STOP_FILE_UPLOAD	FileExtension	File type specific to the document uploaded. The following are the standard file type: JPG, PNG, PDF, JPEG,TIFF, DOC, DOCX, XLS, XLSX	Yes	No	N/A	String	50
STOP_FILE_UPLOAD	FileUrl	Url for downloading/viewing the file. This Url will be active only for 24 hours and the customers are advised to download the file as soon as they receive this message instead of relying on the Url.	Yes	Yes	The value could just be File URL for some, and depending on the ask, it could be File URL and base64.	String containing url	2048
STOP_FILE_UPLOAD	FourKitesLoadId	Unique load identifier from FourKites system if the load was successfully created (IsSuccess = true). The field will be null if the load creation failed in FourKites	Yes	Yes	TrackingID will be mapped to FourKitesLoadId	Number	20
STOP_FILE_UPLOAD	LoadNumber	Unique shipment identifier from shipper's system	Yes	Yes	N/A	String	65535
STOP_FILE_UPLOAD	ProNumber	Shipment's PRO #	Yes	No	N/A	Number	10
STOP_FILE_UPLOAD	ReferenceNumbers	List of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load)	Yes	No	N/A	Array of string	No max
STOP_FILE_UPLOAD	Scac	Scac of the Carrier	Yes	Yes	N/A	Alpha/Numeric	4
STOP_FILE_UPLOAD	Shipper	Unique shipper ID from FourKites	Yes	Yes	N/A	Alpha/Numeric	No max, but realistically, not longer than 200 characters
STOP_FILE_UPLOAD	SignerName	Name of the signatory who received the courier/shipment at the destination stop.	Yes	No	N/A	String	65535
STOP_FILE_UPLOAD	StopName	Name of the stop provided during load creation.	Yes	Yes	N/A	Alpha/Numeric	No max, but realistically, not longer than 200 characters
STOP_FILE_UPLOAD	StopReferenceId		Yes	No	N/A	String	65535
STOP_FILE_UPLOAD	StopReferenceNumbers	List of reference numbers associated with the particular stop	Yes	No	N/A	Array of string	No max
STOP_FILE_UPLOAD	StopSequence	Stop Sequence - 1	Yes	No	N/A	int	5
STOP_FILE_UPLOAD	StopType	Stop type - pickup, delivery	Yes	Yes	N/A	String	50
STOP_FILE_UPLOAD	Tags	List of tags associated with the load (empty list when tags are not present)	Yes	No	N/A	Array of string	50 for each tag
STOP_FILE_UPLOAD	Timestamp	Time when the file was uploaded for the stop in CarrierLink in stop's local time (in ISO 8601 format with local time offset to UTC)	Yes	No	uploadedAt time will be mapped to Timestamp. If there is no timezone, the Timestamp field will be blank.	String in DateTime format	30
STOP_FILE_UPLOAD	Timezone	Local Timezone of the stop in which Timestamp is specified.	Yes	No	N/A	String	50
STOP_FILE_UPLOAD	TimezoneOffset	Number of seconds local time zone is ahead of UTC time. Negative for western hemisphere time zones.	Yes	No	N/A	[+/-]Digits	10
STOP_FILE_UPLOAD	TimezoneShortName	Short name of Timezone of the stop in which "Timestamp" is specified.	Yes	No	If Timestamp or Timezone is nil then TimezoneShortName will be empty	String	5
STOP_FILE_UPLOAD	CreatedBY	CreatedBy field is specific to FourKites X.			The CreatedBy field will be available and sent only for FourKites X licensed customers — this is to identify between FourKites X and non FourKites X loads.	String	65535