Multi-Modal: Document

Create Document

Create a document

post/services/document/v1/documents

Request

Request body multipart/form-data

documentstring
upload_filestring binary

Response

Successful Response

addedByCompanystring

The company name of the tenant owning this document.

addedByUserstring

The name of the user owning this document.

createdDateTimestring date-time

The date and time when this document was created. This value is read only.

deletedDateTimestring date-time

The date and time when this document was deleted. This value is read only.

idstring uuid

The id of this document. Will always be populated on response.

lastModifiedDateTimestring date-time

The date and time when this document was last modified. This value is read only.

mode'AIR' | 'OCEAN' | 'TL' | 'LTL' | 'PARCEL' | 'RAIL' | 'BARGE'

The mode of transportation for a document.

namestring

The name of this document.

parsedDataobject

Parsed data extracted from the document. The structure varies based on document type and content.

type'BILL_OF_LADING' | 'HOUSE_BILL_OF_LADING' | 'AIRWAY_BILL' | 'COMMERCIAL_INVOICE' | 'CUSTOMS_DOCUMENTS' | 'PACKING_SLIP' | 'CERTIFICATE_OF_ORIGIN' | 'PROOF_OF_DELIVERY' | 'DELIVERY_RECEIPT' | 'ECMR' | 'WEIGHT_CERTIFICATE' | 'INSPECTION_CERTIFICATE' | 'LETTER_OF_AUTHORIZATION' | 'LUMPER_CERTIFICATE' | 'INVOICE' | 'HAZMAT_DOCUMENT' | 'SHIPPING_LABEL' | 'OTHER'

An enumeration.

Changes

No recorded changes to this operation across all 1 revision of this API.