Sign in

v1

latestOpenAPI 3.0.12026-08-0422112314.6 KB
Document APIs

Submit a document to be associated with a load

Allows Carriers and Shippers to submit one or more documents that will be saved to a given load they are associated to. Only files up to 20 MB and with specific extensions are allowed. Zips are currently not supported.

post/api/v1/Documents

Request body

loadIdinteger required

The requested load ID.

documentstring byte required

Document byte array

documentType'Undefined' | 'VendorInvoice' | 'BillOfLading' | 'ProofOfDelivery' | 'LumperTicket' | 'ScaleTicket' | 'InGateTicket' | 'OutGateTicket' | 'Miscellaneous' | 'AccessorialAgreement' | 'RateConfirmation' | 'LoadTender' | 'Invoice' | 'CustomsDocuments' | 'InvoiceWithPaperwork' | 'DetentionLoading' | 'DetentionUnloading' | 'PalletReceipt' | 'SpotApproval' | 'EquipmentOrderedNotUsed' | 'CMR' | 'DemurrageLoading' | 'DemurrageUnloading' | 'ExitPass' | 'BalanceDue' | 'BalanceDueWithPaperwork' | 'PackingList' required

Document Type

extensionType'Undefined' | 'Pdf' | 'Txt' | 'Tif' | 'Tiff' | 'Bmp' | 'Dib' | 'Gif' | 'Jpeg' | 'Jpg' | 'Jpe' | 'Jfif' | 'Png' | 'Doc' | 'Docx' | 'Rtf' | 'Mht' | 'Htm' | 'Html' | 'Xml' | 'Zip' required

Document Extension Type

Response

The request was accepted and queued up for saving

boolean required