Save customs documents to shipment

Purpose and Usage

This method is used to upload customs documents to an existing shipment in the PPL system. It is used for international shipments where customs documentation (invoices, proforma invoices, customs declarations, etc.) needs to be attached to the shipment for customs clearance.

Parameters

Path parameters:

shipmentNumber (string, required) — the shipment number to which the documents are being uploaded. The shipment must already exist in the PPL system (i.e., it must have been previously created via POST /shipment/batch.

Query parameters:

documentFileType (required) — the type of document being uploaded. Values must correspond to the "Document Types" codelist (codelist/documentType), which is available in the Codelist section of the documentation. Only one document type can be uploaded per request. If multiple document types belong to a shipment, they must be uploaded separately by making additional requests.

Body

files — the actual file (or files) containing the customs document. Uploaded as multipart/form-data, i.e., standard file upload.

File restrictions:

Supported formats: pdf, doc, docx, xls, xlsx, jpg, jpeg, png, odt, ods, txt

Maximum total file size per request: 1 MB

Maximum number of files per request: 5

Typical Workflow

Create a shipment via POST /shipment/batch → use GET /shipment/batch/{batchId} to wait for the Complete status and obtain the shipmentNumber

Retrieve and select permitted document types from GET /codelist/documentFileType

Upload customs documents via this endpoint

If needed, verify the shipment status via GET /shipment/{shipmentNumber}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Save customs documents to shipment

Purpose and Usage#

Parameters#

Body#

Typical Workflow#

Request

Request Code Samples

Responses

Purpose and Usage

Parameters

Body

Typical Workflow