const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.opereit.ai/v1/claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "<string>",
"claimNumber": "<string>",
"claimDate": "2023-12-25",
"status": "CREATED",
"statusReason": {
"id": "<string>",
"slug": "MISSING_PRODUCT_INFORMATION",
"label": "Missing Product Information"
},
"openedWith": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"carrierId": "<string>",
"totalAmount": 123,
"aging": 123,
"carrier": {
"id": "<string>",
"name": "<string>"
},
"providerId": "<string>",
"currency": "<string>",
"provider": {
"id": "<string>",
"name": "<string>"
},
"shipment": {
"id": "<string>",
"trackingNumber": "<string>",
"destinationCustomerName": "<string>",
"destinationCountry": "<string>"
}
}
],
"pagination": {
"cursor": "<string>",
"hasMore": true
}
}{
"statusCode": 400,
"statusReasonCode": "INVALID_QUERY_PARAMETERS",
"error": "Invalid query parameters",
"details": {
"formErrors": [],
"fieldErrors": {
"status": [
"Invalid option: expected one of \"CREATED\"|\"UNDER_REVIEW\"|\"PENDING_ACTION\"|\"PENDING_REFUND\"|\"PENDING_REFUND_AMOUNT_CONFIRMED\"|\"RESOLVED\"|\"CANCELED\"|\"REJECTED\"|\"CLOSED\""
]
}
}
}{
"statusCode": 401,
"statusReasonCode": "AUTHENTICATION_REQUIRED",
"error": "Authentication required"
}{
"statusCode": 500,
"statusReasonCode": "INTERNAL_ERROR",
"error": "Internal server error"
}List claims
Returns a cursor-paginated list of claims for your organization, ordered by internal ID ascending (oldest first).
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.opereit.ai/v1/claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "<string>",
"claimNumber": "<string>",
"claimDate": "2023-12-25",
"status": "CREATED",
"statusReason": {
"id": "<string>",
"slug": "MISSING_PRODUCT_INFORMATION",
"label": "Missing Product Information"
},
"openedWith": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"carrierId": "<string>",
"totalAmount": 123,
"aging": 123,
"carrier": {
"id": "<string>",
"name": "<string>"
},
"providerId": "<string>",
"currency": "<string>",
"provider": {
"id": "<string>",
"name": "<string>"
},
"shipment": {
"id": "<string>",
"trackingNumber": "<string>",
"destinationCustomerName": "<string>",
"destinationCountry": "<string>"
}
}
],
"pagination": {
"cursor": "<string>",
"hasMore": true
}
}{
"statusCode": 400,
"statusReasonCode": "INVALID_QUERY_PARAMETERS",
"error": "Invalid query parameters",
"details": {
"formErrors": [],
"fieldErrors": {
"status": [
"Invalid option: expected one of \"CREATED\"|\"UNDER_REVIEW\"|\"PENDING_ACTION\"|\"PENDING_REFUND\"|\"PENDING_REFUND_AMOUNT_CONFIRMED\"|\"RESOLVED\"|\"CANCELED\"|\"REJECTED\"|\"CLOSED\""
]
}
}
}{
"statusCode": 401,
"statusReasonCode": "AUTHENTICATION_REQUIRED",
"error": "Authentication required"
}{
"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).
Query Parameters
Number of items to return per request.
1 <= x <= 100Opaque cursor from a previous response. Omit on the first request.
Filter by claim status. 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 Filter by carrier ID (e.g. ups, fedex).
Filter by the shipment's carrier tracking number.
Return claims with a claim date on or after this date. Format YYYY-MM-DD.
Return claims with a claim date on or before this date. Format YYYY-MM-DD.