POST - Document

The Document Service comprises a JSON Object that allows users to upload a shipment document to any given shipment.

The following guides below help you create (POST) and retrieve (GET) shipment documents from any given shipment.

The POST document/upload Endpoint allows the uploading of a document to a specific shipment in the 10-4 Freight Portal.

The POST document/upload Endpoint has multiple parameter values that can be included in the object. As a base level requirement, the following parameters are required in order to successfully create a document for uploading:

1. FreightProviderReferenceNumber and FreightHaulerProviderXID or TenFourLicensePlate
2. FileName
3. FileContent
4. DocumentType

The POST HTTP Endpoint for shipment tracking is listed below:

HTTP Verb: POST
URI: /atlas/frexapi/shipment/document/upload/
Authentication: Validation Through Request Parameters

Success Response:

{
  "DocumentId": 1937971,
  "OrganizationId": 15,
  "DocumentTypeId": 2,
  "DocumentTypeName": null,
  "DocumentRetrievalToken": "15/577c962b-5c0a-43b1-9999-2b93f6241e5a.jpg",
  "DocumentDescription": "TestFile.jpg",
  "UploadDate": "0001-01-01T00:00:00+00:00",
  "UploadDateISO": "0001-01-01T12:00:00+00:00",
  "UploadUserId": 119,
  "UploadUserName": null,
  "UploadLatitude": null,
  "UploadLongitude": null,
  "FileDate": null,
  "FileLatitude": null,
  "FileLongitude": null,
  "CanDeleteDocument": false,
  "HasBeenDownloadedFlag": false,
  "HasBeenViewedFlag": false,
  "DocumentTypes": null,
  "IsFromMarketPlace": false
}