Claim Status

If you have a loss or damage claim then you can use the R+L Carriers Cargo Claim Status API. To retrieve the status of your claim, just send the PRO or Claim number in the request.
Add Claim
HTTP Method: POST
URL: /ClaimStatus/AddClaim
Request Parameters
Name Type Cardinality Required Description
ProNumber string One Required Only submit the 9-digit Pro Number.
ClaimantParty string One Required Only the values Shipper, Consignee, Billing To and Other are allowed.
Claimant object One Optional
Properties
Name string One
AddressLine1 string One
AddressLine2 string One
City string One
State string One
ZipCode string One
Phone string One
EmailAddress string One
TypeOfClaim string One Required Only the values Shortage, Theft and Pilferage, Concealed Damage, Visible Damage, Wreck and Catastrophe and Freezable are accepted.
Properties
Property string One
ErrorMessage string One
ExceptionMessage string One
ClaimComments string One Optional
Items array One or More Required
Properties
ItemDescription string One
ClaimAmount decimal One
Condition string One Only the values blank, New and Used are valid.
Weight decimal One
RequiredDocument object One Required
Properties
Base64Data string One
FileFormat string One Only extensions JPG, PDF, PNG, and TIF are allowed.
OtherDocuments array Zero or More Optional
Properties
Base64Data string One
FileFormat string One Only extensions JPG, PDF, PNG, and TIF are allowed.
Response Parameters
Name Type Cardinality Description
StatusText string One
StatusDetail string One
Code integer One
Errors array Zero or More
Properties
Property string One
ErrorMessage string One
ExceptionMessage string One
Messages string Zero or More
Get Claim Status
HTTP Method: GET
URL: /ClaimStatus
Request Parameters
Name Type Cardinality Required Description
ClaimOrProNumber string One Required The Claim or the Pro number
Response Parameters
Name Type Cardinality Description
ClaimNumber string One Claim Number
ClaimStatus string One Claim Status
Code integer One
Errors array One
Properties
Error object Zero or More
Properties
Property string One
ErrorMessage string One
ExceptionMessage string One
Messages array One
Properties
Messsage string Zero or More
Example Request
  2. require_once 'HTTP/Request2.php';
  3.  
  4. $request = new HTTP_Request2();
  5.  
  6. $request->setUrl('{baseurl}/ClaimStatus?ClaimOrProNumber=119');
  7.  
  8. $request->setMethod(HTTP_Request2::METHOD_GET);
  9.  
  10. $request->setConfig(array(
  11.  
  12.   'follow_redirects' => TRUE
  13.  
  14. ));
  15.  
  16. $request->setHeader(array(
  17.  
  18.   'apiKey' => 'Your API Key'
  19.  
  20. ));
  21.  
  22. try {
  23.  
  24.   $response = $request->send();
  25.  
  26.   if ($response->getStatus() == 200) {
  27.  
  28.     echo $response->getBody();
  29.  
  30.   }
  31.  
  32.   else {
  33.  
  34.     echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
  35.  
  36.     $response->getReasonPhrase();
  37.  
  38.   }
  39.  
  40. }
  41.  
  42. catch(HTTP_Request2_Exception $e) {
  43.  
  44.   echo 'Error: ' . $e->getMessage();
  45.  
  46. }
  1. using CallAPI.DataContracts.ClaimStatus.Response;
  2.  
  3. using System.Net.Http;
  4.  
  5. using System.Net.Http.Headers;
  6.  
  7.  
  8.  
  9. namespace CallAPI
  10.  
  11. {
  12.  
  13.     class ClaimStatusSample
  14.  
  15.     {
  16.  
  17.         string apiKey = "Your API Key";
  18.  
  19.  
  20.  
  21.         //GET
  22.  
  23.         public GetClaimStatusResponse GetClaimStatus()
  24.  
  25.         {
  26.  
  27.             var response = new GetClaimStatusResponse();
  28.  
  29.  
  30.  
  31.             var claimOrProNumber = "119";
  32.  
  33.  
  34.  
  35.             var url = string.Format("{baseurl}/ClaimStatus?ClaimOrProNumber=={0}", claimOrProNumber);
  36.  
  37.  
  38.  
  39.             using (HttpClient client = new HttpClient())
  40.  
  41.             {
  42.  
  43.                 client.DefaultRequestHeaders.Add("apiKey", apiKey);
  44.  
  45.                 client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
  46.  
  47.  
  48.  
  49.                 var apiResponse = client.GetAsync(url).Result;
  50.  
  51.                 response = apiResponse.Content.ReadAsAsync().Result;
  53.             }
  57.             return response;
  59.         }
  61.     }
  63. }
  1. package Samples;
  2.  
  3.  
  4.  
  5. import java.io.BufferedReader;
  6.  
  7. import java.io.InputStreamReader;
  8.  
  9.  
  10.  
  11. import org.apache.http.HttpResponse;
  12.  
  13. import org.apache.http.client.HttpClient;
  14.  
  15. import org.apache.http.client.methods.HttpGet;
  16.  
  17. import org.apache.http.impl.client.HttpClientBuilder;
  18.  
  19.  
  20.  
  21. import com.fasterxml.jackson.databind.ObjectMapper;
  22.  
  23.  
  24.  
  25. import DataContracts.ClaimStatus.Response.GetClaimStatusResponse;
  26.  
  27.  
  28.  
  29. public class ClaimStatusSample {
  30.  
  31. 	String apiKey = "Your API Key";
  32.  
  33. 	ObjectMapper mapper = new ObjectMapper();
  34.  
  35. 	
  36.  
  37. 	public GetClaimStatusResponse GetClaimStatus() throws Exception {
  38.  
  39. 		GetClaimStatusResponse response = new GetClaimStatusResponse();
  40.  
  41. 		
  42.  
  43. 		String url = "{baseurl}/ClaimStatus";
  44.  
  45.  
  46.  
  47.         String claimOrProNumber ="119";
  48.  
  49.  
  50.  
  51.         url += "?ClaimOrProNumber=" + claimOrProNumber;
  52.  
  53.  
  54.  
  55. 		HttpClient httpClient = HttpClientBuilder.create().build(); 
  56.  
  57. 		HttpGet httprequest = new HttpGet(url);
  58.  
  59. 		httprequest.setHeader("apiKey", apiKey);
  60.  
  61. 		
  62.  
  63. 		HttpResponse httpResponse = httpClient.execute(httprequest);
  64.  
  65.  
  66.  
  67. 		BufferedReader in = new BufferedReader(new InputStreamReader(httpResponse.getEntity().getContent()));
  68.  
  69. 		
  70.  
  71. 		String inputLine;
  72.  
  73. 		StringBuffer result = new StringBuffer();
  74.  
  75.  
  76.  
  77. 		while ((inputLine = in.readLine()) != null) {
  78.  
  79. 			result.append(inputLine);
  80.  
  81. 		}
  82.  
  83. 		in.close();
  84.  
  85.  
  86.  
  87. 		response = mapper.readValue(result.toString(), GetClaimStatusResponse.class);
  88.  
  89. 		
  90.  
  91. 		return response;
  92.  
  93.     }
  94.  
  95. }