Order Status

Check the status of an order.

Request Parameters

Each request to the web sevice requires a number of parameters, all of which are listed below. All requests require a key which will be sent to you by your account manager.

Name Type Default Description
ApiKey* String The key used to authenticate with the service.
OrderNo* String The number used to select the order.
Back to Top

Responses

The response from the web service is a table with the specification below. If an error occurs, the response will not follow this format. Instead the response will be passed back in a single JSON string object with the parameter name: Error

Name Type Default Description
<?xml version="1.0"?><ROOT><STATUS>Despatched</STATUS></ROOT> String This is one of the possible return values for the status.
Back to Top

Errors

Below are the errors which are specific to this web service. If an error occurs the JSON returned will have with a single property called "Error". All error responses will be contained within this property.

Error Message Cause Fix
<?xml version="1.0"?><ROOT><ERROR>Invalid Key format!</ERROR></ROOT> The ApiKey parameter is formatted incorrectly. Check your ApiKey is correctly formatted.
<?xml version="1.0"?><ROOT><ERROR>Error Calling Subroutine - Empty OrderNo</ERROR></ROOT> The OrderNo parameter is missing. Pass the OrderNo in the second parameter of the method.
<?xml version="1.0"?><ROOT><ERROR>Invalid Order No</ERROR></ROOT> The OrderNo parameter you entered doesn't exist. Report the issue to us so we can investigate.
<?xml version="1.0"?><ROOT><ERROR>Key not authorised!</ERROR></ROOT> The ApiKey setup has not been completed by MRM. Report the issue to us so we can advise on setup progress.
Back to Top

Available endpoints

Example requests

thisService.GetOrderStatus("AA11-AA11-AA11-AA11", "00001234");

Example response

<?xml version="1.0"?><ROOT><STATUS>Despatched</STATUS></ROOT>
Back to Top

Sample Code

public void GetOrderStatus()
{
        SecureOrderStatus.OrderStatus thisService = new SecureOrderStatus.OrderStatus();
        String result = thisService.GetOrderStatus(txtApiKey.Text, txtOrderNo.Text);
	txtOrderStatusResult.Text = result;
}
Back to Top