Get a claim by external ID | Jewelers Mutual Developer Docs

{
  "_links": {
    "empty": false
  },
  "claimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "claimInformation": {
    "claimDate": "2024-05-10T14:30:00Z",
    "claimPaidDate": "2024-05-20T10:00:00Z",
    "jewelryDescription": "18k Gold Diamond Engagement Ring",
    "jobEnvelopeNumber": "JE-20240510-789",
    "productFailureDate": "2024-04-25T00:00:00Z",
    "repairOrReplace": "Repair",
    "repairedBy": "Downtown Jewelers",
    "replacementReason": "N/A",
    "storeCode": "STORE12345",
    "submittedBy": "Jane Smith"
  },
  "customerInformation": {
    "address": {
      "address": "123 Maple Street",
      "city": "Springfield",
      "state": "IL",
      "zipCode": "62704"
    },
    "email": "jane.smith@example.com",
    "firstName": "Jane",
    "lastName": "Smith",
    "phoneNumber": "(217) 555-1234"
  },
  "externalClaimId": "EXT-CLAIM-20240615-001",
  "jewelerShippingInformation": {
    "address": "456 Jewelry Ave",
    "city": "Springfield",
    "name": "Downtown Jewelers",
    "state": "IL",
    "zipCode": "62701"
  },
  "repairCenterInfo": {
    "address": "789 Repair Rd",
    "city": "Springfield",
    "name": "Springfield Repair Center",
    "state": "IL",
    "zipCode": "62703"
  },
  "requestedRepairDetails": [
    {
      "cost": 250,
      "quantity": 1,
      "repairCode": "Ring Re-sizing upto",
      "repairType": "Ring Re-sizing"
    },
    {
      "cost": 150,
      "quantity": 1,
      "repairCode": "Diamond Replacement",
      "repairType": "Stone Replacement"
    }
  ],
  "shippingInformation": {
    "toCustomer": {
      "cost": 15,
      "trackingNumber": "1Z999AA10123456784"
    },
    "toStore": {
      "cost": 10,
      "trackingNumber": "1Z999AA10123456785"
    }
  },
  "state": "IL",
  "status": "Approved",
  "totalCost": 425
}

Retrieves a claim using the external claim ID provided at the time of submission. Useful for looking up claims by your own system's identifier.

Query parameters

externalClaimIdstringRequired

externalClaimId

Response

_linksobjectOptional

HAL hypermedia links map. The empty flag indicates whether any links are present on the resource.

claimIdstringOptionalformat: "uuid"

claimInformationobjectOptional

Claim information

customerInformationobjectOptional

Customer details

externalClaimIdstringOptional

jewelerShippingInformationobjectOptional

Information about location/store

repairCenterInfoobjectOptional

Information about location/store

requestedRepairDetailslist of objectsOptional

shippingInformationobjectOptional

Shipping information on claim details page

statestringOptional

statusstringOptional

totalCostdoubleOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error