Documents

Upload multi-document file

Upload a file containing multiple documents. For PDFs with multiple document types, this will create separate document records for each type. The original file is stored once, with virtual splits created for each document type.

post/api/v1/external/shipments/{shipmentId}/documents/upload-multi

Request

Path parameters

shipmentIdstring required

Unique shipment identifier

Request body multipart/form-data

filestring binary required

The document file to upload

typesstring required

JSON string containing array of document types with page ranges

Example request

{
  "types": "[{\"documentType\":\"BillOfLading\",\"startPage\":1,\"endPage\":2},{\"documentType\":\"CommercialInvoice\",\"startPage\":3,\"endPage\":4}]"
}

Response

Documents uploaded successfully

successboolean

Changes

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