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
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
|
||||||||||||||||||||||||||||||||||||||||||||
TypeOfClaim | string | One | Required | Only the values Shortage, Theft and Pilferage, Concealed Damage, Visible Damage, Wreck and Catastrophe and Freezable are accepted. | ||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
ClaimComments | string | One | Optional | |||||||||||||||||||||||||||||||||||||||||
Items | array | One or More | Required | |||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
RequiredDocument | object | One | Required | |||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
OtherDocuments | array | Zero or More | Optional | |||||||||||||||||||||||||||||||||||||||||
Properties
|
Response Parameters
Name | Type | Cardinality | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
StatusText | string | One | |||||||||||||
StatusDetail | string | One | |||||||||||||
Code | integer | One | |||||||||||||
Errors | array | Zero or More | |||||||||||||
Properties
|
|||||||||||||||
Messages | string | Zero or More |
Get Claim Status
HTTP Method: GET
URL: /ClaimStatus
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
|
|||||||||||||||||||||||
Messages | array | One | |||||||||||||||||||||
Properties
|
Example Request
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{baseurl}/ClaimStatus?ClaimOrProNumber=119');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'apiKey' => 'Your API Key'
));
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
using CallAPI.DataContracts.ClaimStatus.Response;
using System.Net.Http;
using System.Net.Http.Headers;
namespace CallAPI
{
class ClaimStatusSample
{
string apiKey = "Your API Key";
//GET
public GetClaimStatusResponse GetClaimStatus()
{
var response = new GetClaimStatusResponse();
var claimOrProNumber = "119";
var url = string.Format("{baseurl}/ClaimStatus?ClaimOrProNumber=={0}", claimOrProNumber);
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Add("apiKey", apiKey);
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
var apiResponse = client.GetAsync(url).Result;
response = apiResponse.Content.ReadAsAsync().Result;
}
return response;
}
}
}
package Samples;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.HttpClientBuilder;
import com.fasterxml.jackson.databind.ObjectMapper;
import DataContracts.ClaimStatus.Response.GetClaimStatusResponse;
public class ClaimStatusSample {
String apiKey = "Your API Key";
ObjectMapper mapper = new ObjectMapper();
public GetClaimStatusResponse GetClaimStatus() throws Exception {
GetClaimStatusResponse response = new GetClaimStatusResponse();
String url = "{baseurl}/ClaimStatus";
String claimOrProNumber ="119";
url += "?ClaimOrProNumber=" + claimOrProNumber;
HttpClient httpClient = HttpClientBuilder.create().build();
HttpGet httprequest = new HttpGet(url);
httprequest.setHeader("apiKey", apiKey);
HttpResponse httpResponse = httpClient.execute(httprequest);
BufferedReader in = new BufferedReader(new InputStreamReader(httpResponse.getEntity().getContent()));
String inputLine;
StringBuffer result = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
result.append(inputLine);
}
in.close();
response = mapper.readValue(result.toString(), GetClaimStatusResponse.class);
return response;
}
}