const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.opereit.ai/v1/claims/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"number": "<string>",
"status": "CREATED",
"status_reason": {
"id": "<string>",
"slug": "MISSING_PRODUCT_INFORMATION",
"label": "Missing Product Information"
},
"date": "2023-12-25",
"carrier_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"total_amount": 123,
"shipment": {
"id": "<string>",
"tracking_number": "<string>",
"carrier_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"origin": {
"postcode": "<string>",
"country": "<string>"
},
"destination": {
"postcode": "<string>",
"country": "<string>",
"city": "<string>",
"address": "<string>",
"customerName": "<string>"
},
"line_items": [
{
"id": "<string>",
"description": "<string>",
"quantity": 123,
"unit_price": 123,
"total": 123
}
],
"service_type": "<string>"
},
"incidence": {
"id": "<string>",
"type": "DAMAGED",
"claimed_amount": 123,
"currency": "<string>",
"line_items": [
{
"id": "<string>"
}
],
"description": "<string>",
"recovered_amount": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"provider_id": "<string>"
}{
"statusCode": 401,
"statusReasonCode": "AUTHENTICATION_REQUIRED",
"error": "Authentication required"
}{
"statusCode": 404,
"statusReasonCode": "CLAIM_NOT_FOUND",
"error": "Claim not found"
}{
"statusCode": 500,
"statusReasonCode": "INTERNAL_ERROR",
"error": "Internal server error"
}Get a claim
Retrieve a single claim by ID, including its full shipment and incidence details.
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.opereit.ai/v1/claims/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"number": "<string>",
"status": "CREATED",
"status_reason": {
"id": "<string>",
"slug": "MISSING_PRODUCT_INFORMATION",
"label": "Missing Product Information"
},
"date": "2023-12-25",
"carrier_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"total_amount": 123,
"shipment": {
"id": "<string>",
"tracking_number": "<string>",
"carrier_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"origin": {
"postcode": "<string>",
"country": "<string>"
},
"destination": {
"postcode": "<string>",
"country": "<string>",
"city": "<string>",
"address": "<string>",
"customerName": "<string>"
},
"line_items": [
{
"id": "<string>",
"description": "<string>",
"quantity": 123,
"unit_price": 123,
"total": 123
}
],
"service_type": "<string>"
},
"incidence": {
"id": "<string>",
"type": "DAMAGED",
"claimed_amount": 123,
"currency": "<string>",
"line_items": [
{
"id": "<string>"
}
],
"description": "<string>",
"recovered_amount": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"provider_id": "<string>"
}{
"statusCode": 401,
"statusReasonCode": "AUTHENTICATION_REQUIRED",
"error": "Authentication required"
}{
"statusCode": 404,
"statusReasonCode": "CLAIM_NOT_FOUND",
"error": "Claim not found"
}{
"statusCode": 500,
"statusReasonCode": "INTERNAL_ERROR",
"error": "Internal server error"
}Authorizations
HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).
Path Parameters
ID of the claim.
Response
The claim.
A claim with full shipment and incidence details, as returned by the get-by-id endpoint.
Unique claim ID.
Human-readable claim reference, if assigned.
Current stage of the claim.
CREATED: claim created, not yet reviewed.UNDER_REVIEW: being reviewed by the carrier.PENDING_ACTION: action is required from Opereit's team before it can move forward.PENDING_REFUND: a refund is being processed; amount not confirmed yet.PENDING_REFUND_AMOUNT_CONFIRMED: refund amount confirmed, not paid yet.RESOLVED: the claim has been resolved.CANCELED: the claim was canceled.REJECTED: the claim was rejected by the carrier.CLOSED: the claim is closed.
A claim is considered closed (no longer open) when it's REJECTED (for any reason), or CANCELED with a status reason of CREATED_INCORRECTLY or SHIPMENT_NOT_CLAIMABLE_YET. Any other status counts as open, and an open claim is what blocks a new claim on the same tracking number (see POST /v1/claims).
CREATED, UNDER_REVIEW, PENDING_ACTION, PENDING_REFUND, PENDING_REFUND_AMOUNT_CONFIRMED, RESOLVED, CANCELED, REJECTED, CLOSED Set when status is PENDING_ACTION, CANCELED, or REJECTED. null for every other status.
Show child attributes
Show child attributes
Date the claim was filed.
Carrier identifier.
Sum of the claimed amounts on this claim, in the smallest currency unit.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Provider identifier, if one was set.