CancelOrder API Request

The following details how to cancel a fulfillment order with 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/CancelOrder.php

Encoding

Test Mode

When first given access to the API, the client will be placed in Test mode. Requests made while in test mode will not act on live data. After approval has been received to go live from Landmark, all requests are active unless the <Test> flag is passed.  During a test API call orders will not be cancelled but errors will be reported when appropriate.

CancelOrderRequest

This request will cancel a fulfillment order so long as the corresponding shipment has not yet been allocated or processed. The canceled order will be deleted and will no longer remain in the fulfillment queue. Standard (non-fulfillment) shipments may be held before processing. Standard shipments will not be cancelled by this API.

This would typically be used to cancel order before the label has been processed.

<CancelOrderRequest>

     <Login>

          <Username>demoapi</Username>

          <Password>demo123</Password>

     </Login>

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

     <ClientID>218</ClientID> <!-- Required -->

     <!-- Only one of these three is required: Reference or PackageReference or TrackingNumber -->

     <Reference></Reference>

     <PackageReference></PackageReference>

     <TrackingNumber></TrackingNumber>

     <Reason></Reason> <!-- Optional -->

</CancelOrderRequest> 

CancelOrderResponse

<CancelOrderResponse>

     <Errors> <!-- Only if Error(s) occur is this element included -->

          <Error>

               <ErrorCode>Duplicate</ErrorCode>

               <ErrorMessage>More than one shipment found with that reference (use TrackingNumber</ErrorMessage>

         </Error>

     </Errors>

     <Result>

          <Success>true</Success>

          <ResultMessage>Successfully unprocessed shipment with reference 3245325</ResultMessage>

     </Result>

</CancelOrderResponse>

Possible Errors

This table lists all errors that may be returned by the CancelOrder 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.