PreClearance Request API

The following details the method of declaring shipments travelling together as part of a PreClearance to Mercury via an API request.

Overview

Connection

To connect to the site use the following HTTPS URL via regular POST method with the parameter RQXML=<your xml document> https://api.landmarkglobal.com/v2/PreClearance.php

Encoding

Test Mode

Troubleshooting

If you receive a <Response> error with the message "Required element login not found", then please ensure you are properly including the login nodes and credentials. Additionally, the API will return this error when it could not parse the XML. 

PreClearanceRequest

This request will assign a MAWB number and International Airport Code to a set of shipments travelling together on the given MAWB. This is required for shipments utilizing Landmark's PreClearance services. 

----------

<PreClearanceRequest>

     <Login>

          <Username>demoapi</Username>

          <Password>demo123</Password>

     </Login>

     <Test>true</Test>   <!-- Optional. Defaults to true before account activation, false afterwards -->

     <ClientID>218</ClientID>  <!-- Required if more than one client under user, otherwise Optional -->

     <MAWB>1234</MAWB>

     <OriginAirport>SHG</OriginAirport>  <!-- Use 3-digit airport codes -->

     <TransportType>AIR</TransportType> <!-- Can be AIR, GROUND or NCTS -->

     <Shipments>

         <Shipment>

              <Reference>123123123</Reference>   <!-- Should be the same Reference field passed in the ImportRequest -->

         </Shipment>

         <Shipment>

              <Reference>454545454</Reference>

         </Shipment>

         <Shipment> <!-- LTN value as received from Import API response -->

              <LTN>LTN12345678</LTN>

         </Shipment>

    </Shipments>

</PreClearanceRequest>

PreClearanceResponse

<PreClearanceResponse>

     <Result>

         <Success>true</Success>

     </Result>

     <PreClearanceId>36</PreClearanceId>

</PreClearanceResponse>

PreClearanceResponse with <PreClearanceNotNeeded> element

In some corner cases, some shipments included in a preclearance request might not actually require preclearance (for example, some shipments are routed to a DDU service code). When this happens, a new element <PreClearanceNotNeeded> will be added to the response. This element will have a list of <Reference> elements each containing a reference of a shipment that does not need pre-clearance. In the example below, shipment 123123123 did not need preclearance. Note that the PreClearanceResponse will still return a PreClearance ID for shipments that need them, and the <Result> element will contain <Success>true</Success>, indicating that this is not a failure.

<?xml version="1.0"?>

<PreClearanceResponse>

     <PreClearanceNotNeeded>

          <Reference>123123123</Reference> <!-- This shipment did not require preclearance -->

     </PreClearanceNotNeeded>

     <Result>

          <Success>true</Success>

     </Result>

     <PreClearanceId>462</PreClearanceId> <!-- This contains shipments 454545454 and LTN12345678 -->

</PreClearanceResponse>

Possible Errors

This table lists all errors that may be returned by the PreClearance Request API endpoint. [Brackets] in the ErrorMessage are used to represent to the value passed for the related element. An example is provided when an ErrorMessage is variable.