Warranty API

The Warranty API (v1) enables third-party integrators to create, manage, and transfer boat warranties with JWT-based authentication and brand-level permissions.

Authentication

The Warranty API uses JWT (JSON Web Token) Bearer authentication. Follow these steps to authenticate your requests.

Step 1: Get Your Tokens

POST /api/v1/auth/login 
curl -X POST https://api.marquatica.com/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "your@email.com", "password": "yourpassword"}'

Response:

{
  "success": true,
  "status": 200,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIs...",
    "refresh_token": "eyJhbGciOiJIUzI1NiIs...",
    "token_type": "bearer",
    "expires_in": 3600
  }
}

Step 2: Use the Access Token

Include the Authorization: Bearer <access_token> header on all warranty API requests.

Authorization: Bearer <Token>

Step 3: Refresh When Expired

POST /api/v1/auth/refresh

Access tokens expire in 1 hour. Use your refresh_token to obtain new tokens without re-authenticating. Refresh tokens are valid for 30 days.

Permission Model

Your API user has both endpoint permissions (which APIs you can use) and brand permissions (which brands you can manage). You'll only see warranties for brands you have access to.

HIN (Hull Identification Number)

The Hull Identification Number (HIN) is the primary identifier for warranty lookups. Key rules:

  • HIN must be exactly 12 alphanumeric characters
  • HINs are unique per brand (the same HIN can exist across different brands)
  • All lookups use HIN as the primary identifier

Endpoints

GET /api/v1/warranty List Warranties POST /api/v1/warranty Create Warranty GET /api/v1/warranty/{hin} Get Warranty by HIN PATCH /api/v1/warranty/{hin} Update Warranty POST /api/v1/warranty/{hin}/transfer Transfer Ownership GET /api/v1/warranty/{hin}/history Ownership History POST /api/v1/warranty/{hin}/retry-sync Retry GHL Sync

Warranty Status Values

Status Description
active Warranty is currently in effect and coverage is valid
expired Warranty has passed its end date and coverage has ended
voided Warranty has been manually cancelled or invalidated

Coverage Types

Type Description
full Complete coverage including all components and systems
limited Partial coverage with specific exclusions
structural Covers structural defects and integrity only
hull-only Coverage limited to hull and below-waterline components
other Custom or non-standard coverage arrangement
Previous Lead Submission
On this page