Create new shipment | LeanMile cross-border gatway API

SHIPMENT STRUCTURE

Parameter	Type	Description	Mandatory? Yes/ No	Constraints
documentType	String	Type of the shipment document	Yes	Possible values: MAWB, HAWB, CMR
externalClientId	String	External system client ID shared with the platform	No	When not set then the caller needs to be registered as client
documentNumber	String	Number of the shipment document	Yes	Format for airwaybill shipment number: XXX-XXXXXXXX
masterNumber	String	MAWB number for HAWB shipment	Yes, for house_airwaybill shipment	Format: XXX-XXXXXXXX
flightNumber	String	Flightnumber + flight date	Yes, for airwaybill and house_airwaybill shipment	Expected Format: AY1234/20NOV25
charter	Boolean	Is it charter flight?	No	Possible values: true, false, null
airport	String	Entryairport	Yes, for airwaybill and house_airwaybill shipment	Airport IATA code. Should be supported by the system. For OTP entry use “OTP”.
operatorSiteCode	String	Specifies operator site code based on agreement with operator.	Yes	Site code “OTP”
arriveDate	String	Time of Arrival	Yes	1. Format: 2025-11-27T15:00:00Z
shipmentPieces	Integer	Shipment Packages Count	Yes	1. shipmentPieces > 0
shipmentWeight	Number	Shipment total weight, in KG-s	Yes	1. shipmentWeight > 0 2. Max 3 decimals

## SHIPMENT STRUCTURE <table><tbody><tr><td><div><p><b>Parameter</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Type</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Description</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Mandatory? Yes/ No</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Constraints</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>documentType</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Type of the shipment document</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Possible values:<br>MAWB,<br>HAWB,<br>CMR</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>externalClientId</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>External system client ID shared with the platform</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>No</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>When not set then the caller needs to be registered as client</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>documentNumber</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Number of the shipment document</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Format for airwaybill shipment number:</p><p>XXX-XXXXXXXX</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>masterNumber</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>MAWB number for HAWB shipment</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes, for house_airwaybill shipment</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Format:</p><p>XXX-XXXXXXXX</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>flightNumber</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Flightnumber + flight date</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes, for airwaybill and house_airwaybill shipment</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Expected Format:</p><p>AY1234/20NOV25</p><p></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>charter</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Boolean</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Is it charter flight?</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Possible values:</p><p>true,<br>false,<br>null</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>airport</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Entryairport</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes, for airwaybill and house_airwaybill shipment</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Airport IATA code. Should be supported by the system. For OTP entry use "OTP".</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>operatorSiteCode</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>Specifies operator site code based on agreement with operator.</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>Yes</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div>Site code "OTP"</div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>arriveDate</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Time of Arrival</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>1. Format: 2025-11-27T15:00:00Z</p><p></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>shipmentPieces</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Integer</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Shipment Packages Count</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>1. shipmentPieces > 0</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>shipmentWeight</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Shipment total weight, in KG-s</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>1. shipmentWeight > 0</p><p>2. Max 3 decimals</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

This endpoint expects an object.

airportstringRequired

charterbooleanRequired

arriveDatedatetimeRequired

documentTypestringRequired

flightNumberstringRequired

documentNumberstringRequired

shipmentPiecesintegerRequired

shipmentWeightdoubleRequired

operatorSiteCodestringRequired

Response

dataobject

statusstring

messagestring

statusCodeinteger

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error