API Documentation

Build custom integrations with the ClaimPort REST API.

Getting Started

Base URL

All API requests use:

https://api.claimport.io/v1

Authentication

Use Bearer token authentication:

Authorization: Bearer YOUR_API_KEY

Get your API key from Settings > API Keys.

API Endpoints

Claims

List Claims

GET /claims

Query parameters:

• •status - Filter by status
• •from_date - Start date
• •to_date - End date
• •page - Page number
• •limit - Items per page (max 100)

Get Claim

GET /claims/:id

Create Claim

POST /claims

Request body:

{
  "order_id": "12345",
  "customer_email": "customer@example.com",
  "issue_description": "Product arrived damaged",
  "product_sku": "WIDGET-001"
}

Update Claim

PATCH /claims/:id

Add Message

POST /claims/:id/messages

Orders

Verify Order

POST /orders/verify

Get Order

GET /orders/:id

Analytics

Get Summary

GET /analytics/summary

Get Report

GET /analytics/reports/:type

Response Format

All responses are JSON:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "total": 100
  }
}

Error Handling

Error responses include:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Detailed error message"
  }
}

Rate Limits

• •100 requests per minute
• •10,000 requests per day
• •Limits reset at midnight UTC

SDKs

Official SDKs available for:

• •JavaScript/TypeScript
• •Python
• •PHP
• •Ruby